Compartir a través de

az healthcareapis service

  • Referencia

Nota:

Esta referencia forma parte de la extensión healthcareapis para la CLI de Azure (versión 2.66.0 o posterior). La extensión se instalará automáticamente la primera vez que ejecute un comando az healthcareapis service . Obtenga más información sobre las extensiones.

Servicio healthcareapis.

Comandos

Nombre Description Tipo Estado
az healthcareapis service create

Cree los metadatos de una instancia de servicio.

 Extensión GA
az healthcareapis service delete

Elimine una instancia de servicio.

 Extensión GA
az healthcareapis service list

Obtenga todas las instancias de servicio de un grupo de recursos. Y obtenga todas las instancias de servicio de una suscripción.

 Extensión GA
az healthcareapis service show

Obtenga los metadatos de una instancia de servicio.

 Extensión GA
az healthcareapis service update

Actualice los metadatos de una instancia de servicio.

 Extensión GA
az healthcareapis service wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición del servicio healthcareapis.

 Extensión GA

az healthcareapis service create

Cree los metadatos de una instancia de servicio.

az healthcareapis service create --kind {fhir, fhir-R4, fhir-Stu3}
                                 --location
                                 --resource-group
                                 --resource-name
                                 [--access-policies]
                                 [--authentication-configuration]
                                 [--cors-configuration]
                                 [--cosmos-db-configuration]
                                 [--etag]
                                 [--export-configuration-storage-account-name]
                                 [--identity-type {None, SystemAssigned}]
                                 [--login-servers]
                                 [--no-wait]
                                 [--oci-artifacts]
                                 [--private-endpoint-connections]
                                 [--public-network-access {Disabled, Enabled}]
                                 [--tags]

Ejemplos

Creación o actualización de un servicio con todos los parámetros

az healthcareapis service create --resource-group "rg1" --resource-name "service1" --identity-type "SystemAssigned" --kind "fhir-R4" --location "westus2" --access-policies object-id="c487e7d1-3210-41a3-8ccc-e9372b78da47" --access-policies object-id="5b307da8-43d4-492b-8b66-b0294ade872f" --authentication-configuration audience="https://azurehealthcareapis.com" authority="https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc" smart-proxy-enabled=true --cors-configuration allow-credentials=false headers="*" max-age=1440 methods="DELETE" methods="GET" methods="OPTIONS" methods="PATCH" methods="POST" methods="PUT" origins="*" --cosmos-db-configuration key-vault-key-uri="https://my-vault.vault.azure.net/keys/my-key" offer-throughput=1000 --export-configuration-storage-account-name "existingStorageAccount" --public-network-access "Disabled"

Creación o actualización de un servicio con parámetros mínimos

az healthcareapis service create --resource-group "rg1" --resource-name "service2" --kind "fhir-R4" --location "westus2" --access-policies object-id="c487e7d1-3210-41a3-8ccc-e9372b78da47"

Parámetros requeridos

--kind

El tipo de servicio.

Valores aceptados: fhir, fhir-R4, fhir-Stu3
--location -l

Ubicación. Los valores de: az account list-locations. Puede configurar la ubicación predeterminada mediante az configure --defaults location=<location>.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--resource-name

Nombre de la instancia de servicio.

Parámetros opcionales

--access-policies

Las directivas de acceso de la instancia de servicio.

Uso: --access-policies object-id=XX

object-id: obligatorio. Identificador de objeto de Azure AD (usuario o aplicaciones) que permite el acceso al servicio FHIR.

Se pueden especificar varias acciones mediante más de un argumento --access-policies.

--authentication-configuration -c

Configuración de autenticación de la instancia de servicio.

Uso: --authentication-configuration authority=XX audience=XX smart-proxy-enabled=XX

authority: la dirección URL de autoridad para la audiencia del servicio: la dirección URL de audiencia del servicio smart-proxy habilitado: si el proxy SMART on FHIR está habilitado.

--cors-configuration

La configuración de CORS de la instancia de servicio.

Uso: --cors-configuration origins=XX headers=XX methods=XX max-age=XX allow-credentials=XX

orígenes: los orígenes que se van a permitir a través de CORS. encabezados: los encabezados que se van a permitir a través de CORS. métodos: métodos que se van a permitir a través de CORS. max-age: la edad máxima que se va a permitir a través de CORS. allow-credentials: si se permiten credenciales a través de CORS.

--cosmos-db-configuration

La configuración de la base de datos de Cosmos DB que respalda el servicio.

Uso: --cosmos-db-configuration offer-throughput=XX key-vault-key-uri=XX

offer-throughput: rendimiento aprovisionado para la base de datos de respaldo. key-vault-key-uri: el URI de la clave administrada por el cliente para la base de datos de respaldo.

--etag

ETAG asociado al recurso, que se usa para la simultaneidad optimista al editarlo.

--export-configuration-storage-account-name -s

Nombre de la cuenta de almacenamiento de exportación predeterminada.

--identity-type

Tipo de identidad que se especifica, actualmente Se permiten SystemAssigned y None.

Valores aceptados: None, SystemAssigned
--login-servers

Lista de servidores de inicio de sesión que se agregarán a la instancia de servicio.

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

Valor predeterminado: False
--oci-artifacts

Lista de artefactos de Open Container Initiative (OCI).

Uso: --oci-artifacts login-server=XX image-name=XX digest=XX

login-server: el servidor de inicio de sesión de Azure Container Registry. image-name: el nombre del artefacto. digest: resumen del artefacto.

Se pueden especificar varias acciones mediante más de un argumento --oci-artifacts.

--private-endpoint-connections

Lista de conexiones de punto de conexión privado que están configuradas para este recurso.

Uso: --private-endpoint-connections status=XX description=XX actions-required=XX

status: indica si el propietario del servicio ha aprobado o rechazado o eliminado la conexión. description: motivo de aprobación o rechazo de la conexión. actions-required: un mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.

Se pueden especificar varias acciones mediante más de un argumento --private-endpoint-connections.

--public-network-access

Permiso de control para el tráfico del plano de datos procedente de redes públicas mientras el punto de conexión privado está habilitado.

Valores aceptados: Disabled, Enabled
--tags

Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az healthcareapis service delete

Elimine una instancia de servicio.

az healthcareapis service delete [--ids]
                                 [--no-wait]
                                 [--resource-group]
                                 [--resource-name]
                                 [--subscription]
                                 [--yes]

Ejemplos

Eliminar servicio

az healthcareapis service delete --resource-group "rg1" --resource-name "service1"

Parámetros opcionales

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

Valor predeterminado: False
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--resource-name

Nombre de la instancia de servicio.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--yes -y

No solicita confirmación.

Valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az healthcareapis service list

Obtenga todas las instancias de servicio de un grupo de recursos. Y obtenga todas las instancias de servicio de una suscripción.

az healthcareapis service list [--resource-group]

Ejemplos

Enumeración de todos los servicios del grupo de recursos

az healthcareapis service list --resource-group "rgname"

Enumerar todos los servicios de la suscripción

az healthcareapis service list

Parámetros opcionales

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az healthcareapis service show

Obtenga los metadatos de una instancia de servicio.

az healthcareapis service show [--ids]
                               [--resource-group]
                               [--resource-name]
                               [--subscription]

Ejemplos

Obtener metadatos

az healthcareapis service show --resource-group "rg1" --resource-name "service1"

Parámetros opcionales

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--resource-name

Nombre de la instancia de servicio.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az healthcareapis service update

Actualice los metadatos de una instancia de servicio.

az healthcareapis service update [--ids]
                                 [--no-wait]
                                 [--public-network-access {Disabled, Enabled}]
                                 [--resource-group]
                                 [--resource-name]
                                 [--subscription]
                                 [--tags]

Ejemplos

Servicio de revisión

az healthcareapis service update --resource-group "rg1" --resource-name "service1" --tags tag1="value1" tag2="value2"

Parámetros opcionales

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

Valor predeterminado: False
--public-network-access

Permiso de control para el tráfico del plano de datos procedente de redes públicas mientras el punto de conexión privado está habilitado.

Valores aceptados: Disabled, Enabled
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--resource-name

Nombre de la instancia de servicio.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--tags

Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az healthcareapis service wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición del servicio healthcareapis.

az healthcareapis service wait [--created]
                               [--custom]
                               [--deleted]
                               [--exists]
                               [--ids]
                               [--interval]
                               [--resource-group]
                               [--resource-name]
                               [--subscription]
                               [--timeout]
                               [--updated]

Ejemplos

Pause la ejecución de la siguiente línea de script de la CLI hasta que el servicio healthcareapis se cree correctamente.

az healthcareapis service wait --resource-group "rg1" --resource-name "service1" --created

Pause la ejecución de la siguiente línea de script de la CLI hasta que el servicio healthcareapis se actualice correctamente.

az healthcareapis service wait --resource-group "rg1" --resource-name "service1" --updated

Pause la ejecución de la siguiente línea de script de la CLI hasta que el servicio healthcareapis se elimine correctamente.

az healthcareapis service wait --resource-group "rg1" --resource-name "service1" --deleted

Parámetros opcionales

--created

Espere hasta que se cree con "provisioningState" en "Succeeded".

Valor predeterminado: False
--custom

Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Espere hasta que se elimine.

Valor predeterminado: False
--exists

Espere hasta que exista el recurso.

Valor predeterminado: False
--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--interval

Intervalo de sondeo en segundos.

Valor predeterminado: 30
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--resource-name

Nombre de la instancia de servicio.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--timeout

Espera máxima en segundos.

Valor predeterminado: 3600
--updated

Espere hasta que se actualice con provisioningState en "Succeeded".

Valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.