Udostępnij za pośrednictwem

az healthcareapis service

  • Odwołanie

Uwaga

Ta dokumentacja jest częścią rozszerzenia healthcareapis dla interfejsu wiersza polecenia platformy Azure (wersja 2.15.0 lub nowsza). Rozszerzenie zostanie automatycznie zainstalowane przy pierwszym uruchomieniu polecenia az healthcareapis service . Dowiedz się więcej o rozszerzeniach.

Usługa Healthcareapis.

Polecenia

Nazwa Opis Typ Stan
az healthcareapis service create

Utwórz metadane wystąpienia usługi.

 Numer wewnętrzny Ogólna dostępność
az healthcareapis service delete

Usuwanie wystąpienia usługi.

 Numer wewnętrzny Ogólna dostępność
az healthcareapis service list

Pobierz wszystkie wystąpienia usługi w grupie zasobów. Pobierz wszystkie wystąpienia usługi w subskrypcji.

 Numer wewnętrzny Ogólna dostępność
az healthcareapis service show

Pobieranie metadanych wystąpienia usługi.

 Numer wewnętrzny Ogólna dostępność
az healthcareapis service update

Aktualizowanie metadanych wystąpienia usługi.

 Numer wewnętrzny Ogólna dostępność
az healthcareapis service wait

Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku usługi healthcareapis.

 Numer wewnętrzny Ogólna dostępność

az healthcareapis service create

Utwórz metadane wystąpienia usługi.

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]

Przykłady

Tworzenie lub aktualizowanie usługi przy użyciu wszystkich parametrów

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"

Tworzenie lub aktualizowanie usługi przy użyciu minimalnych parametrów

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

Parametry wymagane

--kind

Rodzaj usługi.

akceptowane wartości: fhir, fhir-R4, fhir-Stu3
--location -l

Lokalizacja. Wartości z: az account list-locations. Lokalizację domyślną można skonfigurować przy użyciu polecenia az configure --defaults location=<location>.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--resource-name

Nazwa wystąpienia usługi.

Parametry opcjonalne

--access-policies

Zasady dostępu wystąpienia usługi.

Użycie: --access-policies object-id=XX

object-id: wymagane. Identyfikator obiektu usługi Azure AD (użytkownik lub aplikacje), który może uzyskiwać dostęp do usługi FHIR.

Wiele akcji można określić za pomocą więcej niż jednego argumentu --access-policies.

--authentication-configuration -c

Konfiguracja uwierzytelniania dla wystąpienia usługi.

Użycie: --authentication-configuration authority=XX audience=XX smart-proxy-enabled=XX

authority: adres URL urzędu dla odbiorców usługi: adres URL odbiorców usługi z włączoną obsługą inteligentnego serwera proxy: jeśli serwer proxy SMART on FHIR jest włączony.

--cors-configuration

Ustawienia konfiguracji mechanizmu CORS wystąpienia usługi.

Użycie: --cors-configuration origins=XX headers=XX methods=XX max-age=XX allow-credentials=XX

origins: źródła, które mają być dozwolone za pośrednictwem mechanizmu CORS. nagłówki: nagłówki, które mają być dozwolone za pośrednictwem mechanizmu CORS. methods: Metody, które mają być dozwolone za pośrednictwem mechanizmu CORS. max-age: maksymalny wiek dozwolony za pośrednictwem mechanizmu CORS. allow-credentials: jeśli poświadczenia są dozwolone za pośrednictwem mechanizmu CORS.

--cosmos-db-configuration

Ustawienia bazy danych Cosmos DB służącej do tworzenia kopii zapasowej usługi.

Użycie: --cosmos-db-configuration offer-throughput=XX key-vault-key-uri=XX

offer-throughput: aprowizowana przepływność dla bazy danych zaplecza. key-vault-key-uri: identyfikator URI klucza zarządzanego przez klienta dla bazy danych kopii zapasowej.

--etag

Element etag skojarzony z zasobem używany do optymistycznej współbieżności podczas edytowania.

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

Nazwa domyślnego konta magazynu eksportu.

--identity-type

Typ określonej tożsamości, obecnie SystemAssigned i None są dozwolone.

akceptowane wartości: None, SystemAssigned
--login-servers

Lista serwerów logowania, które należy dodać do wystąpienia usługi.

--no-wait

Nie czekaj na zakończenie długotrwałej operacji.

wartość domyślna: False
--oci-artifacts

Lista artefaktów Open Container Initiative (OCI).

Użycie: --oci-artifacts login-server=XX image-name=XX digest=XX

login-server: serwer logowania usługi Azure Container Registry. image-name: nazwa artefaktu. skrót: skrót artefaktu.

Wiele akcji można określić za pomocą więcej niż jednego argumentu --oci-artifacts.

--private-endpoint-connections

Lista połączeń prywatnych punktów końcowych skonfigurowanych dla tego zasobu.

Użycie: --private-endpoint-connections status=XX description=XX actions-required=XX

status: wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi. opis: przyczyna zatwierdzenia/odrzucenia połączenia. wymagane akcje: komunikat wskazujący, czy zmiany u dostawcy usług wymagają aktualizacji użytkownika.

Wiele akcji można określić za pomocą więcej niż jednego argumentu --private-endpoint-connections.

--public-network-access

Uprawnienia do kontrolowania ruchu płaszczyzny danych pochodzącego z sieci publicznych, gdy prywatny punkt końcowy jest włączony.

akceptowane wartości: Disabled, Enabled
--tags

Tagi rozdzielone spacjami: klucz[=wartość] [key[=value] ...]. Użyj ciągu "", aby wyczyścić istniejące tagi.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az healthcareapis service delete

Usuwanie wystąpienia usługi.

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

Przykłady

Usuń usługę

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

Parametry opcjonalne

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być pełny identyfikator zasobu zawierający wszystkie informacje o argumentach "Identyfikator zasobu". Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

--no-wait

Nie czekaj na zakończenie długotrwałej operacji.

wartość domyślna: False
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--resource-name

Nazwa wystąpienia usługi.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--yes -y

Nie monituj o potwierdzenie.

wartość domyślna: False
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az healthcareapis service list

Pobierz wszystkie wystąpienia usługi w grupie zasobów. Pobierz wszystkie wystąpienia usługi w subskrypcji.

az healthcareapis service list [--resource-group]

Przykłady

Wyświetlanie listy wszystkich usług w grupie zasobów

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

Wyświetlanie listy wszystkich usług w subskrypcji

az healthcareapis service list

Parametry opcjonalne

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az healthcareapis service show

Pobieranie metadanych wystąpienia usługi.

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

Przykłady

Pobieranie metadanych

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

Parametry opcjonalne

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być pełny identyfikator zasobu zawierający wszystkie informacje o argumentach "Identyfikator zasobu". Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--resource-name

Nazwa wystąpienia usługi.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az healthcareapis service update

Aktualizowanie metadanych wystąpienia usługi.

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

Przykłady

Usługa poprawek

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

Parametry opcjonalne

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być pełny identyfikator zasobu zawierający wszystkie informacje o argumentach "Identyfikator zasobu". Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

--no-wait

Nie czekaj na zakończenie długotrwałej operacji.

wartość domyślna: False
--public-network-access

Uprawnienia do kontrolowania ruchu płaszczyzny danych pochodzącego z sieci publicznych, gdy prywatny punkt końcowy jest włączony.

akceptowane wartości: Disabled, Enabled
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--resource-name

Nazwa wystąpienia usługi.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--tags

Tagi rozdzielone spacjami: klucz[=wartość] [key[=value] ...]. Użyj ciągu "", aby wyczyścić istniejące tagi.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az healthcareapis service wait

Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku usługi healthcareapis.

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

Przykłady

Wstrzymaj wykonywanie następnego wiersza skryptu interfejsu wiersza polecenia do momentu pomyślnego utworzenia usługi healthcareapis.

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

Wstrzymaj wykonywanie następnego wiersza polecenia skryptu interfejsu wiersza polecenia, dopóki usługa healthcareapis nie zostanie pomyślnie zaktualizowana.

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

Wstrzymaj wykonywanie następnego wiersza polecenia skryptu interfejsu wiersza polecenia, dopóki usługa healthcareapis nie zostanie pomyślnie usunięta.

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

Parametry opcjonalne

--created

Zaczekaj na utworzenie polecenia "provisioningState" o godzinie "Succeeded".

wartość domyślna: False
--custom

Poczekaj, aż warunek spełnia niestandardowe zapytanie JMESPath. Np. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Poczekaj na usunięcie.

wartość domyślna: False
--exists

Zaczekaj, aż zasób istnieje.

wartość domyślna: False
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być pełny identyfikator zasobu zawierający wszystkie informacje o argumentach "Identyfikator zasobu". Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

--interval

Interwał sondowania w sekundach.

wartość domyślna: 30
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--resource-name

Nazwa wystąpienia usługi.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--timeout

Maksymalny czas oczekiwania w sekundach.

wartość domyślna: 3600
--updated

Zaczekaj na zaktualizowanie stanu provisioningState o 'Powodzenie'.

wartość domyślna: False
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.