Share via

az healthcareapis service

Note

This reference is part of the healthcareapis extension for the Azure CLI (version 2.66.0 or higher). The extension will automatically install the first time you run an az healthcareapis service command. Learn more about extensions.

Healthcareapis service.

Commands

Name Description Type Status
az healthcareapis service create

Create the metadata of a service instance.

 Extension GA
az healthcareapis service delete

Delete a service instance.

 Extension GA
az healthcareapis service list

Get all the service instances in a resource group. And Get all the service instances in a subscription.

 Extension GA
az healthcareapis service show

Get the metadata of a service instance.

 Extension GA
az healthcareapis service update

Update the metadata of a service instance.

 Extension GA
az healthcareapis service wait

Place the CLI in a waiting state until a condition of the healthcareapis service is met.

 Extension GA

az healthcareapis service create

Create the metadata of a service instance.

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]

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" --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"

Create or Update a service with minimum 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"

Required Parameters

--kind

The kind of the service.

Property Value
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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--access-policies

The access policies of the service instance.

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

object-id: Required. An Azure AD object ID (User or Apps) that is allowed access to the FHIR service.

Multiple actions can be specified by using more than one --access-policies argument.

--authentication-configuration -c

The authentication configuration for the service instance.

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

authority: The authority url for the service audience: The audience url for the service smart-proxy-enabled: If the SMART on FHIR proxy is enabled.

--cors-configuration

The settings for the CORS configuration of the service instance.

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

origins: The origins to be allowed via CORS. headers: The headers to be allowed via CORS. methods: The methods to be allowed via CORS. max-age: The max age to be allowed via CORS. allow-credentials: If credentials are allowed via CORS.

--cosmos-db-configuration

The settings for the Cosmos DB database backing the service.

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

offer-throughput: The provisioned throughput for the backing database. key-vault-key-uri: The URI of the customer-managed key for the backing database.

--etag

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

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

The name of the default export storage account.

--identity-type

Type of identity being specified, currently SystemAssigned and None are allowed.

Property Value
Accepted values: None, SystemAssigned
--login-servers

The list of login servers that shallbe added to the service instance.

Property Value
Parameter group: Acr Configuration Arguments
--no-wait

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

Property Value
Default value: False
--oci-artifacts

The list of Open Container Initiative (OCI) artifacts.

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

login-server: The Azure Container Registry login server. image-name: The artifact name. digest: The artifact digest.

Multiple actions can be specified by using more than one --oci-artifacts argument.

Property Value
Parameter group: Acr Configuration Arguments
--private-endpoint-connections

The list of private endpoint connections that are set up for this resource.

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

status: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. description: The reason for approval/rejection of the connection. actions-required: A message indicating if changes on the service provider require any updates on the consumer.

Multiple actions can be specified by using more than one --private-endpoint-connections argument.

--public-network-access

Control permission for data plane traffic coming from public networks while private endpoint is enabled.

Property Value
Accepted values: Disabled, Enabled
--tags

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az healthcareapis service delete

Delete a service instance.

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

Examples

Delete service

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Default value: False
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--resource-name

The name of the service instance.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az healthcareapis service list

Get all the service instances in a resource group. And 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"

List all services in subscription

az healthcareapis service list

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az healthcareapis service show

Get the metadata of a service instance.

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

Examples

Get metadata

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--resource-name

The name of the service instance.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az healthcareapis service update

Update the metadata of a service instance.

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

Examples

Patch service

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Default value: False
--public-network-access

Control permission for data plane traffic coming from public networks while private endpoint is enabled.

Property Value
Accepted values: Disabled, Enabled
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--resource-name

The name of the service instance.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--tags

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az healthcareapis service wait

Place the CLI in a waiting state until a condition of the healthcareapis service is met.

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

Examples

Pause executing next line of CLI script until the healthcareapis service is successfully created.

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

Pause executing next line of CLI script until the healthcareapis service is successfully updated.

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

Pause executing next line of CLI script until the healthcareapis service is successfully deleted.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--resource-name

The name of the service instance.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False