az healthcareapis service

  • Referentie

Notitie

Deze verwijzing maakt deel uit van de healthcareapis-extensie voor de Azure CLI (versie 2.15.0 of hoger). De extensie installeert automatisch de eerste keer dat u een az healthcareapis-serviceopdracht uitvoert. Meer informatie over extensies.

Healthcareapis service.

Opdracht

Name Description Type Status
az healthcareapis service create

Maak de metagegevens van een service-exemplaar.

 Toestel GA
az healthcareapis service delete

Een service-exemplaar verwijderen.

 Toestel GA
az healthcareapis service list

Haal alle service-exemplaren in een resourcegroep op. En alle service-exemplaren in een abonnement ophalen.

 Toestel GA
az healthcareapis service show

Haal de metagegevens van een service-exemplaar op.

 Toestel GA
az healthcareapis service update

Werk de metagegevens van een service-exemplaar bij.

 Toestel GA
az healthcareapis service wait

Plaats de CLI in een wachtstatus totdat aan een voorwaarde van de healthcareapis-service wordt voldaan.

 Toestel GA

az healthcareapis service create

Maak de metagegevens van een service-exemplaar.

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]

Voorbeelden

Een service maken of bijwerken met alle parameters

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"

Een service maken of bijwerken met minimale parameters

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

Vereiste parameters

--kind

Het soort service.

geaccepteerde waarden: fhir, fhir-R4, fhir-Stu3
--location -l

Locatie. Waarden van: az account list-locations. U kunt de standaardlocatie configureren met behulp van az configure --defaults location=<location>.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--resource-name

De naam van het service-exemplaar.

Optionele parameters

--access-policies

Het toegangsbeleid van het service-exemplaar.

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

object-id: vereist. Een Azure AD-object-id (gebruiker of apps) die toegang heeft tot de FHIR-service.

Meerdere acties kunnen worden opgegeven met behulp van meer dan één argument --access-policies.

--authentication-configuration -c

De verificatieconfiguratie voor het service-exemplaar.

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

instantie: De url van de instantie voor de servicedoelgroep: de doelgroep-URL voor de service waarvoor smart-proxy is ingeschakeld: als de SMART on FHIR-proxy is ingeschakeld.

--cors-configuration

De instellingen voor de CORS-configuratie van het service-exemplaar.

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

origins: De oorsprongen zijn toegestaan via CORS. headers: De headers kunnen worden toegestaan via CORS. methoden: De methoden die via CORS moeten worden toegestaan. max-age: de maximale leeftijd die via CORS mag worden toegestaan. allow-credentials: Als referenties zijn toegestaan via CORS.

--cosmos-db-configuration

De instellingen voor de Cosmos DB-database die de service back-up maken.

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

aanbiedingsdoorvoer: de ingerichte doorvoer voor de back-updatabase. key-vault-key-uri: de URI van de door de klant beheerde sleutel voor de back-updatabase.

--etag

Een etag die is gekoppeld aan de resource, die wordt gebruikt voor optimistische gelijktijdigheid bij het bewerken ervan.

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

De naam van het standaardopslagaccount voor exporteren.

--identity-type

Het type identiteit dat wordt opgegeven, momenteel SystemAssigned en None zijn toegestaan.

geaccepteerde waarden: None, SystemAssigned
--login-servers

De lijst met aanmeldingsservers die moeten worden toegevoegd aan het service-exemplaar.

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

standaardwaarde: False
--oci-artifacts

De lijst met OCI-artefacten (Open Container Initiative).

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

login-server: de Azure Container Registry-aanmeldingsserver. image-name: de naam van het artefact. digest: De artefactsamenvating.

Meerdere acties kunnen worden opgegeven met behulp van meer dan één argument --oci-artifacts.

--private-endpoint-connections

De lijst met privé-eindpuntverbindingen die zijn ingesteld voor deze resource.

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

status: Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service. beschrijving: De reden voor goedkeuring/afwijzing van de verbinding. acties vereist: een bericht dat aangeeft of wijzigingen in de serviceprovider updates voor de consument vereisen.

Meerdere acties kunnen worden opgegeven met behulp van meer dan één argument --privé-eindpunt-verbindingen.

--public-network-access

Beheermachtiging voor gegevensvlakverkeer dat afkomstig is van openbare netwerken terwijl privé-eindpunt is ingeschakeld.

geaccepteerde waarden: Disabled, Enabled
--tags

Door spaties gescheiden tags: key[=value] [key[=value] ...]. Gebruik '' om bestaande tags te wissen.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az healthcareapis service delete

Een service-exemplaar verwijderen.

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

Voorbeelden

Service verwijderen

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

Optionele parameters

--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

standaardwaarde: False
--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--resource-name

De naam van het service-exemplaar.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--yes -y

Niet vragen om bevestiging.

standaardwaarde: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az healthcareapis service list

Haal alle service-exemplaren in een resourcegroep op. En alle service-exemplaren in een abonnement ophalen.

az healthcareapis service list [--resource-group]

Voorbeelden

Alle services in de resourcegroep weergeven

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

Alle services in abonnement weergeven

az healthcareapis service list

Optionele parameters

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az healthcareapis service show

Haal de metagegevens van een service-exemplaar op.

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

Voorbeelden

Metagegevens ophalen

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

Optionele parameters

--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--resource-name

De naam van het service-exemplaar.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az healthcareapis service update

Werk de metagegevens van een service-exemplaar bij.

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

Voorbeelden

Patchservice

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

Optionele parameters

--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

standaardwaarde: False
--public-network-access

Beheermachtiging voor gegevensvlakverkeer dat afkomstig is van openbare netwerken terwijl privé-eindpunt is ingeschakeld.

geaccepteerde waarden: Disabled, Enabled
--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--resource-name

De naam van het service-exemplaar.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--tags

Door spaties gescheiden tags: key[=value] [key[=value] ...]. Gebruik '' om bestaande tags te wissen.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az healthcareapis service wait

Plaats de CLI in een wachtstatus totdat aan een voorwaarde van de healthcareapis-service wordt voldaan.

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

Voorbeelden

Pauzeer het uitvoeren van de volgende regel van het CLI-script totdat de healthcareapis-service is gemaakt.

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

Pauzeer het uitvoeren van de volgende regel van het CLI-script totdat de healthcareapis-service is bijgewerkt.

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

Pauzeer het uitvoeren van de volgende regel van het CLI-script totdat de healthcareapis-service is verwijderd.

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

Optionele parameters

--created

Wacht totdat u 'provisioningState' hebt gemaakt bij 'Succeeded'.

standaardwaarde: False
--custom

Wacht tot de voorwaarde voldoet aan een aangepaste JMESPath-query. Bijvoorbeeld provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wacht totdat deze is verwijderd.

standaardwaarde: False
--exists

Wacht tot de resource bestaat.

standaardwaarde: False
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

--interval

Polling-interval in seconden.

standaardwaarde: 30
--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--resource-name

De naam van het service-exemplaar.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--timeout

Maximale wachttijd in seconden.

standaardwaarde: 3600
--updated

Wacht totdat deze is bijgewerkt met provisioningState op 'Succeeded'.

standaardwaarde: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.