Share via

az healthcareapis service

  • Referenz

Hinweis

Diese Referenz ist Teil der Healthcareapis-Erweiterung für die Azure CLI (Version 2.15.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen Az healthcareapis-Dienstbefehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Healthcareapis-Dienst.

Befehle

Name Beschreibung Typ Status
az healthcareapis service create

Erstellen Sie die Metadaten einer Dienstinstanz.

 Durchwahl Allgemein verfügbar
az healthcareapis service delete

Löschen sie eine Dienstinstanz.

 Durchwahl Allgemein verfügbar
az healthcareapis service list

Rufen Sie alle Dienstinstanzen in einer Ressourcengruppe ab. Und rufen Sie alle Dienstinstanzen in einem Abonnement ab.

 Durchwahl Allgemein verfügbar
az healthcareapis service show

Rufen Sie die Metadaten einer Dienstinstanz ab.

 Durchwahl Allgemein verfügbar
az healthcareapis service update

Aktualisieren sie die Metadaten einer Dienstinstanz.

 Durchwahl Allgemein verfügbar
az healthcareapis service wait

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung des Healthcareapis-Diensts erfüllt ist.

 Durchwahl Allgemein verfügbar

az healthcareapis service create

Erstellen Sie die Metadaten einer Dienstinstanz.

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]

Beispiele

Erstellen oder Aktualisieren eines Diensts mit allen Parametern

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"

Erstellen oder Aktualisieren eines Diensts mit minimalen Parametern

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

Erforderliche Parameter

--kind

Die Art des Diensts.

Zulässige Werte: fhir, fhir-R4, fhir-Stu3
--location -l

Position Werte aus: az account list-locations. Sie können den standardmäßig verwendeten Standort mit az configure --defaults location=<location> konfigurieren.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--resource-name

Der Name der Dienstinstanz.

Optionale Parameter

--access-policies

Die Zugriffsrichtlinien der Dienstinstanz.

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

object-id: Erforderlich. Eine Azure AD-Objekt-ID (Benutzer oder Apps), die zugriff auf den FHIR-Dienst erlaubt ist.

Mehrere Aktionen können mithilfe von mehr als einem --access-policies-Argument angegeben werden.

--authentication-configuration -c

Die Authentifizierungskonfiguration für die Dienstinstanz.

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

authority: Die Autoritäts-URL für die Dienstgruppe: Die Benutzergruppen-URL für den Dienst smart-proxy-enabled: Wenn der SMART on FHIR-Proxy aktiviert ist.

--cors-configuration

Die Einstellungen für die CORS-Konfiguration der Dienstinstanz.

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

Ursprünge: Die Ursprünge, die über CORS erlaubt werden sollen. Header: Die Kopfzeilen, die über CORS zulässig sind. methoden: Die Methoden, die über CORS zulässig sind. max-age: Das maximale Alter, das über CORS erlaubt werden soll. allow-credentials: If credentials are allowed via CORS.

--cosmos-db-configuration

Die Einstellungen für die Cosmos DB-Datenbank, die den Dienst unterstützt.

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

Angebotsdurchsatz: Der bereitgestellte Durchsatz für die Sicherungsdatenbank. key-vault-key-uri: Der URI des vom Kunden verwalteten Schlüssels für die Sicherungsdatenbank.

--etag

Ein Etag, das der Ressource zugeordnet ist, wird bei der Bearbeitung für optimistische Parallelität verwendet.

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

Der Name des standardmäßigen Exportspeicherkontos.

--identity-type

Der Typ der angegebenen Identität, derzeit "SystemAssigned" und "None" sind zulässig.

Zulässige Werte: None, SystemAssigned
--login-servers

Die Liste der Anmeldeserver, die der Dienstinstanz hinzugefügt werden sollen.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False
--oci-artifacts

Die Liste der Open Container Initiative (OCI)-Artefakte.

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

Anmeldeserver: Der Azure Container Registry-Anmeldeserver. Bildname: Der Artefaktname. digest: Der Artefaktdig.

Mehrere Aktionen können mit mehreren Argumenten --oci-artifacts angegeben werden.

--private-endpoint-connections

Die Liste der privaten Endpunktverbindungen, die für diese Ressource eingerichtet sind.

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

status: Gibt an, ob die Verbindung vom Besitzer des Diensts genehmigt/abgelehnt/entfernt wurde. description: Der Grund für die Genehmigung/Ablehnung der Verbindung. Aktionen erforderlich: Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher erfordern.

Mehrere Aktionen können mithilfe von mehr als einem --private-endpoint-connections-Argument angegeben werden.

--public-network-access

Steuern sie die Berechtigung für Datenebenendatenverkehr aus öffentlichen Netzwerken, während der private Endpunkt aktiviert ist.

Zulässige Werte: Disabled, Enabled
--tags

Durch Leerzeichen getrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az healthcareapis service delete

Löschen sie eine Dienstinstanz.

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

Beispiele

Suchdienst löschen

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

Optionale Parameter

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False
--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--resource-name

Der Name der Dienstinstanz.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--yes -y

Nicht zur Bestätigung auffordern

Standardwert: False
Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az healthcareapis service list

Rufen Sie alle Dienstinstanzen in einer Ressourcengruppe ab. Und rufen Sie alle Dienstinstanzen in einem Abonnement ab.

az healthcareapis service list [--resource-group]

Beispiele

Auflisten aller Dienste in der Ressourcengruppe

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

Alle Dienste im Abonnement auflisten

az healthcareapis service list

Optionale Parameter

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az healthcareapis service show

Rufen Sie die Metadaten einer Dienstinstanz ab.

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

Beispiele

Metadaten abrufen

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

Optionale Parameter

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--resource-name

Der Name der Dienstinstanz.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az healthcareapis service update

Aktualisieren sie die Metadaten einer Dienstinstanz.

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

Beispiele

Patchdienst

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

Optionale Parameter

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False
--public-network-access

Steuern sie die Berechtigung für Datenebenendatenverkehr aus öffentlichen Netzwerken, während der private Endpunkt aktiviert ist.

Zulässige Werte: Disabled, Enabled
--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--resource-name

Der Name der Dienstinstanz.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--tags

Durch Leerzeichen getrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az healthcareapis service wait

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung des Healthcareapis-Diensts erfüllt ist.

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

Beispiele

Anhalten der Ausführung der nächsten Zeile des CLI-Skripts, bis der Healthcareapis-Dienst erfolgreich erstellt wurde.

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

Anhalten der Ausführung der nächsten Zeile des CLI-Skripts, bis der Healthcareapis-Dienst erfolgreich aktualisiert wurde.

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

Anhalten der Ausführung der nächsten Zeile des CLI-Skripts, bis der Healthcareapis-Dienst erfolgreich gelöscht wurde.

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

Optionale Parameter

--created

Warten Sie, bis sie mit 'provisioningState' unter 'Succeeded' erstellt wurde.

Standardwert: False
--custom

Warten Sie, bis die Bedingung eine benutzerdefinierte JMESPath-Abfrage erfüllt. Beispiel: provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Warten Sie, bis sie gelöscht wurde.

Standardwert: False
--exists

Warten Sie, bis die Ressource vorhanden ist.

Standardwert: False
--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--interval

Abrufintervall in Sekunden.

Standardwert: 30
--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--resource-name

Der Name der Dienstinstanz.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--timeout

Maximale Wartezeit in Sekunden.

Standardwert: 3600
--updated

Warten Sie, bis sie mit provisioningState unter 'Succeeded' aktualisiert wurde.

Standardwert: False
Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.