az

Commands

az account Manage Azure subscription information.
az acr Manage private registries with Azure Container Registries.
az acs Manage Azure Container Services.
az ad Manage Azure Active Directory Graph entities needed for Role Based Access Control.
az advisor Manage Azure Advisor.
az aks Manage Azure Kubernetes Services.
az ams Manage Azure Media Services resources.
az apim Manage Azure API Management services.
az appconfig Manage App Configurations.
az appservice Manage App Service plans.
az artifacts Manage Azure Artifacts.
az backup Manage Azure Backups.
az batch Manage Azure Batch.
az batchai Manage Batch AI resources.
az billing Manage Azure Billing.
az boards Manage Azure Boards.
az bot Manage Microsoft Azure Bot Service.
az cache Commands to manage CLI objects cached using the `--defer` argument.
az cdn Manage Azure Content Delivery Networks (CDNs).
az cloud Manage registered Azure clouds.
az cognitiveservices Manage Azure Cognitive Services accounts.
az configure Manage Azure CLI configuration. This command is interactive.
az consumption Manage consumption of Azure resources.
az container Manage Azure Container Instances.
az cosmosdb Manage Azure Cosmos DB database accounts.
az deployment Manage Azure Resource Manager template deployment at subscription scope.
az deploymentmanager Create and manage rollouts for your service.
az devops Manage Azure DevOps organization level operations.
az disk Manage Azure Managed Disks.
az disk-encryption-set Disk Encryption Set resource.
az dla Manage Data Lake Analytics accounts, jobs, and catalogs.
az dls Manage Data Lake Store accounts and filesystems.
az dms Manage Azure Data Migration Service (DMS) instances.
az eventgrid Manage Azure Event Grid topics, event subscriptions, domains and domain topics.
az eventhubs Manage Azure Event Hubs namespaces, eventhubs, consumergroups and geo recovery configurations - Alias.
az extension Manage and update CLI extensions.
az feature Manage resource provider features.
az feedback Send feedback to the Azure CLI Team!
az find 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.
az functionapp Manage function apps. To install the Azure Functions Core tools see <a href="https://github.com/Azure/azure-functions-core-tools">https://github.com/Azure/azure-functions-core-tools</a>.
az group Manage resource groups and template deployments.
az hdinsight Manage HDInsight resources.
az identity Managed Service Identities.
az image Manage custom virtual machine images.
az interactive Start interactive mode. Installs the Interactive extension if not installed already.
az iot Manage Internet of Things (IoT) assets.
az iotcentral Manage IoT Central assets.
az keyvault Manage KeyVault keys, secrets, and certificates.
az kusto Manage Azure Kusto resources.
az lab Manage Azure DevTest Labs.
az local-context Manage Local Context.
az lock Manage Azure locks.
az login Log in to Azure.
az logout Log out to remove access to Azure subscriptions.
az managedapp Manage template solutions provided and maintained by Independent Software Vendors (ISVs).
az managedservices Manage the registration assignments and definitions in Azure.
az maps Manage Azure Maps.
az mariadb Manage Azure Database for MariaDB servers.
az monitor Manage the Azure Monitor Service.
az mysql Manage Azure Database for MySQL servers.
az netappfiles Manage Azure NetApp Files (ANF) Resources.
az network Manage Azure Network resources.
az openshift Manage Azure Red Hat OpenShift Services.
az pipelines Manage Azure Pipelines.
az policy Manage resource policies.
az postgres Manage Azure Database for PostgreSQL servers.
az ppg Manage Proximity Placement Groups.
az provider Manage resource providers.
az redis Manage dedicated Redis caches for your Azure applications.
az relay Manage Azure Relay Service namespaces, WCF relays, hybrid connections, and rules.
az repos Manage Azure Repos.
az reservations Manage Azure Reservations.
az resource Manage Azure resources.
az rest Invoke a custom request.
az role Manage user roles for access control with Azure Active Directory and service principals.
az search Manage Azure Search services, admin keys and query keys.
az security Manage your security posture with Azure Security Center.
az self-test Runs a self-test of the CLI.
az servicebus Manage Azure Service Bus namespaces, queues, topics, subscriptions, rules and geo-disaster recovery configuration alias.
az sf Manage and administer Azure Service Fabric clusters.
az sig Manage shared image gallery.
az signalr Manage Azure SignalR Service.
az snapshot Manage point-in-time copies of managed disks, native blobs, or other snapshots.
az sql Manage Azure SQL Databases and Data Warehouses.
az storage Manage Azure Cloud Storage resources.
az tag Manage resource tags.
az version Show the versions of Azure CLI modules and extensions in JSON format by default or format configured by --output.
az vm Manage Linux or Windows virtual machines.
az vmss Manage groupings of virtual machines in an Azure Virtual Machine Scale Set (VMSS).
az webapp Manage web apps.

az configure

Edit

Manage Azure CLI configuration. This command is interactive.

az configure [--defaults]
             [--list-defaults {false, true}]
             [--only-show-errors]
             [--scope {global, local}]

Examples

Set default resource group, webapp and VM names.

az configure --defaults group=myRG web=myweb vm=myvm

Clear default webapp and VM names.

az configure --defaults vm='' web=''

Optional Parameters

--defaults -d

Space-separated 'name=value' pairs for common argument defaults.

--list-defaults -l

List all applicable defaults.

accepted values: false, true
--only-show-errors

Only show errors, suppressing warnings.

--scope

Scope of defaults. Using "local" for settings only effective under current folder.

accepted values: global, local
default value: global

az feedback

Edit

Send feedback to the Azure CLI Team!

az feedback [--only-show-errors]

Optional Parameters

--only-show-errors

Only show errors, suppressing warnings.

az find

Edit

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.

az find [--only-show-errors]
        []

Examples

Give me any Azure CLI group and I’ll show the most popular commands within the group.

az find "az storage"

Give me any Azure CLI command and I’ll show the most popular parameters and subcommands.

az find "az monitor activity-log list"

You can also enter a search term, and I'll try to help find the best commands.

az find "arm template"

Optional Parameters

--only-show-errors

Only show errors, suppressing warnings.

<CLI_TERM>

An Azure CLI command or group for which you need an example.

az interactive

Start interactive mode. Installs the Interactive extension if not installed already.

For more information on interactive mode, see: https://azure.microsoft.com/blog/welcome-to-azure-cli-shell/.

az interactive [--only-show-errors]
               [--style {bg, br, contrast, default, grey, halloween, neon, none, pastel, primary, purple, quiet}]
               [--update]

Optional Parameters

--only-show-errors

Only show errors, suppressing warnings.

--style -s

The colors of the shell.

accepted values: bg, br, contrast, default, grey, halloween, neon, none, pastel, primary, purple, quiet
--update

Update the Interactive extension to the latest available.

az login

Edit

Log in to Azure.

az login [--allow-no-subscriptions]
         [--identity]
         [--only-show-errors]
         [--password]
         [--service-principal]
         [--tenant]
         [--use-cert-sn-issuer]
         [--use-device-code]
         [--username]

Examples

Log in interactively.

az login

Log in with user name 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 '-'.

az login -u johndoe@contoso.com -p VerySecret

Log in with a service principal using client secret. Use -p=secret if the first character of the password is '-'.

az login --service-principal -u http://azure-cli-2016-08-05-14-31-15 -p VerySecret --tenant contoso.onmicrosoft.com

Log in with a service principal using client certificate.

az login --service-principal -u http://azure-cli-2016-08-05-14-31-15 -p ~/mycertfile.pem --tenant contoso.onmicrosoft.com

Log in using a VM's system assigned identity

az login --identity

Log in using a VM's user assigned identity. Client or object ids of the service identity also work

az login --identity -u /subscriptions/<subscriptionId>/resourcegroups/myRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myID

Optional Parameters

--allow-no-subscriptions

Support access tenants without subscriptions. It's uncommon but useful to run tenant level commands, such as 'az ad'.

--identity -i

Log in using the Virtual Machine's identity.

--only-show-errors

Only show errors, suppressing warnings.

--password -p

Credentials like user password, or for a service principal, provide client secret or a pem file with key and public certificate. Will prompt if not given.

--service-principal

The credential representing a service principal.

--tenant -t

The AAD tenant, must provide when using service principals.

--use-cert-sn-issuer

Used with a service principal configured with Subject Name and Issuer Authentication in order to support automatic certificate rolls.

--use-device-code

Use CLI's old authentication flow based on device code. CLI will also use this if it can't launch a browser in your behalf, e.g. in remote SSH or Cloud Shell.

--username -u

User name, service principal, or managed service identity ID.

az logout

Edit

Log out to remove access to Azure subscriptions.

az logout [--only-show-errors]
          [--username]

Optional Parameters

--only-show-errors

Only show errors, suppressing warnings.

--username

Account user, if missing, logout the current active account.

az rest

Invoke a custom request.

az rest --uri
        [--body]
        [--headers]
        [--method {delete, get, head, options, patch, post, put}]
        [--only-show-errors]
        [--output-file]
        [--resource]
        [--skip-authorization-header]
        [--subscription]
        [--uri-parameters]

Examples

Get Audit log through Microsoft Graph

az rest --method get --uri https://graph.microsoft.com/beta/auditLogs/directoryAudits

Update a Azure Active Directory Graph User's display name

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

Get a virtual machine

az rest --method get --uri /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}?api-version=2019-03-01

Create a public IP address from body.json file

az rest --method put --uri https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}?api-version=2019-09-01 --body @body.json

Required Parameters

--uri -u

Request uri. For uri without host, CLI will assume "https://management.azure.com/". Common token '{subscriptionId}' will be replaced with the current subscription ID specified by 'az account set'.

Optional Parameters

--body -b

Request body. Use @{file} to load from a file.

--headers

Space-separated headers in KEY=VALUE format or JSON string. Use @{file} to load from a file.

--method -m

HTTP request method.

accepted values: delete, get, head, options, patch, post, put
default value: get
--only-show-errors

Only show errors, suppressing warnings.

--output-file

Save response payload to a file.

--resource

Resource url for which CLI should acquire a token 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".

--skip-authorization-header

Do not auto append "Authorization" header.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--uri-parameters

Space-separated queries in KEY=VALUE format or JSON string. Use @{file} to load from a file.

az self-test

Runs a self-test of the CLI.

az self-test [--only-show-errors]
             [--subscription]

Optional Parameters

--only-show-errors

Only show errors, suppressing warnings.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az version

Show the versions of Azure CLI modules and extensions in JSON format by default or format configured by --output.

az version [--only-show-errors]
           [--subscription]

Optional Parameters

--only-show-errors

Only show errors, suppressing warnings.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.