Compartilhar via

az healthcareapis service

  • Referência

Observação

Essa referência faz parte da extensão healthcareapis para a CLI do Azure (versão 2.15.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az healthcareapis service . Saiba mais sobre extensões.

Serviço Healthcareapis.

Comandos

Nome Description Tipo Status
az healthcareapis service create

Crie os metadados de uma instância de serviço.

 Extensão GA
az healthcareapis service delete

Exclua uma instância de serviço.

 Extensão GA
az healthcareapis service list

Obtenha todas as instâncias de serviço em um grupo de recursos. E obtenha todas as instâncias de serviço em uma assinatura.

 Extensão GA
az healthcareapis service show

Obtenha os metadados de uma instância de serviço.

 Extensão GA
az healthcareapis service update

Atualizar os metadados de uma instância de serviço.

 Extensão GA
az healthcareapis service wait

Coloque a CLI em um estado de espera até que uma condição do serviço healthcareapis seja atendida.

 Extensão GA

az healthcareapis service create

Crie os metadados de uma instância de serviço.

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]

Exemplos

Criar ou atualizar um serviço com todos os 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"

Criar ou atualizar um serviço com 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 Exigidos

--kind

O tipo de serviço.

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

Local. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--resource-name

O nome da instância de serviço.

Parâmetros Opcionais

--access-policies

As políticas de acesso da instância de serviço.

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

object-id: Obrigatório. Uma ID de objeto do Azure AD (Usuário ou Aplicativos) que tem permissão de acesso ao serviço FHIR.

Várias ações podem ser especificadas usando mais de um argumento --access-policies.

--authentication-configuration -c

A configuração de autenticação para a instância de serviço.

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

authority: A url de autoridade para a audiência do serviço: A URL da audiência para o serviço habilitado para proxy inteligente: Se o proxy SMART no FHIR estiver habilitado.

--cors-configuration

As configurações para a configuração do CORS da instância de serviço.

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

origens: As origens a serem permitidas via CORS. headers: Os cabeçalhos a serem permitidos via CORS. métodos: Os métodos a serem permitidos via CORS. max-age: A idade máxima a ser permitida via CORS. allow-credentials: Se as credenciais forem permitidas via CORS.

--cosmos-db-configuration

As configurações para o banco de dados do Cosmos DB que faz backup do serviço.

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

offer-throughput: A taxa de transferência provisionada para o banco de dados de suporte. key-vault-key-uri: O URI da chave gerenciada pelo cliente para o banco de dados de backup.

--etag

Uma etag associada ao recurso, usada para simultaneidade otimista ao editá-lo.

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

O nome da conta de armazenamento de exportação padrão.

--identity-type

Tipo de identidade sendo especificado, atualmente SystemAssigned e Nenhum são permitidos.

valores aceitos: None, SystemAssigned
--login-servers

A lista de servidores de logon que devem ser adicionados à instância de serviço.

--no-wait

Não aguarde a conclusão da operação de execução longa.

valor padrão: False
--oci-artifacts

A lista de artefatos da Open Container Initiative (OCI).

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

login-server: o servidor de logon do Registro de Contêiner do Azure. image-name: O nome do artefato. digest: O artefato digest.

Várias ações podem ser especificadas usando mais de um argumento --oci-artifacts.

--private-endpoint-connections

A lista de conexões de ponto de extremidade privadas configuradas para este recurso.

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

status: indica se a conexão foi Aprovada/Rejeitada/Removida pelo proprietário do serviço. description: O motivo da aprovação/rejeição da conexão. actions-required: uma mensagem indicando se as alterações no provedor de serviços exigem atualizações no consumidor.

Várias ações podem ser especificadas usando mais de um argumento --private-endpoint-connections.

--public-network-access

Controle a permissão para o tráfego do plano de dados proveniente de redes públicas enquanto o ponto de extremidade privado estiver habilitado.

valores aceitos: Disabled, Enabled
--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar as tags existentes.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az healthcareapis service delete

Exclua uma instância de serviço.

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

Exemplos

Excluir serviço

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

Parâmetros Opcionais

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--no-wait

Não aguarde a conclusão da operação de execução longa.

valor padrão: False
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--resource-name

O nome da instância de serviço.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--yes -y

Não solicite confirmação.

valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az healthcareapis service list

Obtenha todas as instâncias de serviço em um grupo de recursos. E obtenha todas as instâncias de serviço em uma assinatura.

az healthcareapis service list [--resource-group]

Exemplos

Listar todos os serviços no grupo de recursos

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

Listar todos os serviços na assinatura

az healthcareapis service list

Parâmetros Opcionais

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az healthcareapis service show

Obtenha os metadados de uma instância de serviço.

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

Exemplos

Obter metadados

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

Parâmetros Opcionais

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--resource-name

O nome da instância de serviço.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az healthcareapis service update

Atualizar os metadados de uma instância de serviço.

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

Exemplos

Serviço de patch

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

Parâmetros Opcionais

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--no-wait

Não aguarde a conclusão da operação de execução longa.

valor padrão: False
--public-network-access

Controle a permissão para o tráfego do plano de dados proveniente de redes públicas enquanto o ponto de extremidade privado estiver habilitado.

valores aceitos: Disabled, Enabled
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--resource-name

O nome da instância de serviço.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar as tags existentes.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az healthcareapis service wait

Coloque a CLI em um estado de espera até que uma condição do serviço healthcareapis seja atendida.

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

Exemplos

Pause a execução da próxima linha do script da CLI até que o serviço healthcareapis seja criado com êxito.

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

Pause a execução da próxima linha do script da CLI até que o serviço healthcareapis seja atualizado com êxito.

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

Pause a execução da próxima linha do script da CLI até que o serviço healthcareapis seja excluído com êxito.

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

Parâmetros Opcionais

--created

Aguarde até criar com 'provisioningState' em 'Succeeded'.

valor padrão: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

valor padrão: False
--exists

Aguarde até que o recurso exista.

valor padrão: False
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--interval

Intervalo de sondagem em segundos.

valor padrão: 30
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--resource-name

O nome da instância de serviço.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--timeout

Espera máxima em segundos.

valor padrão: 3600
--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.