Condividi tramite

az healthcareapis service

  • Riferimento

Nota

Questo riferimento fa parte dell'estensione healthcareapis per l'interfaccia della riga di comando di Azure (versione 2.66.0 o successiva). L'estensione installerà automaticamente la prima volta che si esegue un comando az healthcareapis service . Altre informazioni sulle estensioni.

Servizio Healthcareapis.

Comandi

Nome Descrizione Tipo Status
az healthcareapis service create

Creare i metadati di un'istanza del servizio.

 Estensione Disponibilità generale
az healthcareapis service delete

Eliminare un'istanza del servizio.

 Estensione Disponibilità generale
az healthcareapis service list

Ottenere tutte le istanze del servizio in un gruppo di risorse. E ottenere tutte le istanze del servizio in una sottoscrizione.

 Estensione Disponibilità generale
az healthcareapis service show

Ottenere i metadati di un'istanza del servizio.

 Estensione Disponibilità generale
az healthcareapis service update

Aggiornare i metadati di un'istanza del servizio.

 Estensione Disponibilità generale
az healthcareapis service wait

Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione del servizio healthcareapis.

 Estensione Disponibilità generale

az healthcareapis service create

Creare i metadati di un'istanza del servizio.

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]

Esempio

Creare o aggiornare un servizio con tutti i parametri

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"

Creare o aggiornare un servizio con parametri minimi

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

Parametri necessari

--kind

Tipo di servizio.

Valori accettati: fhir, fhir-R4, fhir-Stu3
--location -l

Posizione. Usare i valori ottenuti con az account list-locations. È possibile configurare la posizione predefinito con az configure --defaults location=<location>.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--resource-name

Nome dell'istanza del servizio.

Parametri facoltativi

--access-policies

Criteri di accesso dell'istanza del servizio.

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

object-id: obbligatorio. ID oggetto di Azure AD (Utente o App) a cui è consentito l'accesso al servizio FHIR.

È possibile specificare più azioni usando più di un argomento --access-policies.

--authentication-configuration -c

Configurazione di autenticazione per l'istanza del servizio.

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

authority: l'URL dell'autorità per il gruppo di destinatari del servizio: l'URL del gruppo di destinatari per il servizio smart-proxy-enabled: se il proxy SMART on FHIR è abilitato.

--cors-configuration

Impostazioni per la configurazione CORS dell'istanza del servizio.

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

origini: le origini da consentire tramite CORS. intestazioni: le intestazioni da consentire tramite CORS. metodi: i metodi da consentire tramite CORS. max-age: validità massima consentita tramite CORS. allow-credentials: se le credenziali sono consentite tramite CORS.

--cosmos-db-configuration

Impostazioni per il database Cosmos DB che esegue il backup del servizio.

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

offerta-velocità effettiva: velocità effettiva con provisioning per il database di backup. key-vault-key-uri: URI della chiave gestita dal cliente per il database di backup.

--etag

Etag associato alla risorsa, usato per la concorrenza ottimistica durante la modifica.

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

Nome dell'account di archiviazione di esportazione predefinito.

--identity-type

Tipo di identità specificato, attualmente SystemAssigned e None sono consentiti.

Valori accettati: None, SystemAssigned
--login-servers

Elenco di server di accesso che devono essere aggiunti all'istanza del servizio.

--no-wait

Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.

Valore predefinito: False
--oci-artifacts

Elenco di artefatti OCI (Open Container Initiative).

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

login-server: server di accesso Registro Azure Container. image-name: nome dell'artefatto. digest: digest dell'artefatto.

È possibile specificare più azioni usando più di un argomento --oci-artifacts.

--private-endpoint-connections

Elenco di connessioni endpoint privato configurate per questa risorsa.

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

status: indica se la connessione è stata approvata/rifiutata/rimossa dal proprietario del servizio. description: motivo dell'approvazione/rifiuto della connessione. actions-required: messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti sul consumer.

È possibile specificare più azioni usando più di un argomento --private-endpoint-connections.

--public-network-access

Autorizzazione di controllo per il traffico del piano dati proveniente da reti pubbliche mentre è abilitato l'endpoint privato.

Valori accettati: Disabled, Enabled
--tags

Tag separati da spazi: key[=value] [key[=value] ...]. Usare "" per cancellare i tag esistenti.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
Valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az healthcareapis service delete

Eliminare un'istanza del servizio.

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

Esempio

Delete service

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

Parametri facoltativi

--ids

Uno o più ID della risorsa (delimitato da spazio). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti 'ID risorsa'. È necessario specificare --ids o altri argomenti 'ID risorsa'.

--no-wait

Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.

Valore predefinito: False
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--resource-name

Nome dell'istanza del servizio.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

--yes -y

Indica che non è richiesta la conferma.

Valore predefinito: False
Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
Valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az healthcareapis service list

Ottenere tutte le istanze del servizio in un gruppo di risorse. E ottenere tutte le istanze del servizio in una sottoscrizione.

az healthcareapis service list [--resource-group]

Esempio

Elencare tutti i servizi nel gruppo di risorse

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

Elencare tutti i servizi nella sottoscrizione

az healthcareapis service list

Parametri facoltativi

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
Valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az healthcareapis service show

Ottenere i metadati di un'istanza del servizio.

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

Esempio

Ottenere metadati

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

Parametri facoltativi

--ids

Uno o più ID della risorsa (delimitato da spazio). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti 'ID risorsa'. È necessario specificare --ids o altri argomenti 'ID risorsa'.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--resource-name

Nome dell'istanza del servizio.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
Valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az healthcareapis service update

Aggiornare i metadati di un'istanza del servizio.

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

Esempio

Servizio patch

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

Parametri facoltativi

--ids

Uno o più ID della risorsa (delimitato da spazio). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti 'ID risorsa'. È necessario specificare --ids o altri argomenti 'ID risorsa'.

--no-wait

Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.

Valore predefinito: False
--public-network-access

Autorizzazione di controllo per il traffico del piano dati proveniente da reti pubbliche mentre è abilitato l'endpoint privato.

Valori accettati: Disabled, Enabled
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--resource-name

Nome dell'istanza del servizio.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

--tags

Tag separati da spazi: key[=value] [key[=value] ...]. Usare "" per cancellare i tag esistenti.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
Valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az healthcareapis service wait

Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione del servizio healthcareapis.

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

Esempio

Sospendere l'esecuzione dello script successivo dell'interfaccia della riga di comando fino a quando il servizio healthcareapis non viene creato correttamente.

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

Sospendere l'esecuzione della riga di comando successiva dello script dell'interfaccia della riga di comando fino a quando il servizio healthcareapis non viene aggiornato correttamente.

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

Sospendere l'esecuzione della riga di comando successiva dello script dell'interfaccia della riga di comando fino a quando il servizio healthcareapis non viene eliminato correttamente.

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

Parametri facoltativi

--created

Attendere fino a quando non viene creato con 'provisioningState' in 'Succeeded'.

Valore predefinito: False
--custom

Attendere che la condizione soddisfi una query JMESPath personalizzata. Ad esempio provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Attendere l'eliminazione.

Valore predefinito: False
--exists

Attendere che la risorsa esista.

Valore predefinito: False
--ids

Uno o più ID della risorsa (delimitato da spazio). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti 'ID risorsa'. È necessario specificare --ids o altri argomenti 'ID risorsa'.

--interval

Intervallo di polling in secondi.

Valore predefinito: 30
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--resource-name

Nome dell'istanza del servizio.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

--timeout

Attesa massima in secondi.

Valore predefinito: 3600
--updated

Attendere fino a quando non viene aggiornato con provisioningState in 'Succeeded'.

Valore predefinito: False
Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
Valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.