Share via

az deidservice

  • Preview
  • Reference

Note

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

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Health Data service for providing de-identification of health PHI data (Features: Surrogation, multi-modality).

Commands

Name Description Type Status
az deidservice create

Create a DeidService.

 Extension Preview
az deidservice delete

Delete a DeidService by name.

 Extension Preview
az deidservice list

List DeidService resources by subscription Id.

 Extension Preview
az deidservice show

Get a DeidService by name.

 Extension Preview
az deidservice update

Update a DeidService by name.

 Extension Preview
az deidservice wait

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

 Extension Preview

az deidservice create

Preview

Command group 'az deidservice' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a DeidService.

az deidservice create --deid-service-name
                      --resource-group
                      [--identity]
                      [--location]
                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                      [--public-network-access {Disabled, Enabled}]
                      [--tags]

Examples

DeidServices_Create - generated by [MaximumSet] rule

az hls deid create --resource-group rgopenapi --deid-service-name deidTest --location eastus

Required Parameters

--deid-service-name --name -n

The name of the deid service.

--resource-group -g

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

Optional Parameters

--identity

The managed service identities assigned to this resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--public-network-access

Gets or sets allow or disallow public network access to resource.

Accepted values: Disabled, Enabled
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

Preview

Command group 'az deidservice' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a DeidService by name.

az deidservice delete [--deid-service-name]
                      [--ids]
                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                      [--resource-group]
                      [--subscription]
                      [--yes]

Examples

DeidServices_Delete - generated by [MaximumSet] rule - generated by [MaximumSet] rule

az hls deid delete --resource-group rgopenapi --deid-service-name deidTest

Optional Parameters

--deid-service-name --name -n

The name of the deid service.

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

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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 deidservice list

Preview

Command group 'az deidservice' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List DeidService resources by subscription Id.

az deidservice list [--max-items]
                    [--next-token]
                    [--resource-group]

Examples

DeidServices_ListBySubscription - generated by [MaximumSet] rule - generated by [MaximumSet] rule

az hls deid list

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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

Preview

Command group 'az deidservice' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a DeidService by name.

az deidservice show [--deid-service-name]
                    [--ids]
                    [--resource-group]
                    [--subscription]

Examples

DeidServices_Get - generated by [MaximumSet] rule - generated by [MaximumSet] rule

az hls deid show --resource-group rgopenapi --deid-service-name deidTest

Optional Parameters

--deid-service-name --name -n

The name of the deid service.

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

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

Preview

Command group 'az deidservice' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a DeidService by name.

az deidservice update [--add]
                      [--deid-service-name]
                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                      [--identity]
                      [--ids]
                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                      [--public-network-access {Disabled, Enabled}]
                      [--remove]
                      [--resource-group]
                      [--set]
                      [--subscription]
                      [--tags]

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--deid-service-name --name -n

The name of the deid service.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--identity

The managed service identities assigned to this resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--public-network-access

Gets or sets allow or disallow public network access to resource.

Accepted values: Disabled, Enabled
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--subscription

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

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

Preview

Command group 'az deidservice' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

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

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

--deid-service-name --name -n

The name of the deid service.

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