Freigeben über

az healthcareapis workspace fhir-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-Arbeitsbereich fhir-service-Befehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Verwalten Sie den fhir-Dienst mit healthcareapis.

Befehle

Name Beschreibung Typ Status
az healthcareapis workspace fhir-service create

Erstellen Sie eine FHIR-Dienstressource mit den angegebenen Parametern.

 Durchwahl Allgemein verfügbar
az healthcareapis workspace fhir-service delete

Löscht einen FHIR-Dienst.

 Durchwahl Allgemein verfügbar
az healthcareapis workspace fhir-service list

Listet alle FHIR-Dienste für den angegebenen Arbeitsbereich auf.

 Durchwahl Allgemein verfügbar
az healthcareapis workspace fhir-service show

Ruft die Eigenschaften des angegebenen FHIR-Diensts ab.

 Durchwahl Allgemein verfügbar
az healthcareapis workspace fhir-service update

Details zum Patch-FHIR-Dienst.

 Durchwahl Allgemein verfügbar
az healthcareapis workspace fhir-service wait

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung des Arbeitsbereichs healthcareapis fhir-service erfüllt ist.

 Durchwahl Allgemein verfügbar

az healthcareapis workspace fhir-service create

Erstellen Sie eine FHIR-Dienstressource mit den angegebenen Parametern.

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]

Beispiele

Erstellen oder Aktualisieren eines Fhir-Diensts

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"

Erforderliche Parameter

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

Der Name der FHIR-Dienstressource.

--resource-group -g

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

--workspace-name

Der Name der Arbeitsbereichsressource.

Optionale Parameter

--access-policies

Fhir Service-Zugriffsrichtlinien.

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

Fhir Service-Authentifizierungskonfiguration.

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

Fhir Service Cors-Konfiguration.

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.

--default

Der Standardwert für das Nachverfolgen des Verlaufs über alle Ressourcen hinweg.

Zulässige Werte: no-version, versioned, versioned-update
--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, SystemAssigned,UserAssigned, UserAssigned
--kind

Die Art des Diensts.

Zulässige Werte: 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.

--login-servers

Die Liste der Azure-Containerregistrierungs-Anmeldeserver.

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

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

Eine Liste der FHIR-Ressourcen und deren Versionsrichtlinienüberschreibungen. Wert erwarten: KEY1=WERT1 KEY2=WERT2 ...

--tags

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

--user-assigned-identities -i

Die Gruppe der benutzerzuweisungen Identitäten, die der Ressource zugeordnet sind. Die Wörterbuchschlüssel "userAssignedIdentities" sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein. Erwarteter Wert: json-string/json-file/@json-file.

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

Löscht einen FHIR-Dienst.

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

Beispiele

Löschen eines Fhir-Diensts

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

Optionale Parameter

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

Der Name der FHIR-Dienstressource.

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

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

--workspace-name

Der Name der Arbeitsbereichsressource.

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

Listet alle FHIR-Dienste für den angegebenen Arbeitsbereich auf.

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

Beispiele

Auflisten von fhirservices

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

Erforderliche Parameter

--resource-group -g

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

--workspace-name

Der Name der Arbeitsbereichsressource.

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

Ruft die Eigenschaften des angegebenen FHIR-Diensts ab.

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

Beispiele

Abrufen eines Fhir-Diensts

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

Optionale Parameter

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

Der Name der FHIR-Dienstressource.

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

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

--workspace-name

Der Name der Arbeitsbereichsressource.

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

Details zum Patch-FHIR-Dienst.

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]

Beispiele

Aktualisieren eines Fhir-Diensts

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

Optionale Parameter

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

Der Name der FHIR-Dienstressource.

--identity-type

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

Zulässige Werte: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned
--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.

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

--user-assigned-identities -i

Die Gruppe der benutzerzuweisungen Identitäten, die der Ressource zugeordnet sind. Die Wörterbuchschlüssel "userAssignedIdentities" sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein. Erwarteter Wert: json-string/json-file/@json-file.

--workspace-name

Der Name der Arbeitsbereichsressource.

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

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung des Arbeitsbereichs healthcareapis fhir-service erfüllt ist.

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

Beispiele

Anhalten der Ausführung der nächsten Zeile des CLI-Skripts, bis der Arbeitsbereich "healthcareapis" fhir-service erfolgreich erstellt wurde.

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

Anhalten der Ausführung der nächsten Zeile des CLI-Skripts, bis der Arbeitsbereich "healthcareapis" fhir-service erfolgreich aktualisiert wurde.

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

Anhalten der Ausführung der nächsten Zeile des CLI-Skripts, bis der Arbeitsbereich "healthcareapis" fhir-service erfolgreich gelöscht wurde.

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

Der Name der FHIR-Dienstressource.

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

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

Der Name der Arbeitsbereichsressource.

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.