az iot adr ns identity

Preview

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.73.0 or higher). The extension will automatically install the first time you run an az iot adr ns identity command. Learn more about extensions.

Command group 'iot adr ns' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage identities assigned to a Device Registry namespace.

Commands

Name	Description	Type	Status
az iot adr ns identity assign	Assign system- or user-assigned identities to a namespace.	Extension	Preview
az iot adr ns identity remove	Remove system- or user-assigned identities from a namespace.	Extension	Preview
az iot adr ns identity show	Show identities assigned to a namespace.	Extension	Preview
az iot adr ns identity wait	Wait for a namespace identity update to succeed.	Extension	Preview

az iot adr ns identity assign

Preview

Command group 'iot adr ns identity' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Assign system- or user-assigned identities to a namespace.

az iot adr ns identity assign --name --namespace
                              --resource-group
                              [--acquire-policy-token]
                              [--change-reference]
                              [--no-wait]
                              [--system --system-assigned {false, true}]
                              [--user --user-assigned-identity]

Examples

Assign a system and user identity

az iot adr ns identity assign -n myNamespace -g myResourceGroup --system --user /subscriptions/.../userAssignedIdentities/myIdentity

Required Parameters

--name --namespace -n

Name of the Device Registry namespace.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--no-wait

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

Property	Value
Default value:	False

--system --system-assigned

Assign or remove the namespace system-assigned managed identity.

Property	Value
Default value:	False
Accepted values:	false, true

--user --user-assigned-identity

Space-separated user-assigned managed identity resource IDs. On remove, omit values to remove all user-assigned identities.

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 iot adr ns identity remove

Preview

Command group 'iot adr ns identity' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Remove system- or user-assigned identities from a namespace.

An identity configured as the namespace outbound identity must be changed before it can be removed.

az iot adr ns identity remove --name --namespace
                              --resource-group
                              [--acquire-policy-token]
                              [--change-reference]
                              [--no-wait]
                              [--system --system-assigned {false, true}]
                              [--user --user-assigned-identity]

Examples

Remove all user-assigned identities

az iot adr ns identity remove -n myNamespace -g myResourceGroup --user

Required Parameters

--name --namespace -n

Name of the Device Registry namespace.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--no-wait

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

Property	Value
Default value:	False

--system --system-assigned

Assign or remove the namespace system-assigned managed identity.

Property	Value
Default value:	False
Accepted values:	false, true

--user --user-assigned-identity

Space-separated user-assigned managed identity resource IDs. On remove, omit values to remove all user-assigned identities.

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 iot adr ns identity show

Preview

Command group 'iot adr ns identity' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show identities assigned to a namespace.

az iot adr ns identity show --name --namespace
                            --resource-group

Examples

Show namespace identities

az iot adr ns identity show -n myNamespace -g myResourceGroup

Required Parameters

--name --namespace -n

Name of the Device Registry namespace.

--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 iot adr ns identity wait

Preview

Command group 'iot adr ns identity' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Wait for a namespace identity update to succeed.

Without an explicit wait predicate, waits for namespace provisioningState Succeeded.

az iot adr ns identity wait --name --namespace
                            --resource-group
                            [--acquire-policy-token]
                            [--change-reference]
                            [--created]
                            [--custom]
                            [--deleted]
                            [--exists]
                            [--interval]
                            [--timeout]
                            [--updated]

Examples

Wait until the namespace update completes

az iot adr ns identity wait -n myNamespace -g myResourceGroup

Required Parameters

--name --namespace -n

Name of the Device Registry namespace.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--created

Wait until provisioningState is Succeeded.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until a custom JMESPath expression evaluates to true.

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until the resource is 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

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--timeout

Polling budget in seconds, including GET time. An in-flight GET is bounded by transport timeouts and cannot be interrupted by this polling deadline.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until provisioningState is 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.

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

Feedback

Was this page helpful?