account.yml

### YamlMime:AzureCLIGroup
uid: az_account
name: az account
importantNote: >-
  > [!NOTE]

  > This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions.
summary: |-
  Manage Azure subscription information.
status: GA
sourceType: Core and Extension
directCommands:
- uid: az_account_accept-ownership-status
  name: az account accept-ownership-status
  summary: |-
    Accept subscription ownership status.
  status: GA
  sourceType: Extension
  syntax: az account accept-ownership-status --subscription-id
  requiredParameters:
  - isRequired: true
    name: --subscription-id
    summary: |-
      Subscription Id. Required.
- uid: az_account_clear
  name: az account clear
  summary: |-
    Clear all subscriptions from the CLI's local cache.
  description: |-
    To clear the current subscription, use 'az logout'.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/profile/_help.py
  syntax: az account clear
- uid: az_account_create
  name: az account create
  summary: |-
    Create a subscription.
  status: Preview
  isPreview: true
  previewOrExperimentalInfo: 'This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus'
  sourceType: Extension
  syntax: >-
    az account create --enrollment-account-name
                      --offer-type {MS-AZR-0017P, MS-AZR-0148P, MS-AZR-USGOV-0015P, MS-AZR-USGOV-0017P, MS-AZR-USGOV-0148P}
                      [--display-name]
                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                      [--owner-object-id]
                      [--owner-spn]
                      [--owner-upn]
  requiredParameters:
  - isRequired: true
    name: --enrollment-account-name --enrollment-account-object-id
    summary: |-
      The name of the enrollment account to which the subscription will be billed.
  - isRequired: true
    name: --offer-type
    parameterValueGroup: "MS-AZR-0017P, MS-AZR-0148P, MS-AZR-USGOV-0015P, MS-AZR-USGOV-0017P, MS-AZR-USGOV-0148P"
    summary: |-
      The offer type of the subscription. For example, MS-AZR-0017P(EnterpriseAgreement) and MS-AZR-0148P(EnterpriseAgreement devTest) are available. Allowed values: MS-AZR-0017P, MS-AZR-0148P, MS-AZR-USGOV-0015P, MS-AZR-USGOV-0017P, MS-AZR-USGOV-0148P.
  optionalParameters:
  - name: --display-name
    summary: |-
      The display name of the subscription.
  - name: --no-wait
    parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
    summary: |-
      Do not wait for the long-running operation to finish.
  - name: --owner-object-id
    summary: |-
      The object id(s) of the owner(s) which should be granted access to the new subscription.
  - name: --owner-spn
    summary: |-
      The service principal name(s) of the owner(s) which should be granted access to the new subscription.
  - name: --owner-upn
    summary: |-
      The user principal name(s) of owner(s) who should be granted access to the new subscription.
- uid: az_account_get-access-token
  name: az account get-access-token
  summary: |-
    Get a token for utilities to access Azure.
  description: |-
    The token will be valid for at least 5 minutes with the maximum at 60 minutes. If the subscription argument isn't specified, the current account is used.

    In the output, `expires_on` represents a POSIX timestamp and `expiresOn` represents a local datetime. It is recommended for downstream applications to use `expires_on` because it is in UTC.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/profile/_help.py
  syntax: >-
    az account get-access-token [--name]
                                [--resource]
                                [--resource-type {aad-graph, arm, batch, data-lake, media, ms-graph, oss-rdbms}]
                                [--scope]
                                [--tenant]
  examples:
  - summary: |-
      Get an access token for the current account
    syntax: az account get-access-token
  - summary: |-
      Get an access token for a specific subscription
    syntax: az account get-access-token --subscription 00000000-0000-0000-0000-000000000000
  - summary: |-
      Get an access token for a specific tenant
    syntax: az account get-access-token --tenant 00000000-0000-0000-0000-000000000000
  - summary: |-
      Get an access token to use with MS Graph API
    syntax: az account get-access-token --resource-type ms-graph
  optionalParameters:
  - name: --name --subscription -n -s
    summary: |-
      Name or ID of subscription.
  - name: --resource
    summary: |-
      Azure resource endpoints in AAD v1.0.
  - name: --resource-type
    parameterValueGroup: "aad-graph, arm, batch, data-lake, media, ms-graph, oss-rdbms"
    summary: |-
      Type of well-known resource.
  - name: --scope
    summary: |-
      Space-separated AAD scopes in AAD v2.0. Default to Azure Resource Manager.
  - name: --tenant -t
    summary: |-
      Tenant ID for which the token is acquired. Only available for user and service principal account, not for MSI or Cloud Shell account.
- uid: az_account_list
  name: az account list
  summary: |-
    Get a list of subscriptions for the logged in account. By default, only 'Enabled' subscriptions from the current cloud is shown.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/profile/_help.py
  syntax: >-
    az account list [--all]
                    [--refresh]
  optionalParameters:
  - name: --all
    defaultValue: "False"
    summary: |-
      List all subscriptions from all clouds, rather than just 'Enabled' ones.
  - name: --refresh
    defaultValue: "False"
    summary: |-
      Retrieve up-to-date subscriptions from server.
- uid: az_account_list-locations
  name: az account list-locations
  summary: |-
    List supported regions for the current subscription.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/profile/_help.py
  syntax: az account list-locations [--include-extended-locations {0, 1, f, false, n, no, t, true, y, yes}]
  optionalParameters:
  - name: --include-extended-locations
    parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
    summary: |-
      Whether to include extended locations.
- uid: az_account_set
  name: az account set
  summary: |-
    Set a subscription to be the current active subscription.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/profile/_help.py
  syntax: az account set --name
  requiredParameters:
  - isRequired: true
    name: --name --subscription -n -s
    summary: |-
      Name or ID of subscription.
- uid: az_account_show
  name: az account show
  summary: |-
    Get the details of a subscription.
  description: |-
    If the subscription isn't specified, shows the details of the default subscription.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/profile/_help.py
  syntax: az account show [--name]
  optionalParameters:
  - name: --name --subscription -n -s
    summary: |-
      Name or ID of subscription.
commands:
- az_account_accept-ownership-status
- az_account_alias
- az_account_alias_create
- az_account_alias_delete
- az_account_alias_list
- az_account_alias_show
- az_account_alias_wait
- az_account_clear
- az_account_create
- az_account_get-access-token
- az_account_list
- az_account_list-locations
- az_account_lock
- az_account_lock_create
- az_account_lock_delete
- az_account_lock_list
- az_account_lock_show
- az_account_lock_update
- az_account_management-group
- az_account_management-group_check-name-availability
- az_account_management-group_create
- az_account_management-group_delete
- az_account_management-group_entities
- az_account_management-group_entities_list
- az_account_management-group_hierarchy-settings
- az_account_management-group_hierarchy-settings_create
- az_account_management-group_hierarchy-settings_delete
- az_account_management-group_hierarchy-settings_list
- az_account_management-group_hierarchy-settings_update
- az_account_management-group_list
- az_account_management-group_show
- az_account_management-group_subscription
- az_account_management-group_subscription_add
- az_account_management-group_subscription_remove
- az_account_management-group_subscription_show
- az_account_management-group_subscription_show-sub-under-mg
- az_account_management-group_tenant-backfill
- az_account_management-group_tenant-backfill_get
- az_account_management-group_tenant-backfill_start
- az_account_management-group_update
- az_account_set
- az_account_show
- az_account_subscription
- az_account_subscription_cancel
- az_account_subscription_enable
- az_account_subscription_list
- az_account_subscription_list-location
- az_account_subscription_rename
- az_account_subscription_show
- az_account_tenant
- az_account_tenant_list
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: Manage Azure subscription information.