az healthcareapis workspace fhir-service
Note
This reference is part of the healthcareapis extension for the Azure CLI (version 2.15.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
--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
The name of FHIR Service resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of workspace resource.
Optional Parameters
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.
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.
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.
The default value for tracking history across all resources.
An etag associated with the resource, used for optimistic concurrency when editing it.
The name of the default export storage account.
Type of identity being specified, currently SystemAssigned and None are allowed.
The kind of the service.
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
The list of the Azure container registry login servers.
Do not wait for the long-running operation to finish.
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.
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
A list of FHIR Resources and their version policy overrides. Expect value: KEY1=VALUE1 KEY2=VALUE2 ...
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
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.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az healthcareapis workspace fhir-service delete
Deletes a FHIR Service.
az healthcareapis workspace fhir-service delete [--fhir-service-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 name of FHIR Service resource.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The name of workspace resource.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az healthcareapis workspace fhir-service list
Lists all FHIR Services for the given workspace.
az healthcareapis workspace fhir-service list --resource-group
--workspace-nameExamples
List fhirservices
az healthcareapis workspace fhir-service list --resource-group "testRG" --workspace-name "workspace1"Required Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of workspace resource.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az healthcareapis workspace fhir-service show
Gets the properties of the specified FHIR Service.
az healthcareapis workspace fhir-service show [--fhir-service-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 name of FHIR Service resource.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The name of workspace resource.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az healthcareapis workspace fhir-service update
Patch FHIR Service details.
az healthcareapis workspace fhir-service update [--fhir-service-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 name of FHIR Service resource.
Type of identity being specified, currently SystemAssigned and None are allowed.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
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.
The name of workspace resource.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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]
[--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" --createdPause 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" --updatedPause 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" --deletedOptional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
The name of FHIR Service resource.
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.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
The name of workspace resource.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for