az healthcareapis workspace

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 command. Learn more about extensions.

Manage workspace with healthcareapis.

Commands

Name	Description	Type	Status
az healthcareapis workspace create	Create a workspace resource with the specified parameters.	Extension	GA
az healthcareapis workspace delete	Deletes a specified workspace.	Extension	GA
az healthcareapis workspace dicom-service	Manage dicom service with healthcareapis.	Extension	GA
az healthcareapis workspace dicom-service create	Create a DICOM Service resource with the specified parameters.	Extension	GA
az healthcareapis workspace dicom-service delete	Deletes a DICOM Service.	Extension	GA
az healthcareapis workspace dicom-service list	Lists all DICOM Services for the given workspace.	Extension	GA
az healthcareapis workspace dicom-service show	Gets the properties of the specified DICOM Service.	Extension	GA
az healthcareapis workspace dicom-service update	Patch DICOM Service details.	Extension	GA
az healthcareapis workspace dicom-service wait	Place the CLI in a waiting state until a condition of the healthcareapis workspace dicom-service is met.	Extension	GA
az healthcareapis workspace fhir-service	Manage fhir service with healthcareapis.	Extension	GA
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 iot-connector	Manage iot connector with healthcareapis.	Extension	GA
az healthcareapis workspace iot-connector create	Create an IoT Connector resource with the specified parameters.	Extension	GA
az healthcareapis workspace iot-connector delete	Deletes an IoT Connector.	Extension	GA
az healthcareapis workspace iot-connector fhir-destination	Manage iot connector fhir destination with healthcareapis.	Extension	GA
az healthcareapis workspace iot-connector fhir-destination create	Create an IoT Connector FHIR destination resource with the specified parameters.	Extension	GA
az healthcareapis workspace iot-connector fhir-destination delete	Deletes an IoT Connector FHIR destination.	Extension	GA
az healthcareapis workspace iot-connector fhir-destination list	Lists all FHIR destinations for the given IoT Connector.	Extension	GA
az healthcareapis workspace iot-connector fhir-destination show	Gets the properties of the specified Iot Connector FHIR destination.	Extension	GA
az healthcareapis workspace iot-connector fhir-destination update	Update an IoT Connector FHIR destination resource with the specified parameters.	Extension	GA
az healthcareapis workspace iot-connector fhir-destination wait	Place the CLI in a waiting state until a condition of the healthcareapis workspace iot-connector fhir-destination is met.	Extension	GA
az healthcareapis workspace iot-connector list	Lists all IoT Connectors for the given workspace.	Extension	GA
az healthcareapis workspace iot-connector show	Gets the properties of the specified IoT Connector.	Extension	GA
az healthcareapis workspace iot-connector update	Patch an IoT Connector.	Extension	GA
az healthcareapis workspace iot-connector wait	Place the CLI in a waiting state until a condition of the healthcareapis workspace iot-connector is met.	Extension	GA
az healthcareapis workspace list	Lists all the available workspaces under the specified resource group. And Lists all the available workspaces under the specified subscription.	Extension	GA
az healthcareapis workspace private-endpoint-connection	Manage workspace private endpoint connection with healthcareapis.	Extension	GA
az healthcareapis workspace private-endpoint-connection create	Update the state of the specified private endpoint connection associated with the workspace.	Extension	GA
az healthcareapis workspace private-endpoint-connection delete	Deletes a private endpoint connection.	Extension	GA
az healthcareapis workspace private-endpoint-connection list	Lists all private endpoint connections for a workspace.	Extension	GA
az healthcareapis workspace private-endpoint-connection show	Gets the specified private endpoint connection associated with the workspace.	Extension	GA
az healthcareapis workspace private-endpoint-connection update	Update the state of the specified private endpoint connection associated with the workspace.	Extension	GA
az healthcareapis workspace private-endpoint-connection wait	Place the CLI in a waiting state until a condition of the healthcareapis workspace private-endpoint-connection is met.	Extension	GA
az healthcareapis workspace private-link-resource	Manage workspace private link resource with healthcareapis.	Extension	GA
az healthcareapis workspace private-link-resource list	Gets the private link resources that need to be created for a workspace.	Extension	GA
az healthcareapis workspace private-link-resource show	Gets a private link resource that need to be created for a workspace.	Extension	GA
az healthcareapis workspace show	Gets the properties of the specified workspace.	Extension	GA
az healthcareapis workspace update	Patch workspace details.	Extension	GA
az healthcareapis workspace wait	Place the CLI in a waiting state until a condition of the healthcareapis workspace is met.	Extension	GA

az healthcareapis workspace create

Create a workspace resource with the specified parameters.

az healthcareapis workspace create --name
                                   --resource-group
                                   [--etag]
                                   [--location]
                                   [--no-wait]
                                   [--public-network-access {Disabled, Enabled}]
                                   [--tags]

Examples

Create or update a workspace

az healthcareapis workspace create --resource-group "testRG" --location "westus" --name "workspace1"

Required Parameters

--name --workspace-name -n

The name of workspace resource.

--resource-group -g

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

Optional Parameters

--etag

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

--location -l

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

--no-wait

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

Default value: False

--public-network-access

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

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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az healthcareapis workspace delete

Deletes a specified workspace.

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

Examples

Delete a workspace

az healthcareapis workspace delete --resource-group "testRG" --name "workspace1"

Optional Parameters

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

--name --workspace-name -n

The name of workspace resource.

--no-wait

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

Default value: False

--resource-group -g

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az healthcareapis workspace list

Lists all the available workspaces under the specified resource group. And Lists all the available workspaces under the specified subscription.

az healthcareapis workspace list [--resource-group]

Examples

Get workspaces by resource group

az healthcareapis workspace list --resource-group "testRG"

Get workspaces by subscription

az healthcareapis workspace list

Optional Parameters

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az healthcareapis workspace show

Gets the properties of the specified workspace.

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

Examples

Get workspace

az healthcareapis workspace show --resource-group "testRG" --name "workspace1"

Optional Parameters

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

--name --workspace-name -n

The name of workspace resource.

--resource-group -g

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

--subscription

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az healthcareapis workspace update

Patch workspace details.

az healthcareapis workspace update [--ids]
                                   [--name]
                                   [--no-wait]
                                   [--resource-group]
                                   [--subscription]
                                   [--tags]

Examples

Update a workspace

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

Optional Parameters

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

--name --workspace-name -n

The name of workspace resource.

--no-wait

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

Default value: False

--resource-group -g

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

--subscription

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

--tags

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az healthcareapis workspace wait

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

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

Examples

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

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

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

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

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

az healthcareapis workspace wait --resource-group "testRG" --name "workspace1" --deleted

Optional Parameters

--created

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

Default value: False

--custom

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

--deleted

Wait until deleted.

Default value: False

--exists

Wait until the resource exists.

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.

--interval

Polling interval in seconds.

Default value: 30

--name --workspace-name -n

The name of workspace resource.

--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

Default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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