Share via

az healthcareapis workspace fhir-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 workspace fhir-service command. Learn more about extensions.

Manage fhir service with healthcareapis.

Commands

Name Description Type Status
az healthcareapis workspace fhir-service create

Create a FHIR Service resource with the specified parameters.

 Extension GA
az healthcareapis workspace fhir-service delete

Deletes a FHIR Service.

 Extension GA
az healthcareapis workspace fhir-service list

Lists all FHIR Services for the given workspace.

 Extension GA
az healthcareapis workspace fhir-service show

Gets the properties of the specified FHIR Service.

 Extension GA
az healthcareapis workspace fhir-service update

Patch FHIR Service details.

 Extension GA
az healthcareapis workspace fhir-service wait

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

 Extension GA

az healthcareapis workspace fhir-service create

Create a FHIR Service resource with the specified parameters.

az healthcareapis workspace fhir-service create --fhir-service-name --name
                                                --resource-group
                                                --workspace-name
                                                [--access-policies]
                                                [--authentication-configuration]
                                                [--cors-configuration]
                                                [--default {no-version, versioned, versioned-update}]
                                                [--etag]
                                                [--export-configuration-storage-account-name]
                                                [--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
                                                [--kind {fhir-R4, fhir-Stu3}]
                                                [--location]
                                                [--login-servers]
                                                [--no-wait]
                                                [--oci-artifacts]
                                                [--public-network-access {Disabled, Enabled}]
                                                [--resource-type-overrides]
                                                [--tags]
                                                [--user-assigned-identities]

Examples

Create or update a Fhir Service

az healthcareapis workspace fhir-service create --name "fhirservice1" --identity-type "SystemAssigned" --kind "fhir-R4" --location "westus" --access-policies object-id="c487e7d1-3210-41a3-8ccc-e9372b78da47" --access-policies object-id="5b307da8-43d4-492b-8b66-b0294ade872f" --login-servers "test1.azurecr.io" --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="*" --export-configuration-storage-account-name "existingStorageAccount" --tags additionalProp1="string" additionalProp2="string" additionalProp3="string" --resource-group "testRG" --workspace-name "workspace1"

Required Parameters

--fhir-service-name --name -n

The name of FHIR Service resource.

--resource-group -g

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

--workspace-name

The name of workspace resource.

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

Fhir Service access policies.

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

Fhir Service authentication configuration.

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

Fhir Service Cors configuration.

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.

--default

The default value for tracking history across all resources.

Property Value
Parameter group: Resource Version Policy Configuration Arguments
Accepted values: no-version, versioned, versioned-update
--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.

Property Value
Parameter group: Export Configuration Arguments
--identity-type

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

Property Value
Parameter group: Identity Arguments
Accepted values: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned
--kind

The kind of the service.

Property Value
Accepted values: 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>.

--login-servers

The list of the Azure container registry login servers.

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
--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-type-overrides -r

A list of FHIR Resources and their version policy overrides. Expect value: KEY1=VALUE1 KEY2=VALUE2 ...

Property Value
Parameter group: Resource Version Policy Configuration Arguments
--tags

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

--user-assigned-identities -i

The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. Expected value: json-string/json-file/@json-file.

Property Value
Parameter group: Identity 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.

--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 workspace fhir-service delete

Deletes a FHIR Service.

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

Examples

Delete a Fhir Service

az healthcareapis workspace fhir-service delete --name "fhirservice1" --resource-group "testRG" --workspace-name "workspace1"

Optional Parameters

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

--fhir-service-name --name -n

The name of FHIR Service resource.

Property Value
Parameter group: Resource Id Arguments
--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
--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
--workspace-name

The name of workspace resource.

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 workspace fhir-service list

Lists all FHIR Services for the given workspace.

az healthcareapis workspace fhir-service list --resource-group
                                              --workspace-name

Examples

List fhirservices

az healthcareapis workspace fhir-service list --resource-group "testRG" --workspace-name "workspace1"

Required Parameters

--resource-group -g

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

--workspace-name

The name of workspace resource.

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 workspace fhir-service show

Gets the properties of the specified FHIR Service.

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

Examples

Get a Fhir Service

az healthcareapis workspace fhir-service show --name "fhirservices1" --resource-group "testRG" --workspace-name "workspace1"

Optional Parameters

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

--fhir-service-name --name -n

The name of FHIR Service resource.

Property Value
Parameter group: Resource Id Arguments
--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
--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
--workspace-name

The name of workspace resource.

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 workspace fhir-service update

Patch FHIR Service details.

az healthcareapis workspace fhir-service update [--fhir-service-name --name]
                                                [--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
                                                [--ids]
                                                [--no-wait]
                                                [--resource-group]
                                                [--subscription]
                                                [--tags]
                                                [--user-assigned-identities]
                                                [--workspace-name]

Examples

Update a Fhir Service

az healthcareapis workspace fhir-service update --name "fhirservice1" --tags tagKey="tagValue" --resource-group "testRG" --workspace-name "workspace1"

Optional Parameters

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

--fhir-service-name --name -n

The name of FHIR Service resource.

Property Value
Parameter group: Resource Id Arguments
--identity-type

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

Property Value
Parameter group: Identity Arguments
Accepted values: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned
--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
--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.

--user-assigned-identities -i

The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. Expected value: json-string/json-file/@json-file.

Property Value
Parameter group: Identity Arguments
--workspace-name

The name of workspace resource.

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 workspace fhir-service wait

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

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

Examples

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

az healthcareapis workspace fhir-service wait --name "fhirservices1" --resource-group "testRG" --workspace-name "workspace1" --created

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

az healthcareapis workspace fhir-service wait --name "fhirservices1" --resource-group "testRG" --workspace-name "workspace1" --updated

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

az healthcareapis workspace fhir-service wait --name "fhirservices1" --resource-group "testRG" --workspace-name "workspace1" --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
--fhir-service-name --name -n

The name of FHIR Service resource.

Property Value
Parameter group: Resource Id Arguments
--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
--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
--workspace-name

The name of workspace resource.

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