az iot adr ns su instance

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 su instance 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 the Update Instance that powers Software Updates.

Update Instances are top-level Microsoft.DeviceUpdate resources. They are grouped here for Device Registry discoverability but are not namespace children.

Commands

Name	Description	Type	Status
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 instance check-name

Preview

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

Check whether an Update Instance name is available.

az iot adr ns su instance check-name --name
                                     [--acquire-policy-token]
                                     [--change-reference]

Examples

Check a name

az iot adr ns su instance check-name -n myUpdateInstance

Required Parameters

--name -n

Name of the Update Instance.

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

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 su instance create

Preview

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

Create an Update Instance.

Creates a Microsoft.DeviceUpdate/updateInstances resource. Managed identity arguments can be combined and describe the complete desired identity state when supplied. Re-running create without either identity option preserves an existing instance's SAMI/UAMI configuration, tags, and service-managed state.

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

Examples

Create an instance with a system-assigned identity

az iot adr ns su instance create -n myUpdateInstance -g myResourceGroup --location eastus2 --system-assigned-mi

Create an instance with system- and user-assigned identities

az iot adr ns su instance create -n myUpdateInstance -g myResourceGroup \
  --system-assigned-mi --user-assigned-mi /subscriptions/<sub>/resourceGroups/<rg>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<identity>

Replace an existing instance identity with a user-assigned-only configuration

az iot adr ns su instance create -n myUpdateInstance -g myResourceGroup \
  --user-assigned-mi /subscriptions/<sub>/resourceGroups/<rg>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<identity>

Required Parameters

--name -n

Name of the Update Instance.

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

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

Include or remove the system-assigned managed identity. On create-or-update, omitting all managed identity options preserves the existing identity.

Property	Value
Accepted values:	false, true

--mi-ua --user-assigned-mi

Complete desired set of user-assigned managed identity resource IDs. On create-or-update, omitting all managed identity options preserves the existing identity.

--no-wait

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

Property	Value
Default value:	False

--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 su instance delete

Preview

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

Delete an Update Instance.

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

Examples

Delete without prompting

az iot adr ns su instance delete -n myUpdateInstance -g myResourceGroup --yes

Required Parameters

--name -n

Name of the Update Instance.

--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 su instance list

Preview

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

List Update Instances.

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

Examples

List instances in a resource group

az iot adr ns su instance list -g myResourceGroup

List instances in the subscription

az iot adr ns su instance 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 su instance show

Preview

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

Show an Update Instance.

az iot adr ns su instance show --name
                               --resource-group

Examples

Show an instance

az iot adr ns su instance show -n myUpdateInstance -g myResourceGroup

Required Parameters

--name -n

Name of the Update Instance.

--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 su instance update

Preview

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

Update an Update Instance's tags or managed identity.

Identity options describe the complete desired identity state when supplied: --system-assigned-mi controls SAMI and --user-assigned-mi supplies the UAMI set. Omit both identity options to leave the existing identity unchanged.

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

Examples

Update tags

az iot adr ns su instance update -n myUpdateInstance -g myResourceGroup --tags environment=test

Set the identity to system-assigned

az iot adr ns su instance update -n myUpdateInstance -g myResourceGroup --system-assigned-mi

Required Parameters

--name -n

Name of the Update Instance.

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

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

Include or remove the system-assigned managed identity. On create-or-update, omitting all managed identity options preserves the existing identity.

Property	Value
Accepted values:	false, true

--mi-ua --user-assigned-mi

Complete desired set of user-assigned managed identity resource IDs. On create-or-update, omitting all managed identity options preserves the existing identity.

--no-wait

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

Property	Value
Default value:	False

--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 su instance wait

Preview

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

Wait for an Update Instance condition.

Without an explicit wait predicate, waits for provisioningState Succeeded.

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

Examples

Wait until provisioning succeeds

az iot adr ns su instance wait -n myUpdateInstance -g myResourceGroup

Required Parameters

--name -n

Name of the Update Instance.

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