az healthcareapis service

Healthcareapis service.

Commands

az healthcareapis service create

Create or update the metadata of a service instance.

az healthcareapis service delete

Delete a service instance.

az healthcareapis service list

Get all the service instances in a subscription.

az healthcareapis service show

Get the metadata of a service instance.

az healthcareapis service update

Update the metadata of a service instance.

az healthcareapis service create

Create or update the metadata of a service instance.

az healthcareapis service create --kind {fhir, fhir-R4, fhir-Stu3}
                                 --location
                                 --resource-group
                                 --resource-name
                                 [--etag]
                                 [--identity]
                                 [--no-wait]
                                 [--properties]
                                 [--tags]

Examples

Create or Update a service with all parameters

az healthcareapis service create --resource-group "rg1" --resource-name "service1" --identity type="SystemAssigned" --kind "fhir-R4" --location "westus2" --properties "{\"accessPolicies\":[{\"objectId\":\"c487e7d1-3210-41a3-8ccc-e9372b78da47\"},{\"objectId\":\"5b307da8-43d4-492b-8b66-b0294ade872f\"}],\"authenticationConfiguration\":{\"audience\":\"https://azurehealthcareapis.com\",\"authority\":\"https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc\",\"smartProxyEnabled\":true},\"corsConfiguration\":{\"allowCredentials\":false,\"headers\":[\"*\"],\"maxAge\":1440,\"methods\":[\"DELETE\",\"GET\",\"OPTIONS\",\"PATCH\",\"POST\",\"PUT\"],\"origins\":[\"*\"]},\"cosmosDbConfiguration\":{\"offerThroughput\":1000},\"exportConfiguration\":{\"storageAccountName\":\"existingStorageAccount\"}}"

Create or Update a service with minimum parameters

az healthcareapis service create --resource-group "rg1" --resource-name "service2" --kind "fhir-R4" --location "westus2" --properties "{\"accessPolicies\":[{\"objectId\":\"c487e7d1-3210-41a3-8ccc-e9372b78da47\"}]}"

Required Parameters

--kind

The kind of the service.

accepted values: fhir, fhir-R4, fhir-Stu3
--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--resource-name

The name of the service instance.

Optional Parameters

--etag

An etag associated with the resource, used for optimistic concurrency when editing it.

--identity

Setting indicating whether the service has a managed identity associated with it. Expect value: type=xx.

--no-wait

Do not wait for the long-running operation to finish.

--properties

The common properties of a service. Expected value: json-string/@json-file.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az healthcareapis service delete

Delete a service instance.

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

Examples

Delete service

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

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--resource-name

The name of the service instance.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

az healthcareapis service list

Get all the service instances in a subscription.

az healthcareapis service list [--resource-group]

Examples

List all services in resource group

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

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az healthcareapis service show

Get the metadata of a service instance.

az healthcareapis service show --resource-group
                               --resource-name

Examples

Get metadata

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

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--resource-name

The name of the service instance.

az healthcareapis service update

Update the metadata of a service instance.

az healthcareapis service update --resource-group
                                 --resource-name
                                 [--no-wait]
                                 [--tags]

Examples

Patch service

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

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--resource-name

The name of the service instance.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.