az healthcareapis service

  • Reference

Poznámka

Tento odkaz je součástí rozšíření Healthcareapis pro Azure CLI (verze 2.15.0 nebo vyšší). Rozšíření se automaticky nainstaluje při prvním spuštění příkazu az healthcareapis service . Přečtěte si další informace o rozšířeních.

Služba Healthcareapis.

Příkazy

Name Description Typ Stav
az healthcareapis service create

Vytvořte metadata instance služby.

 Rozšíření GA
az healthcareapis service delete

Odstraňte instanci služby.

 Rozšíření GA
az healthcareapis service list

Získejte všechny instance služby ve skupině prostředků. A získejte všechny instance služby v předplatném.

 Rozšíření GA
az healthcareapis service show

Získejte metadata instance služby.

 Rozšíření GA
az healthcareapis service update

Aktualizujte metadata instance služby.

 Rozšíření GA
az healthcareapis service wait

Umístěte rozhraní příkazového řádku do stavu čekání, dokud nebude splněna podmínka služby healthcareapis.

 Rozšíření GA

az healthcareapis service create

Vytvořte metadata instance služby.

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]

Příklady

Vytvoření nebo aktualizace služby se všemi parametry

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"

Vytvoření nebo aktualizace služby s minimálními parametry

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

Povinné parametry

--kind

Druh služby.

přijímané hodnoty: fhir, fhir-R4, fhir-Stu3
--location -l

Umístění. Hodnoty z: az account list-locations. Výchozí umístění můžete nakonfigurovat pomocí .az configure --defaults location=<location>

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--resource-name

Název instance služby.

Volitelné parametry

--access-policies

Zásady přístupu instance služby.

Použití: --access-policies object-id=XX

object-id: Povinné. ID objektu Azure AD (uživatel nebo aplikace), které má povolený přístup ke službě FHIR.

Více akcí lze zadat pomocí více než jednoho argumentu --access-policies.

--authentication-configuration -c

Konfigurace ověřování pro instanci služby.

Použití: --authentication-configuration authority=XX audience=XX smart-proxy-enabled=XX

autorita: Adresa URL autority pro cílovou skupinu služby: Adresa URL cílové skupiny pro službu s povoleným inteligentním proxy serverem: Pokud je povolený smart na proxy serveru FHIR.

--cors-configuration

Nastavení konfigurace CORS instance služby.

Použití: --cors-configuration origins=XX headers=XX methods=XX max-age=XX allow-credentials=XX

původ: Původy, které mají být povoleny prostřednictvím CORS. hlavičky: Hlavičky, které mají být povoleny prostřednictvím CORS. metody: Metody, které mají být povoleny prostřednictvím CORS. max-age: Maximální věk, který má být povolen prostřednictvím CORS. allow-credentials: Pokud jsou přihlašovací údaje povolené prostřednictvím CORS.

--cosmos-db-configuration

Nastavení pro databázi Cosmos DB, která službu zálohuje.

Použití: --cosmos-db-configuration offer-throughput=XX key-vault-key-uri=XX

offer-throughput: Zřízená propustnost pro backing databázi. key-vault-key-uri: Identifikátor URI klíče spravovaného zákazníkem pro backing databázi.

--etag

Etag přidružený k prostředku, který se používá k optimistické souběžnosti při úpravách.

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

Název výchozího účtu úložiště pro export.

--identity-type

Typ zadané identity, aktuálně jsou povoleny hodnoty SystemAssigned a None.

přijímané hodnoty: None, SystemAssigned
--login-servers

Seznam přihlašovacích serverů, které se přidají do instance služby.

--no-wait

Nečekejte na dokončení dlouhotrvající operace.

výchozí hodnota: False
--oci-artifacts

Seznam artefaktů Open Container Initiative (OCI)

Použití: --oci-artifacts login-server=XX image-name=XX digest=XX

login-server: Přihlašovací server služby Azure Container Registry. image-name: Název artefaktu. digest: Hodnota hash artefaktu.

Pomocí více než jednoho argumentu --oci-artifacts je možné zadat více akcí.

--private-endpoint-connections

Seznam připojení privátních koncových bodů, která jsou pro tento prostředek nastavená.

Použití: --private-endpoint-connections status=XX description=XX actions-required=XX

stav: Označuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem služby. popis: Důvod schválení nebo zamítnutí připojení. Vyžaduje se akce: Zpráva označující, jestli změny poskytovatele služeb vyžadují jakékoli aktualizace příjemce.

Pomocí více než jednoho argumentu --private-endpoint-connections je možné zadat více akcí.

--public-network-access

Řízení oprávnění k provozu roviny dat přicházejících z veřejných sítí, zatímco je povolený privátní koncový bod.

přijímané hodnoty: Disabled, Enabled
--tags

Značky oddělené mezerami: klíč[=hodnota] [klíč[=hodnota] ...]. K vymazání existujících značek použijte "".

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az healthcareapis service delete

Odstraňte instanci služby.

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

Příklady

Odstranit službu

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

Volitelné parametry

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--no-wait

Nečekejte na dokončení dlouhotrvající operace.

výchozí hodnota: False
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--resource-name

Název instance služby.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--yes -y

Nezotvádejte výzvu k potvrzení.

výchozí hodnota: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az healthcareapis service list

Získejte všechny instance služby ve skupině prostředků. A získejte všechny instance služby v předplatném.

az healthcareapis service list [--resource-group]

Příklady

Výpis všech služeb ve skupině prostředků

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

Výpis všech služeb v předplatném

az healthcareapis service list

Volitelné parametry

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az healthcareapis service show

Získejte metadata instance služby.

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

Příklady

Získání metadat

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

Volitelné parametry

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--resource-name

Název instance služby.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az healthcareapis service update

Aktualizujte metadata instance služby.

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

Příklady

Služba Patch

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

Volitelné parametry

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--no-wait

Nečekejte na dokončení dlouhotrvající operace.

výchozí hodnota: False
--public-network-access

Řízení oprávnění k provozu roviny dat přicházejících z veřejných sítí, zatímco je povolený privátní koncový bod.

přijímané hodnoty: Disabled, Enabled
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--resource-name

Název instance služby.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--tags

Značky oddělené mezerami: klíč[=hodnota] [klíč[=hodnota] ...]. K vymazání existujících značek použijte "".

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az healthcareapis service wait

Umístěte rozhraní příkazového řádku do stavu čekání, dokud nebude splněna podmínka služby healthcareapis.

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

Příklady

Pozastavte provádění dalšího řádku skriptu rozhraní příkazového řádku, dokud se služba healthcareapis úspěšně nevytvořila.

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

Pozastavte provádění dalšího řádku skriptu rozhraní příkazového řádku, dokud se služba healthcareapis úspěšně neaktualizuje.

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

Pozastavte provádění dalšího řádku skriptu rozhraní příkazového řádku, dokud se služba healthcareapis úspěšně odstraní.

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

Volitelné parametry

--created

Počkejte na vytvoření s 'provisioningState' v 'Succeeded'.

výchozí hodnota: False
--custom

Počkejte, až podmínka splňuje vlastní dotaz JMESPath. Například provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Počkejte na odstranění.

výchozí hodnota: False
--exists

Počkejte, až prostředek existuje.

výchozí hodnota: False
--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--interval

Interval dotazování v sekundách

výchozí hodnota: 30
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--resource-name

Název instance služby.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--timeout

Maximální čekání v sekundách.

výchozí hodnota: 3600
--updated

Počkejte, dokud se neaktualizuje stav zřizování ve stavu Úspěch.

výchozí hodnota: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.