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

Manage dicom service with healthcareapis.

Commands

Name	Description	Type	Status
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 dicom-service create

Create a DICOM Service resource with the specified parameters.

az healthcareapis workspace dicom-service create --dicom-service-name --name
                                                 --resource-group
                                                 --workspace-name
                                                 [--etag]
                                                 [--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
                                                 [--location]
                                                 [--no-wait]
                                                 [--public-network-access {Disabled, Enabled}]
                                                 [--tags]
                                                 [--user-assigned-identities]

Examples

Create or update a Dicom Service

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

Required Parameters

--dicom-service-name --name -n

The name of DICOM 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.

--etag

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

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

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

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

--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 dicom-service delete

Deletes a DICOM Service.

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

Examples

Delete a dicomservice

az healthcareapis workspace dicom-service delete --name "blue" --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.

--dicom-service-name --name -n

The name of DICOM 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 dicom-service list

Lists all DICOM Services for the given workspace.

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

Examples

List dicomservices

az healthcareapis workspace dicom-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 dicom-service show

Gets the properties of the specified DICOM Service.

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

Examples

Get a dicomservice

az healthcareapis workspace dicom-service show --name "blue" --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.

--dicom-service-name --name -n

The name of DICOM 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 dicom-service update

Patch DICOM Service details.

az healthcareapis workspace dicom-service update [--dicom-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 dicomservice

az healthcareapis workspace dicom-service update --name "blue" --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.

--dicom-service-name --name -n

The name of DICOM 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 dicom-service wait

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

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

Examples

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

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

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

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

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

az healthcareapis workspace dicom-service wait --name "blue" --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

--dicom-service-name --name -n

The name of DICOM Service resource.

Property	Value
Parameter group:	Resource Id Arguments

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

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