az iot du account
Note
This reference is part of the azure-iot extension for the Azure CLI (version 2.46.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
Device Update account name. You can configure the default account name using az config set defaults.adu_account=<name>
.
Device Update account resource group name. You can configure the default group using az config set defaults.adu_group=<name>
.
Optional Parameters
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.
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>
.
Do not wait for the long-running operation to finish.
Indicates if the Device Update account can be accessed from a public network.
Role name or Id the system assigned identity will have.
Space-separated scopes the system assigned identity can access. Cannot be used with --no-wait.
Device Update account SKU.
Resource tags. Property bag in key-value pairs with the following format: a=b c=d.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
Device Update account name. You can configure the default account name using az config set defaults.adu_account=<name>
.
Optional Parameters
Do not wait for the long-running operation to finish.
Device Update account resource group name. You can configure the default group using az config set defaults.adu_group=<name>
.
Skip user prompts. Indicates acceptance of action. Used primarily for automation scenarios. Default: false.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
Device Update account resource group name. You can configure the default group using az config set defaults.adu_group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
Device Update account name. You can configure the default account name using az config set defaults.adu_account=<name>
.
Optional Parameters
Device Update account resource group name. You can configure the default group using az config set defaults.adu_group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
Device Update account name. You can configure the default account name using az config set defaults.adu_account=<name>
.
Optional Parameters
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>
.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Device Update account resource group name. You can configure the default group using az config set defaults.adu_group=<name>
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
Device Update account name. You can configure the default account name using az config set defaults.adu_account=<name>
.
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Polling interval in seconds.
Device Update account resource group name. You can configure the default group using az config set defaults.adu_group=<name>
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.