az healthcareapis workspace fhir-service

  • Referencia

Nota:

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

Administre el servicio fhir con healthcareapis.

Comandos

Nombre Description Tipo Estado
az healthcareapis workspace fhir-service create

Cree un recurso de servicio de FHIR con los parámetros especificados.

 Extensión GA
az healthcareapis workspace fhir-service delete

Elimina un servicio FHIR.

 Extensión GA
az healthcareapis workspace fhir-service list

Enumera todos los servicios de FHIR para el área de trabajo especificada.

 Extensión GA
az healthcareapis workspace fhir-service show

Obtiene las propiedades del servicio FHIR especificado.

 Extensión GA
az healthcareapis workspace fhir-service update

Detalles del servicio FHIR de revisión.

 Extensión GA
az healthcareapis workspace fhir-service wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición del área de trabajo de healthcareapis fhir-service.

 Extensión GA

az healthcareapis workspace fhir-service create

Cree un recurso de servicio de FHIR con los parámetros especificados.

az healthcareapis workspace fhir-service create --fhir-service-name
                                                --resource-group
                                                --workspace-name
                                                [--access-policies]
                                                [--authentication-configuration]
                                                [--cors-configuration]
                                                [--default {no-version, versioned, versioned-update}]
                                                [--etag]
                                                [--export-configuration-storage-account-name]
                                                [--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
                                                [--kind {fhir-R4, fhir-Stu3}]
                                                [--location]
                                                [--login-servers]
                                                [--no-wait]
                                                [--oci-artifacts]
                                                [--public-network-access {Disabled, Enabled}]
                                                [--resource-type-overrides]
                                                [--tags]
                                                [--user-assigned-identities]

Ejemplos

Creación o actualización de un servicio de Fhir

az healthcareapis workspace fhir-service create --name "fhirservice1" --identity-type "SystemAssigned" --kind "fhir-R4" --location "westus" --access-policies object-id="c487e7d1-3210-41a3-8ccc-e9372b78da47" --access-policies object-id="5b307da8-43d4-492b-8b66-b0294ade872f" --login-servers "test1.azurecr.io" --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="*" --export-configuration-storage-account-name "existingStorageAccount" --tags additionalProp1="string" additionalProp2="string" additionalProp3="string" --resource-group "testRG" --workspace-name "workspace1"

Parámetros requeridos

--fhir-service-name --name -n

Nombre del recurso del servicio FHIR.

--resource-group -g

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

--workspace-name

Nombre del recurso del área de trabajo.

Parámetros opcionales

--access-policies

Directivas de acceso del servicio Fhir.

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 del servicio Fhir.

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

Configuración de Fhir Service Cors.

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.

--default

Valor predeterminado para el historial de seguimiento en todos los recursos.

valores aceptados: no-version, versioned, versioned-update
--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, SystemAssigned,UserAssigned, UserAssigned
--kind

El tipo de servicio.

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

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

--login-servers

Lista de los servidores de inicio de sesión de Azure Container Registry.

--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.

--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-type-overrides -r

Una lista de recursos de FHIR y sus invalidaciones de directiva de versión. Valor esperado: KEY1=VALUE1 KEY2=VALUE2 ...

--tags

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

--user-assigned-identities -i

Conjunto de identidades asignadas por el usuario asociadas al recurso. Las claves de diccionario userAssignedIdentities serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Los valores del diccionario pueden ser objetos vacíos ({}) en las solicitudes. Valor esperado: json-string/json-file/@json-file.

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 workspace fhir-service delete

Elimina un servicio FHIR.

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

Ejemplos

Eliminación de un servicio de Fhir

az healthcareapis workspace fhir-service delete --name "fhirservice1" --resource-group "testRG" --workspace-name "workspace1"

Parámetros opcionales

--fhir-service-name --name -n

Nombre del recurso del servicio FHIR.

--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>.

--subscription

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

--workspace-name

Nombre del recurso del área de trabajo.

--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 workspace fhir-service list

Enumera todos los servicios de FHIR para el área de trabajo especificada.

az healthcareapis workspace fhir-service list --resource-group
                                              --workspace-name

Ejemplos

Enumerar fhirservices

az healthcareapis workspace fhir-service list --resource-group "testRG" --workspace-name "workspace1"

Parámetros requeridos

--resource-group -g

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

--workspace-name

Nombre del recurso del área de trabajo.

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 workspace fhir-service show

Obtiene las propiedades del servicio FHIR especificado.

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

Ejemplos

Obtención de un servicio de Fhir

az healthcareapis workspace fhir-service show --name "fhirservices1" --resource-group "testRG" --workspace-name "workspace1"

Parámetros opcionales

--fhir-service-name --name -n

Nombre del recurso del servicio FHIR.

--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>.

--subscription

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

--workspace-name

Nombre del recurso del área de trabajo.

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 workspace fhir-service update

Detalles del servicio FHIR de revisión.

az healthcareapis workspace fhir-service update [--fhir-service-name]
                                                [--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
                                                [--ids]
                                                [--no-wait]
                                                [--resource-group]
                                                [--subscription]
                                                [--tags]
                                                [--user-assigned-identities]
                                                [--workspace-name]

Ejemplos

Actualización de un servicio de Fhir

az healthcareapis workspace fhir-service update --name "fhirservice1" --tags tagKey="tagValue" --resource-group "testRG" --workspace-name "workspace1"

Parámetros opcionales

--fhir-service-name --name -n

Nombre del recurso del servicio FHIR.

--identity-type

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

valores aceptados: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned
--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>.

--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.

--user-assigned-identities -i

Conjunto de identidades asignadas por el usuario asociadas al recurso. Las claves de diccionario userAssignedIdentities serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Los valores del diccionario pueden ser objetos vacíos ({}) en las solicitudes. Valor esperado: json-string/json-file/@json-file.

--workspace-name

Nombre del recurso del área de trabajo.

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 workspace fhir-service wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición del área de trabajo de healthcareapis fhir-service.

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

Ejemplos

Pause la ejecución de la siguiente línea de script de la CLI hasta que el área de trabajo de healthcareapis fhir-service se cree correctamente.

az healthcareapis workspace fhir-service wait --name "fhirservices1" --resource-group "testRG" --workspace-name "workspace1" --created

Pause la ejecución de la siguiente línea de script de la CLI hasta que el área de trabajo de healthcareapis fhir-service se actualice correctamente.

az healthcareapis workspace fhir-service wait --name "fhirservices1" --resource-group "testRG" --workspace-name "workspace1" --updated

Pause la ejecución de la siguiente línea de script de la CLI hasta que el área de trabajo de healthcareapis fhir-service se elimine correctamente.

az healthcareapis workspace fhir-service wait --name "fhirservices1" --resource-group "testRG" --workspace-name "workspace1" --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
--fhir-service-name --name -n

Nombre del recurso del servicio FHIR.

--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>.

--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
--workspace-name

Nombre del recurso del área de trabajo.

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.