Dela via

az healthcareapis service

  • Referens

Kommentar

Den här referensen är en del av healthcareapis-tillägget för Azure CLI (version 2.15.0 eller senare). Tillägget installeras automatiskt första gången du kör kommandot az healthcareapis service . Läs mer om tillägg.

Healthcareapis-tjänsten.

Kommandon

Name Description Typ Status
az healthcareapis service create

Skapa metadata för en tjänstinstans.

 Anknytning Allmän tillgänglighet
az healthcareapis service delete

Ta bort en tjänstinstans.

 Anknytning Allmän tillgänglighet
az healthcareapis service list

Hämta alla tjänstinstanser i en resursgrupp. Och Hämta alla tjänstinstanser i en prenumeration.

 Anknytning Allmän tillgänglighet
az healthcareapis service show

Hämta metadata för en tjänstinstans.

 Anknytning Allmän tillgänglighet
az healthcareapis service update

Uppdatera metadata för en tjänstinstans.

 Anknytning Allmän tillgänglighet
az healthcareapis service wait

Placera CLI i vänteläge tills ett villkor för healthcareapis-tjänsten har uppfyllts.

 Anknytning Allmän tillgänglighet

az healthcareapis service create

Skapa metadata för en tjänstinstans.

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]

Exempel

Skapa eller uppdatera en tjänst med alla parametrar

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"

Skapa eller uppdatera en tjänst med minimiparametrar

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

Obligatoriska parametrar

--kind

Den typen av tjänst.

accepterade värden: fhir, fhir-R4, fhir-Stu3
--location -l

Plats. Värden från: az account list-locations. Du kan konfigurera standardplatsen med hjälp av az configure --defaults location=<location>.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--resource-name

Namnet på tjänstinstansen.

Valfria parametrar

--access-policies

Åtkomstprinciperna för tjänstinstansen.

Användning: --access-policies object-id=XX

object-id: Krävs. Ett Azure AD-objekt-ID (användare eller appar) som tillåts åtkomst till FHIR-tjänsten.

Flera åtgärder kan anges med hjälp av fler än ett --access-policies-argument.

--authentication-configuration -c

Autentiseringskonfigurationen för tjänstinstansen.

Användning: --authentication-configuration authority=XX audience=XX smart-proxy-enabled=XX

authority: Utfärdar-URL:en för tjänstpubliken: Målgrupps-URL:en för tjänsten smart-proxy-aktiverad: Om SMART på FHIR-proxyn är aktiverad.

--cors-configuration

Inställningarna för CORS-konfigurationen av tjänstinstansen.

Användning: --cors-configuration origins=XX headers=XX methods=XX max-age=XX allow-credentials=XX

ursprung: Ursprung som ska tillåtas via CORS. rubriker: Rubrikerna som ska tillåtas via CORS. metoder: De metoder som ska tillåtas via CORS. maxålder: Den maxålder som ska tillåtas via CORS. allow-credentials: Om autentiseringsuppgifter tillåts via CORS.

--cosmos-db-configuration

Inställningarna för Cosmos DB-databasen som stöder tjänsten.

Användning: --cosmos-db-configuration offer-throughput=XX key-vault-key-uri=XX

offer-throughput: Det etablerade dataflödet för den säkerhetskopierade databasen. key-vault-key-uri: URI för den kundhanterade nyckeln för säkerhetskopieringsdatabasen.

--etag

En etag som är associerad med resursen och som används för optimistisk samtidighet när den redigeras.

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

Namnet på standardlagringskontot för export.

--identity-type

Typ av identitet som anges, för närvarande SystemAssigned och None tillåts.

accepterade värden: None, SystemAssigned
--login-servers

Listan över inloggningsservrar som ska läggas till i tjänstinstansen.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

standardvärde: False
--oci-artifacts

Listan över OCI-artefakter (Open Container Initiative).

Användning: --oci-artifacts login-server=XX image-name=XX digest=XX

login-server: Azure Container Registry-inloggningsservern. image-name: Artefaktnamnet. digest: Artefaktsammandraget.

Flera åtgärder kan anges med hjälp av fler än ett --oci-artifacts-argument.

--private-endpoint-connections

Listan över privata slutpunktsanslutningar som har konfigurerats för den här resursen.

Användning: --private-endpoint-connections status=XX description=XX actions-required=XX

status: Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare. beskrivning: Orsaken till godkännande/avvisande av anslutningen. actions-required: Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.

Flera åtgärder kan anges med hjälp av fler än ett --private-endpoint-connections-argument.

--public-network-access

Kontrollbehörighet för dataplanstrafik som kommer från offentliga nätverk medan den privata slutpunkten är aktiverad.

accepterade värden: Disabled, Enabled
--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az healthcareapis service delete

Ta bort en tjänstinstans.

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

Exempel

Ta bort tjänst

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

Valfria parametrar

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

standardvärde: False
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--resource-name

Namnet på tjänstinstansen.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--yes -y

Fråga inte efter bekräftelse.

standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az healthcareapis service list

Hämta alla tjänstinstanser i en resursgrupp. Och Hämta alla tjänstinstanser i en prenumeration.

az healthcareapis service list [--resource-group]

Exempel

Visa en lista över alla tjänster i resursgruppen

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

Visa en lista över alla tjänster i prenumerationen

az healthcareapis service list

Valfria parametrar

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az healthcareapis service show

Hämta metadata för en tjänstinstans.

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

Exempel

Hämta metadata

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

Valfria parametrar

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--resource-name

Namnet på tjänstinstansen.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az healthcareapis service update

Uppdatera metadata för en tjänstinstans.

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

Exempel

Korrigeringstjänst

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

Valfria parametrar

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

standardvärde: False
--public-network-access

Kontrollbehörighet för dataplanstrafik som kommer från offentliga nätverk medan den privata slutpunkten är aktiverad.

accepterade värden: Disabled, Enabled
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--resource-name

Namnet på tjänstinstansen.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az healthcareapis service wait

Placera CLI i vänteläge tills ett villkor för healthcareapis-tjänsten har uppfyllts.

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

Exempel

Pausa körningen av nästa rad i CLI-skriptet tills healthcareapis-tjänsten har skapats.

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

Pausa körningen av nästa rad i CLI-skriptet tills healthcareapis-tjänsten har uppdaterats.

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

Pausa körningen av nästa rad i CLI-skriptet tills healthcareapis-tjänsten har tagits bort.

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

Valfria parametrar

--created

Vänta tills du har skapat med "provisioningState" på "Lyckades".

standardvärde: False
--custom

Vänta tills villkoret uppfyller en anpassad JMESPath-fråga. T.ex. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Vänta tills den har tagits bort.

standardvärde: False
--exists

Vänta tills resursen finns.

standardvärde: False
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--interval

Avsökningsintervall i sekunder.

standardvärde: 30
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--resource-name

Namnet på tjänstinstansen.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--timeout

Maximal väntetid i sekunder.

standardvärde: 3600
--updated

Vänta tills det har uppdaterats med provisioningState på Lyckades.

standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.