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 afd

Manage Azure Front Door.

az ai-examples

Add AI powered examples to help content.

az aks

Manage Azure Kubernetes Services.

az alias

Manage Azure CLI Aliases.

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 arcappliance

Commands to manage an Appliance resource.

az arcdata

Commands for using Azure Arc-enabled data services.

az aro

Manage Azure Red Hat OpenShift clusters.

az artifacts

Manage Azure Artifacts.

az attestation

Manage Microsoft Azure Attestation (MAA).

az automation

Manage Automation.

az backup

Manage Azure Backups.

az baremetalinstance

(PREVIEW) Manage BareMetal Instances.

az batch

Manage Azure Batch.

az batchai

Manage Batch AI resources.

az bicep

Bicep CLI command group.

az billing

Manage Azure Billing.

az blockchain

Manage blockchain.

az blueprint

Commands to manage blueprint.

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 capacity

Manage capacity.

az cdn

Manage Azure Content Delivery Networks (CDNs).

az cli-translator

Translate ARM template or REST API to CLI scripts.

az cloud

Manage registered Azure clouds.

az cloud-service

Manage cloud service (extended support).

az codespace

Manage Visual Studio Codespaces.

az cognitiveservices

Manage Azure Cognitive Services accounts.

az communication

Manage communication service with communication.

az config

Manage Azure CLI configuration.

az configure

Manage Azure CLI configuration. This command is interactive.

az confluent

Manage confluent resources.

az connectedk8s

Commands to manage connected kubernetes clusters.

az connectedmachine

Manage Connected Machine.

az consumption

Manage consumption of Azure resources.

az container

Manage Azure Container Instances.

az cosmosdb

Manage Azure Cosmos DB database accounts.

az costmanagement

Manage cost and billing in Azure.

az csvmware

Manage Azure VMware Solution by CloudSimple.

az customlocation

Commands to Create, Get, List and Delete CustomLocations.

az custom-providers

Commands to manage custom providers.

az databox

Manage databox.

az databoxedge

Support data box edge device and management.

az databricks

Manage databricks workspaces.

az datadog

Manage datadog.

az datafactory

Manage Data Factory.

az dataprotection

Manage Data Protection.

az datashare

Commands to manage datashare.

az dedicated-hsm

Dedicated-hsm to create, update, list, show, and delete HSMs.

az demo

Demos for designing, developing and demonstrating Azure CLI.

az deployment

Manage Azure Resource Manager template deployment at subscription scope.

az deploymentmanager

Create and manage rollouts for your service.

az deployment-scripts

Manage deployment scripts at subscription or resource group scope.

az desktopvirtualization

Manage desktop virtualization.

az devops

Manage Azure DevOps organization level operations.

az disk

Manage Azure Managed Disks.

az disk-access

Manage disk access resources.

az disk-encryption-set

Disk Encryption Set resource.

az disk-pool

Manage Azure disk pool.

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 dnc

Manage Delegated Network.

az dt

Manage Azure Digital Twins solutions & infrastructure.

az eventgrid

Manage Azure Event Grid topics, domains, domain topics, system topics partner topics, event subscriptions, system topic event subscriptions and partner topic event subscriptions.

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 footprint
az functionapp

Manage function apps. To install the Azure Functions Core tools see https://github.com/Azure/azure-functions-core-tools.

az fzf

Commands to select active or default objects via fzf.

az graph

Query the resources managed by Azure Resource Manager.

az group

Manage resource groups and template deployments.

az guestconfig

Manage Guest Configuration.

az hanainstance

(PREVIEW) Manage Azure SAP HANA Instance.

az hdinsight

Manage HDInsight resources.

az healthbot

Manage bot with healthbot.

az healthcareapis

Manage Healthcare Apis.

az hpc-cache

Commands to manage hpc cache.

az identity

Managed Service Identities.

az image

Manage custom virtual machine images.

az import-export

Manage Import Export.

az interactive

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

az internet-analyzer

Commands to manage internet analyzer.

az iot

Manage Internet of Things (IoT) assets.

az k8sconfiguration

Commands to manage Kubernetes configuration.

az k8s-configuration

Commands to manage Kubernetes configuration.

az k8s-extension

Commands to manage Kubernetes Extensions.

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 logic

Manage Logic.

az logicapp

Manage logic apps.

az login

Log in to Azure.

az logout

Log out to remove access to Azure subscriptions.

az maintenance

Manage Maintenance.

az managedapp

Manage template solutions provided and maintained by Independent Software Vendors (ISVs).

az managed-cassandra

Azure Managed Cassandra.

az managedservices

Manage the registration assignments and definitions in Azure.

az managementpartner

Allows the partners to associate a Microsoft Partner Network(MPN) ID to a user or service principal in the customer's Azure directory.

az maps

Manage Azure Maps.

az mariadb

Manage Azure Database for MariaDB servers.

az mesh

(PREVIEW) Manage Azure Service Fabric Mesh Resources.

az ml

Manage Azure Machine Learning resources.

az ml

Manage Machine Learning resources.

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 next

Recommend the possible next set of commands to take.

az notification-hub

Manage Notification Hubs.

az offazure

Manage on-premise resources for migrate.

az openshift

Manage Azure Red Hat OpenShift 3.11 clusters.

az peering

Manage peering.

az pipelines

Manage Azure Pipelines.

az policy

Manage resource policies.

az portal

Manage Portal.

az postgres

Manage Azure Database for PostgreSQL servers.

az powerbi

Manage PowerBI resources.

az ppg

Manage Proximity Placement Groups.

az provider

Manage resource providers.

az providerhub

Manage resources with ProviderHub.

az purview

Manage Purview.

az quantum

Manage Azure Quantum Workspaces and submit jobs to Azure Quantum Providers.

az redis

Manage dedicated Redis caches for your Azure applications.

az redisenterprise

Manage dedicated Redis Enterprise caches for your Azure applications.

az relay

Manage Azure Relay Service namespaces, WCF relays, hybrid connections, and rules.

az remote-rendering-account

Manage remote rendering account with mixed reality.

az repos

Manage Azure Repos.

az reservations

Manage Azure Reservations.

az resource

Manage Azure resources.

az resource-mover

Move resources in Azure.

az rest

Invoke a custom request.

az role

Manage user roles for access control with Azure Active Directory and service principals.

az sapmonitor

(PREVIEW) Manage Azure SAP Monitor.

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 sentinel

Manage Security Insight.

az serial-console

Connent to the Serial Console of a Linux/Windows Virtual Machine or VMSS Instance.

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 spatial-anchors-account

Manage spatial anchor account with mixed reality.

az spring-cloud

Commands to manage Azure Spring Cloud.

az sql

Manage Azure SQL Databases and Data Warehouses.

az ssh

SSH into resources (Azure VMs, etc) using AAD issued openssh certificates.

az sshkey

Manage ssh public key with vm.

az stack-hci

Manage Azure Stack HCI.

az staticwebapp

Manage static apps.

az storage

Manage Azure Cloud Storage resources.

az storagesync

Manage Azure File Sync.

az stream-analytics

Manage Stream Analytics.

az support

Manage Azure support resource.

az synapse

Manage and operate Synapse Workspace, Spark Pool, SQL Pool.

az tag

Tag Management on a resource.

az term

Manage marketplace agreement with marketplaceordering.

az ts

Manage template specs at subscription or resource group scope.

az tsi

Manage Azure Time Series Insights.

az upgrade

Upgrade Azure CLI and extensions.

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 vmware

Commands to manage Azure VMware Solution.

az webapp

Manage web apps.

az webpubsub

Commands to manage Webpubsub.

az configure

Manage Azure CLI configuration. This command is interactive.

For automation scenarios or to set all available options, use the new az config.

az configure [--defaults]
             [--list-defaults {false, true}]
             [--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
--scope

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

accepted values: global, local
default value: global

az feedback

Send feedback to the Azure CLI Team.

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.

az feedback

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 find [<CLI_TERM>]

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

<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 [--style {bg, br, contrast, default, grey, halloween, neon, none, pastel, primary, purple, quiet}]
               [--update]

Optional Parameters

--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

Log in to Azure.

az login [--allow-no-subscriptions]
         [--identity]
         [--password]
         [--scope]
         [--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.

--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.

--scope

Used in the /authorize request. It can cover only one static resource.

--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

Log out to remove access to Azure subscriptions.

az logout [--username]

Optional Parameters

--username

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

az next

Recommend the possible next set of commands to take.

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.filter_type=True/False Turn on/off the step of filtering recommendation type. Turn off by 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.num_limit={amount_limit} Set the limit of recommended items. 5 is the default.

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

[6] az config set next.print_help=True/False Enable/disable whether to print help actively before executing each command. False is the default.

az next

az rest

Invoke a custom request.

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.

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

Examples

Get Audit log through Microsoft Graph

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

Update a Azure Active Directory Graph User's display name

az rest --method patch --url "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 --url https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}?api-version=2019-09-01 --body @body.json

List the top three resources (Bash)

az rest --method get --url https://management.azure.com/subscriptions/{subscriptionId}/resources?api-version=2019-07-01 --url-parameters \$top=3

Required Parameters

--uri --url -u

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.

Optional Parameters

--body -b

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.

--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
--output-file

Save response payload to a file.

--resource

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".

--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 --url-parameters

Query parameters in the URL. 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 [--subscription]

Optional Parameters

--subscription

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

az upgrade

Upgrade Azure CLI and extensions.

az upgrade [--all {false, true}]
           [--subscription]
           [--yes]

Optional Parameters

--all

Enable updating extensions as well.

accepted values: false, true
default value: true
--subscription

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

--yes -y

Do not prompt for checking release notes.

az version

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

az version [--subscription]

Optional Parameters

--subscription

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