az iot du account

  • Reference

Note

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

Device Update account management.

Commands

Name Description Type Status
az iot du account create

Create a Device Update account.

 Extension GA
az iot du account delete

Delete a Device Update account.

 Extension GA
az iot du account list

List all Device Update accounts in a subscription or resource group.

 Extension GA
az iot du account private-endpoint-connection

Device Update account private endpoint connection management.

 Extension GA
az iot du account private-endpoint-connection delete

Delete a private endpoint connection associated with a Device Update account.

 Extension GA
az iot du account private-endpoint-connection list

List private endpoint connections associated with a Device Update account.

 Extension GA
az iot du account private-endpoint-connection set

Set the state of a private endpoint connection associated with a Device Update account.

 Extension GA
az iot du account private-endpoint-connection show

Show a private endpoint connection associated with a Device Update account.

 Extension GA
az iot du account private-link-resource

Device Update account private link resource management.

 Extension GA
az iot du account private-link-resource list

List private link resources supported by the account.

 Extension GA
az iot du account show

Show the details of a Device Update account.

 Extension GA
az iot du account update

Update a Device Update account.

 Extension GA
az iot du account wait

Block until a desired account resource state has been met.

 Extension GA

az iot du account create

Create a Device Update account.

This command may also be used to update the state of an existing account.

az iot du account create --account
                         --resource-group
                         [--assign-identity]
                         [--location]
                         [--no-wait]
                         [--pna {Disabled, Enabled}]
                         [--role]
                         [--scopes]
                         [--sku {Free, Standard}]
                         [--tags]

Examples

Create a Device Update account in target resource group using the resource group location.

az iot du account create -n {account_name} -g {resouce_group}

Create a free sku Device Update account in target resource group with specified location and tags without blocking.

az iot du account create -n {account_name} -g {resouce_group} -l westus --tags a=b c=d --sku Free --no-wait

Create a Device Update account in target resource group with a system managed identity.

az iot du account create -n {account_name} -g {resouce_group} --assign-identity [system]

Create a Device Update account in target resource group with a system managed identity then assign the system identity to a single scope with the role of Contributor.

az iot du account create -n {account_name} -g {resouce_group} --assign-identity [system] --scopes /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount

Create a Device Update account in target resource group with system and user-assigned managed identities then assign the system identity to one or more scopes (space-separated) with a custom specified role.

az iot du account create -n {account_name} -g {resouce_group} --assign-identity [system] /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourcegroups/ProResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity --scopes /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount1
  /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount2
--role "Storage Blob Data Contributor"

Required Parameters

--account -n

Device Update account name. You can configure the default account name using az config set defaults.adu_account=<name>.

--resource-group -g

Device Update account resource group name. You can configure the default group using az config set defaults.adu_group=<name>.

Optional Parameters

--assign-identity

Accepts system or user assigned identities separated by spaces. Use '[system]' to refer to the system assigned identity, or a resource Id to refer to a user assigned identity. Check out help for examples.

--location -l

Device Update account location. If no location is provided the resource group location is used. You can configure the default location using az configure --defaults location=<name>.

--no-wait

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

default value: False
--pna --public-network-access

Indicates if the Device Update account can be accessed from a public network.

accepted values: Disabled, Enabled
default value: Enabled
--role

Role name or Id the system assigned identity will have.

default value: Contributor
--scopes

Space-separated scopes the system assigned identity can access. Cannot be used with --no-wait.

--sku

Device Update account SKU.

accepted values: Free, Standard
default value: Standard
--tags

Resource tags. Property bag in key-value pairs with the following format: a=b c=d.

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 iot du account delete

Delete a Device Update account.

az iot du account delete --account
                         [--no-wait]
                         [--resource-group]
                         [--yes {false, true}]

Examples

Delete a target account.

az iot du account delete -n {account_name}

Delete a target account without confirmation or blocking.

az iot du account delete -n {account_name} -y --no-wait

Required Parameters

--account -n

Device Update account name. You can configure the default account name using az config set defaults.adu_account=<name>.

Optional Parameters

--no-wait

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

default value: False
--resource-group -g

Device Update account resource group name. You can configure the default group using az config set defaults.adu_group=<name>.

--yes -y

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

accepted values: false, true
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 iot du account list

List all Device Update accounts in a subscription or resource group.

az iot du account list [--resource-group]

Examples

List all accounts in a subscription.

az iot du account list

List accounts in a subscription that meet filter criteria.

az iot du account list --query "[?tags.env == 'test']"

List all accounts in a resource group.

az iot du account list -g {resource_group}

Optional Parameters

--resource-group -g

Device Update account resource group name. You can configure the default group using az config set defaults.adu_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 iot du account show

Show the details of a Device Update account.

az iot du account show --account
                       [--resource-group]

Examples

Show a target account.

az iot du account show -n {account_name}

Show a target account filtering on a specific property.

az iot du account show -n {account_name} --query identity

Required Parameters

--account -n

Device Update account name. You can configure the default account name using az config set defaults.adu_account=<name>.

Optional Parameters

--resource-group -g

Device Update account resource group name. You can configure the default group using az config set defaults.adu_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 iot du account update

Update a Device Update account.

Currently the following account properties can be updated - identity, publicNetworkAccess and tags.

az iot du account update --account
                         [--add]
                         [--force-string]
                         [--no-wait]
                         [--remove]
                         [--resource-group]
                         [--set]

Examples

Set a specific account tag attribute.

az iot du account update -n {account_name} --set tags.env='test'

Disable public network access.

az iot du account update -n {account_name} --set publicNetworkAccess='Disabled'

Required Parameters

--account -n

Device Update account name. You can configure the default account name using az config set defaults.adu_account=<name>.

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

default value: []
--force-string

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

default value: False
--no-wait

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

default value: False
--remove

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

default value: []
--resource-group -g

Device Update account resource group name. You can configure the default group using az config set defaults.adu_group=<name>.

--set

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

default value: []
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 iot du account wait

Block until a desired account resource state has been met.

az iot du account wait --account
                       [--created]
                       [--custom]
                       [--deleted]
                       [--exists]
                       [--interval]
                       [--resource-group]
                       [--timeout]
                       [--updated]

Examples

Block until an account resource has finished updating.

az iot du account wait -n {account_name} -g {resource_group} --updated

Required Parameters

--account -n

Device Update account name. You can configure the default account name using az config set defaults.adu_account=<name>.

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

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--interval

Polling interval in seconds.

default value: 30
--resource-group -g

Device Update account resource group name. You can configure the default group using az config set defaults.adu_group=<name>.

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