Share via

az healthcareapis deidservice identity

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

Provide an automatically managed identity.

Commands

Name Description Type Status
az healthcareapis deidservice identity assign

Assign the user or system managed identities.

 Extension GA
az healthcareapis deidservice identity remove

Remove the user or system managed identities.

 Extension GA
az healthcareapis deidservice identity show

Show the details of managed identities.

 Extension GA
az healthcareapis deidservice identity wait

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

 Extension GA

az healthcareapis deidservice identity assign

Assign the user or system managed identities.

az healthcareapis deidservice identity assign --deid-service-name --name
                                              --resource-group
                                              [--mi-system-assigned --system-assigned]
                                              [--mi-user-assigned --user-assigned]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

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

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

--mi-system-assigned --system-assigned

Set the system managed identity.

Property Value
Parameter group: Resource.identity Arguments
--mi-user-assigned --user-assigned

Set the user managed identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Resource.identity Arguments
--no-wait

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

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

Remove the user or system managed identities.

az healthcareapis deidservice identity remove --deid-service-name --name
                                              --resource-group
                                              [--mi-system-assigned --system-assigned]
                                              [--mi-user-assigned --user-assigned]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

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

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

--mi-system-assigned --system-assigned

Set the system managed identity.

Property Value
Parameter group: Resource.identity Arguments
--mi-user-assigned --user-assigned

Set the user managed identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Resource.identity Arguments
--no-wait

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

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

Show the details of managed identities.

az healthcareapis deidservice identity show --deid-service-name --name
                                            --resource-group

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

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

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

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

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
--deid-service-name --name -n

The name of the deid service.

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