account.yml

### YamlMime:AzureCLIGroup
uid: az_iot_du_account
name: az iot du account
extensionInformation: >-
  > [!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](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions.
summary: |-
  Device Update account management.
status: GA
sourceType: Extension
directCommands:
- uid: az_iot_du_account_create
  name: az iot du account create
  summary: |-
    Create a Device Update account.
  description: |-
    This command may also be used to update the state of an existing account.
  status: GA
  sourceType: Extension
  syntax: >-
    az iot du account create --account
                             --resource-group
                             [--assign-identity]
                             [--location]
                             [--no-wait]
                             [--pna {Disabled, Enabled}]
                             [--role]
                             [--scopes]
                             [--sku {Free, Standard}]
                             [--tags]
  examples:
  - summary: |-
      Create a Device Update account in target resource group using the resource group location.
    syntax: az iot du account create -n {account_name} -g {resouce_group}
  - summary: |-
      Create a free sku Device Update account in target resource group with specified location and tags without blocking.
    syntax: az iot du account create -n {account_name} -g {resouce_group} -l westus --tags a=b c=d --sku Free --no-wait
  - summary: |-
      Create a Device Update account in target resource group with a system managed identity.
    syntax: az iot du account create -n {account_name} -g {resouce_group} --assign-identity [system]
  - summary: |-
      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.
    syntax: 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
  - summary: |-
      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.
    syntax: >-
      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"
  requiredParameters:
  - isRequired: true
    name: --account -n
    summary: |-
      Device Update account name. You can configure the default account name using `az config set defaults.adu_account={name}`.
  - isRequired: true
    name: --resource-group -g
    summary: |-
      Device Update account resource group name. You can configure the default group using `az config set defaults.adu_group={name}`.
  optionalParameters:
  - name: --assign-identity
    summary: |-
      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.
  - name: --location -l
    summary: |-
      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}`.
  - name: --no-wait
    defaultValue: "False"
    summary: |-
      Do not wait for the long-running operation to finish.
  - name: --pna --public-network-access
    defaultValue: "Enabled"
    parameterValueGroup: "Disabled, Enabled"
    summary: |-
      Indicates if the Device Update account can be accessed from a public network.
  - name: --role
    defaultValue: "Contributor"
    summary: |-
      Role name or Id the system assigned identity will have.
  - name: --scopes
    summary: |-
      Space-separated scopes the system assigned identity can access. Cannot be used with --no-wait.
  - name: --sku
    defaultValue: "Standard"
    parameterValueGroup: "Free, Standard"
    summary: |-
      Device Update account SKU.
  - name: --tags
    summary: |-
      Resource tags. Property bag in key-value pairs with the following format: a=b c=d.
- uid: az_iot_du_account_delete
  name: az iot du account delete
  summary: |-
    Delete a Device Update account.
  status: GA
  sourceType: Extension
  syntax: >-
    az iot du account delete --account
                             [--no-wait]
                             [--resource-group]
                             [--yes {false, true}]
  examples:
  - summary: |-
      Delete a target account.
    syntax: az iot du account delete -n {account_name}
  - summary: |-
      Delete a target account without confirmation or blocking.
    syntax: az iot du account delete -n {account_name} -y --no-wait
  requiredParameters:
  - isRequired: true
    name: --account -n
    summary: |-
      Device Update account name. You can configure the default account name using `az config set defaults.adu_account={name}`.
  optionalParameters:
  - name: --no-wait
    defaultValue: "False"
    summary: |-
      Do not wait for the long-running operation to finish.
  - name: --resource-group -g
    summary: |-
      Device Update account resource group name. You can configure the default group using `az config set defaults.adu_group={name}`.
  - name: --yes -y
    parameterValueGroup: "false, true"
    summary: |-
      Skip user prompts. Indicates acceptance of action. Used primarily for automation scenarios. Default: false.
- uid: az_iot_du_account_list
  name: az iot du account list
  summary: |-
    List all Device Update accounts in a subscription or resource group.
  status: GA
  sourceType: Extension
  syntax: az iot du account list [--resource-group]
  examples:
  - summary: |-
      List all accounts in a subscription.
    syntax: az iot du account list
  - summary: |-
      List accounts in a subscription that meet filter criteria.
    syntax: az iot du account list --query "[?tags.env == 'test']"
  - summary: |-
      List all accounts in a resource group.
    syntax: az iot du account list -g {resource_group}
  optionalParameters:
  - name: --resource-group -g
    summary: |-
      Device Update account resource group name. You can configure the default group using `az config set defaults.adu_group={name}`.
- uid: az_iot_du_account_show
  name: az iot du account show
  summary: |-
    Show the details of a Device Update account.
  status: GA
  sourceType: Extension
  syntax: >-
    az iot du account show --account
                           [--resource-group]
  examples:
  - summary: |-
      Show a target account.
    syntax: az iot du account show -n {account_name}
  - summary: |-
      Show a target account filtering on a specific property.
    syntax: az iot du account show -n {account_name} --query identity
  requiredParameters:
  - isRequired: true
    name: --account -n
    summary: |-
      Device Update account name. You can configure the default account name using `az config set defaults.adu_account={name}`.
  optionalParameters:
  - name: --resource-group -g
    summary: |-
      Device Update account resource group name. You can configure the default group using `az config set defaults.adu_group={name}`.
- uid: az_iot_du_account_update
  name: az iot du account update
  summary: |-
    Update a Device Update account.
  description: |-
    Currently the following account properties can be updated - identity, publicNetworkAccess and tags.
  status: GA
  sourceType: Extension
  syntax: >-
    az iot du account update --account
                             [--add]
                             [--force-string]
                             [--no-wait]
                             [--remove]
                             [--resource-group]
                             [--set]
  examples:
  - summary: |-
      Set a specific account tag attribute.
    syntax: az iot du account update -n {account_name} --set tags.env='test'
  - summary: |-
      Disable public network access.
    syntax: az iot du account update -n {account_name} --set publicNetworkAccess='Disabled'
  requiredParameters:
  - isRequired: true
    name: --account -n
    summary: |-
      Device Update account name. You can configure the default account name using `az config set defaults.adu_account={name}`.
  optionalParameters:
  - name: --add
    defaultValue: "[]"
    summary: |-
      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>`.
  - name: --force-string
    defaultValue: "False"
    summary: |-
      When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
  - name: --no-wait
    defaultValue: "False"
    summary: |-
      Do not wait for the long-running operation to finish.
  - name: --remove
    defaultValue: "[]"
    summary: |-
      Remove a property or an element from a list.  Example: `--remove property.list <indexToRemove>` OR `--remove propertyToRemove`.
  - name: --resource-group -g
    summary: |-
      Device Update account resource group name. You can configure the default group using `az config set defaults.adu_group={name}`.
  - name: --set
    defaultValue: "[]"
    summary: |-
      Update an object by specifying a property path and value to set.  Example: `--set property1.property2=<value>`.
- uid: az_iot_du_account_wait
  name: az iot du account wait
  summary: |-
    Block until a desired account resource state has been met.
  status: GA
  sourceType: Extension
  syntax: >-
    az iot du account wait --account
                           [--created]
                           [--custom]
                           [--deleted]
                           [--exists]
                           [--interval]
                           [--resource-group]
                           [--timeout]
                           [--updated]
  examples:
  - summary: |-
      Block until an account resource has finished updating.
    syntax: az iot du account wait -n {account_name} -g {resource_group} --updated
  requiredParameters:
  - isRequired: true
    name: --account -n
    summary: |-
      Device Update account name. You can configure the default account name using `az config set defaults.adu_account={name}`.
  optionalParameters:
  - name: --created
    defaultValue: "False"
    summary: |-
      Wait until created with 'provisioningState' at 'Succeeded'.
  - name: --custom
    summary: |-
      Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
  - name: --deleted
    defaultValue: "False"
    summary: |-
      Wait until deleted.
  - name: --exists
    defaultValue: "False"
    summary: |-
      Wait until the resource exists.
  - name: --interval
    defaultValue: "30"
    summary: |-
      Polling interval in seconds.
  - name: --resource-group -g
    summary: |-
      Device Update account resource group name. You can configure the default group using `az config set defaults.adu_group={name}`.
  - name: --timeout
    defaultValue: "3600"
    summary: |-
      Maximum wait in seconds.
  - name: --updated
    defaultValue: "False"
    summary: |-
      Wait until updated with provisioningState at 'Succeeded'.
commands:
- az_iot_du_account_create
- az_iot_du_account_delete
- az_iot_du_account_list
- az_iot_du_account_private-endpoint-connection
- az_iot_du_account_private-endpoint-connection_delete
- az_iot_du_account_private-endpoint-connection_list
- az_iot_du_account_private-endpoint-connection_set
- az_iot_du_account_private-endpoint-connection_show
- az_iot_du_account_private-link-resource
- az_iot_du_account_private-link-resource_list
- az_iot_du_account_show
- az_iot_du_account_update
- az_iot_du_account_wait
globalParameters:
- name: --debug
  summary: |-
    Increase logging verbosity to show all debug logs.
- name: --help -h
  summary: |-
    Show this help message and exit.
- name: --only-show-errors
  summary: |-
    Only show errors, suppressing warnings.
- name: --output -o
  defaultValue: "json"
  parameterValueGroup: "json, jsonc, none, table, tsv, yaml, yamlc"
  summary: |-
    Output format.
- name: --query
  summary: |-
    JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
- name: --subscription
  summary: |-
    Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --verbose
  summary: |-
    Increase logging verbosity. Use --debug for full debug logs.
metadata:
  description: Device Update account management.