reference-index.yml

### YamlMime:AzureCLIGroup
uid: az
name: az
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.
status: GA
sourceType: Core and Extension
directCommands:
- uid: az_configure
  name: az configure
  summary: |-
    Manage Azure CLI configuration. This command is interactive.
  description: |-
    For automation scenarios or to set all available options, use the new `az config`.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/configure/_help.py
  syntax: >-
    az configure [--defaults]
                 [--list-defaults {false, true}]
                 [--scope {global, local}]
  examples:
  - summary: |-
      Set default resource group, webapp and VM names.
    syntax: az configure --defaults group=myRG web=myweb vm=myvm
  - summary: |-
      Clear default webapp and VM names.
    syntax: az configure --defaults vm='' web=''
  optionalParameters:
  - name: --defaults -d
    summary: |-
      Space-separated 'name=value' pairs for common argument defaults.
  - name: --list-defaults -l
    parameterValueGroup: "false, true"
    summary: |-
      List all applicable defaults.
  - name: --scope
    defaultValue: "global"
    parameterValueGroup: "global, local"
    summary: |-
      Scope of defaults. Using "local" for settings only effective under current folder.
- uid: az_feedback
  name: az feedback
  summary: |-
    Send feedback to the Azure CLI Team.
  description: |-
    This command is interactive. If possible, it launches the default web browser to open GitHub issue creation page with the body auto-generated and pre-filled. You will have a chance to edit the issue body before submitting it.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/feedback/_help.py
  syntax: az feedback
- uid: az_find
  name: az find
  summary: |-
    I'm an AI robot, my advice is based on our Azure documentation as well as the usage patterns of Azure CLI and Azure ARM users. Using me improves Azure products and documentation.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/find/_help.py
  syntax: az find [<CLI_TERM>]
  examples:
  - summary: |-
      Give me any Azure CLI group and I&rsquo;ll show the most popular commands within the group.
    syntax: az find "az storage"
  - summary: |-
      Give me any Azure CLI command and I&rsquo;ll show the most popular parameters and subcommands.
    syntax: az find "az monitor activity-log list"
  - summary: |-
      You can also enter a search term, and I'll try to help find the best commands.
    syntax: az find "arm template"
  optionalParameters:
  - name: <CLI_TERM>
    summary: |-
      An Azure CLI command or group for which you need an example.
- uid: az_init
  name: az init
  summary: |-
    It's an effortless setting up tool for configs.
  status: Experimental
  isExperimental: true
  previewOrExperimentalInfo: 'This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus'
  sourceType: Extension
  syntax: az init
- uid: az_interactive
  name: az interactive
  summary: |-
    Start interactive mode. Installs the Interactive extension if not installed already.
  description: |-
    For more information on interactive mode, see: https://azure.microsoft.com/blog/welcome-to-azure-cli-shell/.
  status: Preview
  isPreview: true
  previewOrExperimentalInfo: 'This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus'
  sourceType: Core
  syntax: >-
    az interactive [--style {bg, br, contrast, default, grey, halloween, neon, none, pastel, primary, purple, quiet}]
                   [--update]
  optionalParameters:
  - name: --style -s
    parameterValueGroup: "bg, br, contrast, default, grey, halloween, neon, none, pastel, primary, purple, quiet"
    summary: |-
      The colors of the shell.
  - name: --update
    summary: |-
      Update the Interactive extension to the latest available.
- uid: az_login
  name: az login
  summary: |-
    Log in to Azure.
  description: |-
    By default, this command logs in with a user account. Azure CLI uses Web Account Manager (WAM) on Windows, and browser-based login on Linux and macOS by default. If WAM or a web browser is not available, Azure CLI will fall back to device code login.

    [WARNING] Authentication with username and password in the command line is strongly discouraged. Use one of the recommended authentication methods based on your requirements. For more details, see https://go.microsoft.com/fwlink/?linkid=2276314

    [WARNING] `--password` no longer accepts a service principal certificate. Use `--certificate` to pass a service principal certificate.

    To log in with a service principal, specify --service-principal.

    To log in with a managed identity, specify --identity.

    For more details, see https://learn.microsoft.com/cli/azure/authenticate-azure-cli.
  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 login [--allow-no-subscriptions]
             [--certificate]
             [--client-id]
             [--federated-token]
             [--identity]
             [--object-id]
             [--password]
             [--resource-id]
             [--scope]
             [--service-principal]
             [--tenant]
             [--use-cert-sn-issuer]
             [--use-device-code]
             [--username]
  examples:
  - summary: |-
      Log in interactively.
    syntax: az login
  - summary: |-
      Log in with username and password. This doesn't work with Microsoft accounts or accounts that have two-factor authentication enabled. Use -p=secret if the first character of the password is '-'.
    syntax: az login --username johndoe@contoso.com --password VerySecret
  - summary: |-
      Log in with a service principal using client secret. Use --password=secret if the first character of the password is '-'.
    syntax: az login --service-principal --username APP_ID --password CLIENT_SECRET --tenant TENANT_ID
  - summary: |-
      Log in with a service principal using certificate.
    syntax: az login --service-principal --username APP_ID --certificate /path/to/cert.pem --tenant TENANT_ID
  - summary: |-
      Log in with a system-assigned managed identity.
    syntax: az login --identity
  - summary: |-
      Log in with a user-assigned managed identity's client ID.
    syntax: az login --identity --client-id 00000000-0000-0000-0000-000000000000
  - summary: |-
      Log in with a user-assigned managed identity's resource ID.
    syntax: az login --identity --resource-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MyIdentity
  optionalParameters:
  - name: --allow-no-subscriptions
    defaultValue: "False"
    summary: |-
      Support accessing tenants without subscriptions. It's useful to run tenant-level commands, such as 'az ad'.
  - name: --certificate
    summary: |-
      PEM file with key and public certificate.
  - name: --client-id
    summary: |-
      Client ID of the user-assigned managed identity.
  - name: --federated-token
    summary: |-
      Federated token that can be used for OIDC token exchange.
  - name: --identity -i
    defaultValue: "False"
    summary: |-
      Log in using managed identity.
  - name: --object-id
    summary: |-
      Object ID of the user-assigned managed identity.
  - name: --password -p
    summary: |-
      User password or service principal secret. Will prompt if not given.
  - name: --resource-id
    summary: |-
      Resource ID of the user-assigned managed identity.
  - name: --scope
    summary: |-
      Used in the /authorize request. It can cover only one static resource.
  - name: --service-principal
    summary: |-
      Log in with a service principal.
  - name: --tenant -t
    summary: |-
      The Microsoft Entra tenant, must be provided when using a service principal.
  - name: --use-cert-sn-issuer
    summary: |-
      Use Subject Name + Issuer (SN+I) authentication in order to support automatic certificate rolls.
  - name: --use-device-code
    defaultValue: "False"
    summary: |-
      Use device code flow. Azure CLI will also use this if it can't launch a browser, e.g. in remote SSH or Cloud Shell.
  - name: --username -u
    summary: |-
      User name, service principal client ID, or managed identity ID.
- uid: az_logout
  name: az logout
  summary: |-
    Log out to remove access to Azure subscriptions.
  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 logout [--username]
  optionalParameters:
  - name: --username
    summary: |-
      Account user, if missing, logout the current active account.
- uid: az_next
  name: az next
  summary: |-
    Recommend the possible next set of commands to take.
  description: |-
    There are some custom configurations:

    [1] az config set next.execute_in_prompt=True/False
        Turn on/off the step of executing recommended commands in interactive mode. Turn on by default.

    [2] az config set next.recommended_type=all/scenario/command
        Set the default recommended type. All is the default.

    [3] az config set next.output=json/jsonc/none/table/tsv/yaml/yamlc/status
        Set default output format. Status is the default.

    [4] az config set next.command_num_limit={command_amount_limit}
        Set the limit of recommended command items. 5 is the default.

    [5] az config set next.scenario_num_limit={scenario_amount_limit}
        Set the limit of recommended scenario items. 5 is the default.

    [6] az config set next.show_arguments=True/False
        Show/hide the arguments of recommended items. False is the default.

    [7] az config set next.print_help=True/False
        Enable/disable whether to print help actively before executing each command. False is the default.
  status: Experimental
  isExperimental: true
  previewOrExperimentalInfo: 'This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus'
  sourceType: Extension
  syntax: >-
    az next [--command]
            [--scenario]
  optionalParameters:
  - name: --command -c
    defaultValue: "False"
    summary: |-
      Specify this parameter will only recommend commands.
  - name: --scenario -s
    defaultValue: "False"
    summary: |-
      Specify this parameter will only recommend E2E scenarios.
- uid: az_rest
  name: az rest
  summary: |-
    Invoke a custom request.
  description: |-
    This command automatically authenticates using the logged-in credential: If Authorization header is not set, it attaches header `Authorization: Bearer <token>`, where `<token>` is retrieved from AAD. The target resource of the token is derived from --url if --url starts with an endpoint from `az cloud show --query endpoints`. You may also use --resource for a custom resource.

    If Content-Type header is not set and --body is a valid JSON string, Content-Type header will default to application/json.

    For passing JSON in PowerShell, see https://github.com/Azure/azure-cli/blob/dev/doc/quoting-issues-with-powershell.md.
  status: GA
  sourceType: Core
  syntax: >-
    az rest --uri
            [--body]
            [--headers]
            [--method {delete, get, head, options, patch, post, put}]
            [--output-file]
            [--resource]
            [--skip-authorization-header]
            [--uri-parameters]
  examples:
  - summary: |-
      Get Audit log through Microsoft Graph
    syntax: az rest --method get --url https://graph.microsoft.com/beta/auditLogs/directoryAudits
  - summary: |-
      Update a Azure Active Directory Graph User's display name
    syntax: >-
      (Bash or CMD)

      az rest --method patch --url "https://graph.microsoft.com/v1.0/users/johndoe@azuresdkteam.onmicrosoft.com" --body "{\"displayName\": \"johndoe2\"}"


      (Bash)

      az rest --method patch --url "https://graph.microsoft.com/v1.0/users/johndoe@azuresdkteam.onmicrosoft.com" --body '{"displayName": "johndoe2"}'


      (PowerShell)

      az rest --method patch --url "https://graph.microsoft.com/v1.0/users/johndoe@azuresdkteam.onmicrosoft.com" --body '{\"displayName\": \"johndoe2\"}'
  - summary: |-
      Get a virtual machine
    syntax: az rest --method get --uri /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}?api-version=2019-03-01
  - summary: |-
      Create a public IP address from body.json file
    syntax: az rest --method put --url https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}?api-version=2019-09-01 --body @body.json
  - summary: |-
      List the top three resources (Bash)
    syntax: az rest --method get --url https://management.azure.com/subscriptions/{subscriptionId}/resources?api-version=2019-07-01 --url-parameters \$top=3
  requiredParameters:
  - isRequired: true
    name: --uri --url -u
    summary: |-
      Request URL. If it doesn't start with a host, CLI assumes it as an Azure resource ID and prefixes it with the ARM endpoint of the current cloud shown by `az cloud show --query endpoints.resourceManager`. Common token {subscriptionId} will be replaced with the current subscription ID specified by `az account set`.
  optionalParameters:
  - name: --body -b
    summary: |-
      Request body. Use @{file} to load from a file. For quoting issues in different terminals, see https://github.com/Azure/azure-cli/blob/dev/doc/use_cli_effectively.md#quoting-issues.
  - name: --headers
    summary: |-
      Space-separated headers in KEY=VALUE format or JSON string. Use @{file} to load from a file.
  - name: --method -m
    defaultValue: "get"
    parameterValueGroup: "delete, get, head, options, patch, post, put"
    summary: |-
      HTTP request method.
  - name: --output-file
    summary: |-
      Save response payload to a file.
  - name: --resource
    summary: |-
      Resource url for which CLI should acquire a token from AAD in order to access the service. The token will be placed in the Authorization header. By default, CLI can figure this out based on --url argument, unless you use ones not in the list of "az cloud show --query endpoints".
  - name: --skip-authorization-header
    defaultValue: "False"
    summary: |-
      Do not auto-append Authorization header.
  - name: --uri-parameters --url-parameters
    summary: |-
      Query parameters in the URL. Space-separated queries in KEY=VALUE format or JSON string. Use @{file} to load from a file.
- uid: az_survey
  name: az survey
  summary: |-
    Take Azure CLI survey.
  description: |-
    Help us improve Azure CLI by sharing your experience. This survey should take about 3 minutes. Learn more at https://go.microsoft.com/fwlink/?linkid=2203309.
  status: GA
  sourceType: Core
  syntax: az survey
- uid: az_upgrade
  name: az upgrade
  summary: |-
    Upgrade Azure CLI and extensions.
  status: Preview
  isPreview: true
  previewOrExperimentalInfo: 'This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus'
  sourceType: Core
  syntax: >-
    az upgrade [--all {false, true}]
               [--allow-preview {false, true}]
               [--yes]
  optionalParameters:
  - name: --all
    defaultValue: "true"
    parameterValueGroup: "false, true"
    summary: |-
      Enable updating extensions as well.
  - name: --allow-preview --allow-preview-extensions
    parameterValueGroup: "false, true"
    summary: |-
      Include preview packages for extension installation, if exists.
  - name: --yes -y
    summary: |-
      Do not prompt for checking release notes.
- uid: az_version
  name: az version
  summary: |-
    Show the versions of Azure CLI modules and extensions in JSON format by default or format configured by --output.
  status: GA
  sourceType: Core
  syntax: az version
commands:
- az_acat
- az_account
- az_acr
- az_ad
- az_advisor
- az_afd
- az_ai-examples
- az_aks
- az_aksarc
- az_akshybrid
- az_alerts-management
- az_alias
- az_amlfs
- az_ams
- az_aosm
- az_apic
- az_apim
- az_appconfig
- az_appservice
- az_arc-multicloud
- az_arcappliance
- az_arcdata
- az_arcgateway
- az_aro
- az_artifacts
- az_astronomer
- az_attestation
- az_automanage
- az_automation
- az_azurestackhci
- az_backup
- az_baremetalinstance
- az_baremetalstorageinstance
- az_batch
- az_bicep
- az_billing
- az_billing-benefits
- az_blueprint
- az_boards
- az_bot
- az_cache
- az_capacity
- az_cdn
- az_change-analysis
- az_cli-translator
- az_cloud
- az_cloud-service
- az_cognitiveservices
- az_command-change
- az_communication
- az_compute-fleet
- az_compute-recommender
- az_confcom
- az_confidentialledger
- az_config
- az_configure
- az_confluent
- az_connectedk8s
- az_connectedmachine
- az_connectedvmware
- az_connection
- az_consumption
- az_container
- az_containerapp
- az_cosmosdb
- az_costmanagement
- az_csvmware
- az_custom-providers
- az_customlocation
- az_data-boundary
- az_databox
- az_databoxedge
- az_databricks
- az_datadog
- az_datafactory
- az_datamigration
- az_dataprotection
- az_datashare
- az_dedicated-hsm
- az_deployment
- az_deployment-scripts
- az_desktopvirtualization
- az_devcenter
- az_devops
- az_disk
- az_disk-access
- az_disk-encryption-set
- az_disk-pool
- az_dls
- az_dms
- az_dnc
- az_dns-resolver
- az_dt
- az_durabletask
- az_dynatrace
- az_edge-zones
- az_edgeorder
- az_elastic
- az_elastic-san
- az_eventgrid
- az_eventhubs
- az_extension
- az_fabric
- az_feature
- az_feedback
- az_find
- az_firmwareanalysis
- az_fleet
- az_fluid-relay
- az_footprint
- az_functionapp
- az_fzf
- az_gallery
- az_grafana
- az_graph
- az_graph-services
- az_group
- az_guestconfig
- az_hack
- az_hanainstance
- az_hdinsight
- az_hdinsight-on-aks
- az_healthbot
- az_healthcareapis
- az_hpc-cache
- az_identity
- az_image
- az_import-export
- az_informatica
- az_init
- az_interactive
- az_internet-analyzer
- az_iot
- az_k8s-configuration
- az_k8s-extension
- az_k8s-runtime
- az_keyvault
- az_kusto
- az_lab
- az_large-instance
- az_large-storage-instance
- az_load
- az_lock
- az_logic
- az_logicapp
- az_login
- az_logout
- az_maintenance
- az_managed-cassandra
- az_managedapp
- az_managedservices
- az_managementpartner
- az_maps
- az_mariadb
- az_mcc
- az_mdp
- az_mesh
- az_ml
- az_ml[v1]
- az_mobile-network
- az_monitor
- az_mysql
- az_neon
- az_netappfiles
- az_network
- az_network-analytics
- az_network-function
- az_networkcloud
- az_networkfabric
- az_new-relic
- az_next
- az_nexusidentity
- az_nginx
- az_notification-hub
- az_offazure
- az_oracle-database
- az_orbital
- az_palo-alto
- az_partnercenter
- az_peering
- az_pipelines
- az_playwright-testing
- az_policy
- az_portal
- az_postgres
- az_powerbi
- az_ppg
- az_private-link
- az_provider
- az_providerhub
- az_purview
- az_quantum
- az_qumulo
- az_quota
- az_redis
- az_redisenterprise
- az_relay
- az_remote-rendering-account
- az_repos
- az_reservations
- az_resource
- az_resource-mover
- az_resourcemanagement
- az_rest
- az_restore-point
- az_role
- az_sapmonitor
- az_scenario
- az_scvmm
- az_search
- az_security
- az_self-help
- az_sentinel
- az_serial-console
- az_servicebus
- az_sf
- az_sig
- az_signalr
- az_site-recovery
- az_snapshot
- az_spatial-anchors-account
- az_sphere
- az_spring
- az_spring-cloud
- az_sql
- az_ssh
- az_sshkey
- az_stack
- az_stack-hci
- az_stack-hci-vm
- az_standby-container-group-pool
- az_standby-vm-pool
- az_staticwebapp
- az_storage
- az_storage-actions
- az_storage-mover
- az_storagesync
- az_stream-analytics
- az_support
- az_survey
- az_synapse
- az_tag
- az_term
- az_terraform
- az_trustedsigning
- az_ts
- az_tsi
- az_upgrade
- az_version
- az_vm
- az_vmss
- az_vmware
- az_webapp
- az_webpubsub
- az_workloads
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: {}