az iot adr ns

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

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

Manage Device Registry namespaces.

Commands

Name	Description	Type	Status
az iot adr ns ca	Manage certificate authorities for a Device Registry namespace.	Extension	Preview
az iot adr ns ca activate	Activate an externally issued intermediate certificate authority.	Extension	Preview
az iot adr ns ca create	Create a certificate authority for a Device Registry namespace.	Extension	Preview
az iot adr ns ca delete	Delete a certificate authority from a Device Registry namespace.	Extension	Preview
az iot adr ns ca list	List the certificate authorities for a Device Registry namespace.	Extension	Preview
az iot adr ns ca policy	Manage certificate policies for a certificate authority.	Extension	Preview
az iot adr ns ca policy create	Create a certificate policy for a certificate authority.	Extension	Preview
az iot adr ns ca policy delete	Delete a certificate policy from a certificate authority.	Extension	Preview
az iot adr ns ca policy list	List the certificate policies for a certificate authority.	Extension	Preview
az iot adr ns ca policy show	Show a certificate policy for a certificate authority.	Extension	Preview
az iot adr ns ca policy update	Update a certificate policy for a certificate authority.	Extension	Preview
az iot adr ns ca policy wait	Wait for a certificate policy to reach a desired state.	Extension	Preview
az iot adr ns ca revoke	Revoke and rotate an intermediate certificate authority issued by a Microsoft CA.	Extension	Preview
az iot adr ns ca show	Show a certificate authority for a Device Registry namespace.	Extension	Preview
az iot adr ns ca update	Update a certificate authority for a Device Registry namespace.	Extension	Preview
az iot adr ns ca wait	Wait for a certificate authority to reach a desired state.	Extension	Preview
az iot adr ns create	Create a Device Registry namespace.	Extension	Preview
az iot adr ns delete	Delete a Device Registry namespace.	Extension	Preview
az iot adr ns device	Manage Registry Devices in a Device Registry namespace.	Extension	Preview
az iot adr ns device attribute	Manage Registry Device attributes.	Extension	Preview
az iot adr ns device attribute create	Create or replace a User-reported attribute.	Extension	Preview
az iot adr ns device attribute delete	Delete an attribute by its literal resource name.	Extension	Preview
az iot adr ns device attribute list	List attributes, including service-reported metadata.	Extension	Preview
az iot adr ns device attribute show	Get an attribute.	Extension	Preview
az iot adr ns device auth	Inspect service-materialized authentication profiles.	Extension	Preview
az iot adr ns device auth list	List authentication profile metadata, not plaintext keys.	Extension	Preview
az iot adr ns device auth revoke-certs	Revoke certificates for a CA-signed X.509 profile.	Extension	Preview
az iot adr ns device auth show	Get authentication profile metadata.	Extension	Preview
az iot adr ns device auth show-keys	Retrieve plaintext keys for a SymmetricKey profile.	Extension	Preview
az iot adr ns device auth wait	Wait for authentication profile materialization or a specified condition.	Extension	Preview
az iot adr ns device capability	Inspect service-materialized Registry Device capabilities.	Extension	Preview
az iot adr ns device capability list	List Registry Device capabilities.	Extension	Preview
az iot adr ns device capability show	Get a discovered capability.	Extension	Preview
az iot adr ns device create	Create or replace a Registry Device.	Extension	Preview
az iot adr ns device delete	Delete a Registry Device.	Extension	Preview
az iot adr ns device list	List all Registry Devices in a namespace.	Extension	Preview
az iot adr ns device show	Get a Registry Device by name or external device ID.	Extension	Preview
az iot adr ns device update	Update writable Registry Device properties.	Extension	Preview
az iot adr ns device wait	Wait for Registry Device provisioning or a specified condition.	Extension	Preview
az iot adr ns group	Manage Device Registry namespace groups.	Extension	Preview
az iot adr ns group count	Show the current member count of a group.	Extension	Preview
az iot adr ns group create	Create a group in a Device Registry namespace.	Extension	Preview
az iot adr ns group delete	Delete a group from a Device Registry namespace.	Extension	Preview
az iot adr ns group list	List groups in a Device Registry namespace.	Extension	Preview
az iot adr ns group list-members	List the current members of a group.	Extension	Preview
az iot adr ns group refresh	Trigger an asynchronous refresh of a group's membership.	Extension	Preview
az iot adr ns group show	Show a group in a Device Registry namespace.	Extension	Preview
az iot adr ns group update	Update a group in a Device Registry namespace.	Extension	Preview
az iot adr ns group wait	Wait for a Device Registry group to reach a desired state.	Extension	Preview
az iot adr ns identity	Manage identities assigned to a Device Registry namespace.	Extension	Preview
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 job	Manage Device Registry namespace jobs.	Extension	Preview
az iot adr ns job create	Create a job in a Device Registry namespace.	Extension	Preview
az iot adr ns job delete	Delete a job from a Device Registry namespace.	Extension	Preview
az iot adr ns job list	List jobs in a Device Registry namespace.	Extension	Preview
az iot adr ns job run	Manage runs of Device Registry namespace jobs.	Extension	Preview
az iot adr ns job run cancel	Cancel a Device Registry job run.	Extension	Preview
az iot adr ns job run delete	Delete a Device Registry job run.	Extension	Preview
az iot adr ns job run list	List job runs by parent job or across a namespace.	Extension	Preview
az iot adr ns job run results	Browse per-device results of a job run.	Extension	Preview
az iot adr ns job run show	Show a single run of a Device Registry job.	Extension	Preview
az iot adr ns job run summary	Show aggregate progress counts for a Device Registry job run.	Extension	Preview
az iot adr ns job run wait	Wait for a Device Registry job run to reach a desired state.	Extension	Preview
az iot adr ns job schedule	Schedule an execution of a Device Registry job.	Extension	Preview
az iot adr ns job show	Show a job in a Device Registry namespace.	Extension	Preview
az iot adr ns job update	Update tags on a job in a Device Registry namespace.	Extension	Preview
az iot adr ns job wait	Wait for a Device Registry job to reach a desired state.	Extension	Preview
az iot adr ns link	Manage links between a Device Registry namespace and downstream resources.	Extension	Preview
az iot adr ns link add	Link DPS first, then a Hub, to a Device Registry namespace.	Extension	Preview
az iot adr ns link dps	Manage DPS links (provisioning endpoints) on a Device Registry namespace.	Extension	Preview
az iot adr ns link dps add	Link a Device Provisioning Service (DPS) to a Device Registry namespace.	Extension	Preview
az iot adr ns link dps list	List DPS provisioning endpoints on a Device Registry namespace.	Extension	Preview
az iot adr ns link dps remove	Remove a DPS endpoint from a Device Registry namespace.	Extension	Preview
az iot adr ns link dps show	Show a single DPS provisioning endpoint on a Device Registry namespace.	Extension	Preview
az iot adr ns link dps update	Update an existing DPS provisioning endpoint on a Device Registry namespace.	Extension	Preview
az iot adr ns link dps wait	Wait for a DPS endpoint to link successfully.	Extension	Preview
az iot adr ns link hub	Manage IoT Hub links (messaging endpoints) on a Device Registry namespace.	Extension	Preview
az iot adr ns link hub add	Link an IoT Hub to a Device Registry namespace.	Extension	Preview
az iot adr ns link hub list	List IoT Hub messaging endpoints on a Device Registry namespace.	Extension	Preview
az iot adr ns link hub remove	Remove a IoT Hub endpoint from a Device Registry namespace.	Extension	Preview
az iot adr ns link hub show	Show a single IoT Hub messaging endpoint on a Device Registry namespace.	Extension	Preview
az iot adr ns link hub update	Update an existing IoT Hub messaging endpoint on a Device Registry namespace.	Extension	Preview
az iot adr ns link hub wait	Wait for an IoT Hub endpoint to link successfully.	Extension	Preview
az iot adr ns link su	Manage Software Updates links (updating endpoints) on a Device Registry namespace.	Extension	Preview
az iot adr ns link su add	Link an Update Instance to a Device Registry namespace.	Extension	Preview
az iot adr ns link su list	List Software Updates updating endpoints on a Device Registry namespace.	Extension	Preview
az iot adr ns link su remove	Remove a Software Updates instance endpoint from a Device Registry namespace.	Extension	Preview
az iot adr ns link su show	Show a single Software Updates updating endpoint on a Device Registry namespace.	Extension	Preview
az iot adr ns link su update	Update an existing Software Updates updating endpoint on a Device Registry namespace.	Extension	Preview
az iot adr ns link su wait	Wait for a Software Updates endpoint to link successfully.	Extension	Preview
az iot adr ns link wait	Wait for selected or all namespace links to succeed.	Extension	Preview
az iot adr ns list	List Device Registry namespaces.	Extension	Preview
az iot adr ns migrate	Migrate legacy assets into a Device Registry namespace.	Extension	Preview
az iot adr ns report	Manage Device Registry update-compliance reports.	Extension	Preview
az iot adr ns report generate	Generate an update-compliance report.	Extension	Preview
az iot adr ns report latest	Show the latest update-compliance report.	Extension	Preview
az iot adr ns show	Show details of a Device Registry namespace.	Extension	Preview
az iot adr ns su	Manage Software Updates for Device Registry namespaces.	Extension	Preview
az iot adr ns su device-class	View and delete Software Updates device classes.	Extension	Preview
az iot adr ns su device-class delete	Delete a Software Updates device class.	Extension	Preview
az iot adr ns su device-class list	List device classes in a linked Software Updates instance.	Extension	Preview
az iot adr ns su device-class show	Show a Software Updates device class.	Extension	Preview
az iot adr ns su instance	Manage the Update Instance that powers Software Updates.	Extension	Preview
az iot adr ns su instance check-name	Check whether an Update Instance name is available.	Extension	Preview
az iot adr ns su instance create	Create an Update Instance.	Extension	Preview
az iot adr ns su instance delete	Delete an Update Instance.	Extension	Preview
az iot adr ns su instance list	List Update Instances.	Extension	Preview
az iot adr ns su instance show	Show an Update Instance.	Extension	Preview
az iot adr ns su instance update	Update an Update Instance's tags or managed identity.	Extension	Preview
az iot adr ns su instance wait	Wait for an Update Instance condition.	Extension	Preview
az iot adr ns su software-update	Import and manage Software Updates content.	Extension	Preview
az iot adr ns su software-update calculate-hash	Calculate update-file hashes locally.	Extension	Preview
az iot adr ns su software-update catalog	Discover Software Updates catalog identifiers.	Extension	Preview
az iot adr ns su software-update catalog name	Discover update names for a provider.	Extension	Preview
az iot adr ns su software-update catalog name list	List update names for a provider.	Extension	Preview
az iot adr ns su software-update catalog provider	Discover update providers.	Extension	Preview
az iot adr ns su software-update catalog provider list	List update providers in the catalog.	Extension	Preview
az iot adr ns su software-update catalog version	Discover update versions for a provider and name.	Extension	Preview
az iot adr ns su software-update catalog version list	List update versions for a provider and name.	Extension	Preview
az iot adr ns su software-update delete	Delete an imported update.	Extension	Preview
az iot adr ns su software-update file	Inspect files belonging to an imported update.	Extension	Preview
az iot adr ns su software-update file list	List file identifiers for an imported update.	Extension	Preview
az iot adr ns su software-update file show	Show an imported update file.	Extension	Preview
az iot adr ns su software-update import	Import an update into Software Updates.	Extension	Preview
az iot adr ns su software-update init	Create Software Updates import manifests locally.	Extension	Preview
az iot adr ns su software-update init v5	Create a version 5 import manifest.	Extension	Preview
az iot adr ns su software-update list	List updates imported into Software Updates.	Extension	Preview
az iot adr ns su software-update operation-status	Inspect asynchronous Software Updates operations.	Extension	Preview
az iot adr ns su software-update operation-status list	List retained Software Updates operation statuses.	Extension	Preview
az iot adr ns su software-update operation-status show	Show a Software Updates operation status.	Extension	Preview
az iot adr ns su software-update show	Show an imported update.	Extension	Preview
az iot adr ns su software-update stage	Stage local update artifacts and optionally import them.	Extension	Preview
az iot adr ns su software-update wait	Wait for an imported Software Update condition.	Extension	Preview
az iot adr ns update	Update a Device Registry namespace.	Extension	Preview
az iot adr ns wait	Wait for a Device Registry namespace to reach a desired state.	Extension	Preview

az iot adr ns create

Preview

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

Create a Device Registry namespace.

A new namespace is created with a system-assigned managed identity by default. Observability is disabled by default for a new namespace. This command does not accept observability endpoint input. Re-running create for an existing namespace preserves its complete observability configuration.

az iot adr ns create --name --namespace
                     --resource-group
                     [--acquire-policy-token]
                     [--change-reference]
                     [--location]
                     [--no-wait]
                     [--omi-sa --outbound-system-assigned-mi {false, true}]
                     [--omi-ua --outbound-user-assigned-mi]
                     [--tags]

Examples

Create a basic Device Registry namespace

az iot adr ns create -n myNamespace -g myResourceGroup

Create a Device Registry namespace with system-assigned outbound identity

az iot adr ns create -n myNamespace -g myResourceGroup --outbound-system-assigned-mi

Create a namespace with a user-assigned outbound identity

az iot adr ns create -n myNamespace -g myResourceGroup \
  --outbound-user-assigned-mi /subscriptions/<sub>/resourceGroups/<rg>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<id>

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

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

--omi-sa --outbound-system-assigned-mi

Enable the system-assigned managed identity as the outbound identity used by this namespace when calling linked Hub/DPS resources.

Property	Value
Parameter group:	Outbound Identity Arguments
Accepted values:	false, true

--omi-ua --outbound-user-assigned-mi

User-assigned managed identity resource ID to assign to the namespace and use for outbound calls.

Property	Value
Parameter group:	Outbound Identity Arguments

--tags

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

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 delete

Preview

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

Delete a Device Registry namespace.

az iot adr ns delete --name --namespace
                     --resource-group
                     [--acquire-policy-token]
                     [--change-reference]
                     [--no-wait]
                     [--yes {false, true}]

Examples

Delete a namespace

az iot adr ns delete -n myNamespace -g myResourceGroup

Delete a namespace with no confirmation prompt

az iot adr ns delete -n myNamespace -g myResourceGroup --yes

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

--yes -y

Skip user prompts. Indicates acceptance of action. Used primarily for automation scenarios. Default: false.

Property	Value
Accepted values:	false, true

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 list

Preview

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

List Device Registry namespaces.

az iot adr ns list [--resource-group]

Examples

List all namespaces in a resource group

az iot adr ns list -g myResourceGroup

List all namespaces in the subscription

az iot adr ns list

Optional Parameters

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

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

Preview

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

Migrate legacy assets into a Device Registry namespace.

Migrates existing Microsoft.DeviceRegistry/assets resources into the namespace. The response reports success or failure for each resource ID.

az iot adr ns migrate --ids --resource-ids
                      --name --namespace
                      --resource-group
                      [--acquire-policy-token]
                      [--change-reference]
                      [--no-wait]

Examples

Migrate legacy assets into a namespace

az iot adr ns migrate -n myNamespace -g myResourceGroup \
  --resource-ids /subscriptions/<sub>/resourceGroups/<rg>/providers/Microsoft.DeviceRegistry/assets/asset1

Required Parameters

--ids --resource-ids

Space-separated resource IDs of legacy Microsoft.DeviceRegistry/assets resources to migrate.

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

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 show

Preview

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

Show details of a Device Registry namespace.

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

Examples

Show namespace details

az iot adr ns 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 update

Preview

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

Update a Device Registry namespace.

Observability can only be enabled or disabled when the namespace already has a service-configured observability endpoint. The existing endpoint configuration is preserved. Raw observability endpoint input is not accepted by this command.

az iot adr ns update --name --namespace
                     --resource-group
                     [--acquire-policy-token]
                     [--change-reference]
                     [--no-wait]
                     [--observability-enabled {false, true}]
                     [--omi-sa --outbound-system-assigned-mi {false, true}]
                     [--omi-ua --outbound-user-assigned-mi]
                     [--tags]

Examples

Update namespace tags

az iot adr ns update -n myNamespace -g myResourceGroup --tags key=value

Disable namespace observability

az iot adr ns update -n myNamespace -g myResourceGroup --observability-enabled false

Switch outbound identity to system-assigned managed identity

az iot adr ns update -n myNamespace -g myResourceGroup --outbound-system-assigned-mi

Switch outbound identity to a user-assigned managed identity

az iot adr ns update -n myNamespace -g myResourceGroup \
  --outbound-user-assigned-mi /subscriptions/<sub>/resourceGroups/<rg>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<id>

Clear the explicit outbound identity and use the namespace default

az iot adr ns update -n myNamespace -g myResourceGroup --outbound-system-assigned-mi false

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

--observability-enabled

Enable or disable an existing namespace observability configuration. The namespace must already have a service-configured observability endpoint, which is preserved by this operation.

Property	Value
Accepted values:	false, true

--omi-sa --outbound-system-assigned-mi

Enable the system-assigned managed identity as the outbound identity used by this namespace when calling linked Hub/DPS resources.

Property	Value
Parameter group:	Outbound Identity Arguments
Accepted values:	false, true

--omi-ua --outbound-user-assigned-mi

User-assigned managed identity resource ID to assign to the namespace and use for outbound calls.

Property	Value
Parameter group:	Outbound Identity Arguments

--tags

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

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 wait

Preview

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

Wait for a Device Registry namespace to reach a desired state.

Without an explicit wait predicate, waits for provisioningState Succeeded.

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

Examples

Wait until namespace provisioning succeeds

az iot adr ns 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?