你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

az

命令

az account

管理 Azure 订阅信息。

az acr

使用 Azure 容器注册表管理专用注册表。

az acs

管理 Azure 容器服务。

az ad

管理基于角色访问控制所需的 Azure Active Directory Graph 实体。

az advisor

管理 Azure 顾问。

az afd

管理 Azure Front Door 标准版/高级版。 有关经典 Azure Front Door,请参阅 https://docs.microsoft.com/en-us/cli/azure/network/front-door?view=azure-cli-latest

az ai-examples

向帮助内容添加 AI 支持的示例。

az aks

管理 Azure Kubernetes 服务。

az alias

管理 Azure CLI 别名。

az ams

管理 Azure 媒体服务资源。

az apim

管理 Azure API 管理服务。

az appconfig

管理应用配置。

az appservice

管理应用服务计划。

az arcappliance

用于管理设备资源的命令。

az arcdata

用于使用已启用 Azure Arc 的数据服务的命令。

az aro

管理 Azure Red Hat OpenShift 群集。

az artifacts

管理 Azure Artifacts。

az attestation

管理 Microsoft Azure 证明 (MAA) 。

az automation

自动化帐户。

az azurestackhci

管理 azurestackhci。

az backup

管理 Azure 备份。

az baremetalinstance

(预览版) 管理 BareMetal 实例。

az batch

管理Azure Batch。

az batchai

管理 Batch AI 资源。

az bicep

Bicep CLI 命令组。

az billing

管理 Azure 计费。

az blockchain

管理区块链。

az blueprint

用于管理蓝图的命令。

az boards

管理 Azure Boards。

az bot

管理 Microsoft Azure 机器人服务。

az cache

用于管理使用参数缓存的 --defer CLI 对象的命令。

az capacity

管理容量。

az cdn

管理 Azure 内容分发网络 (CDN) 。

az change-analysis

列出资源的更改。

az cli-translator

将 ARM 模板或 REST API 转换为 CLI 脚本。

az cloud

管理已注册的 Azure 云。

az cloud-service

管理云服务 (扩展支持) 。

az cognitiveservices

管理 Azure 认知服务帐户。

az communication

使用通信管理通信服务。

az confidentialledger

管理机密账本。

az config

管理 Azure CLI 配置。

az configure

管理 Azure CLI 配置。 此命令是交互式的。

az confluent

管理串联资源。

az connectedk8s

用于管理连接的 kubernetes 群集的命令。

az connectedmachine

管理连接的计算机。

az connectedvmware

用于管理连接的 VMware 的命令。

az consumption

管理 Azure 资源的消耗。

az container

管理Azure 容器实例。

az containerapp

管理 Azure 容器应用。

az cosmosdb

管理 Azure Cosmos DB 数据库帐户。

az costmanagement

在 Azure 中管理成本和计费。

az csvmware

管理 Azure VMware Solution by CloudSimple。

az customlocation

用于创建、获取、列出和删除 CustomLocations 的命令。

az custom-providers

用于管理自定义提供程序的命令。

az databox

管理 databox。

az databoxedge

支持 Data Box edge 设备和管理。

az databricks

管理 databricks 工作区。

az datadog

管理 datadog。

az datafactory

管理数据工厂。

az datamigration

管理数据迁移。

az dataprotection

管理数据保护。

az datashare

管理Data Share。

az dedicated-hsm

使用硬件安全模块管理专用 hsm。

az demo

用于设计、开发和演示 Azure CLI 的演示。

az deployment

在订阅范围内管理 Azure 资源管理器模板部署。

az deploymentmanager

为服务创建和管理推出。

az deployment-scripts

在订阅或资源组范围内管理部署脚本。

az desktopvirtualization

管理桌面虚拟化。

az devops

管理 Azure DevOps 组织级别操作。

az disk

管理 Azure 托管磁盘。

az disk-access

管理磁盘访问资源。

az disk-encryption-set

磁盘加密集资源。

az disk-pool

管理 Azure 磁盘池。

az dla

管理Data Lake Analytics帐户、作业和目录。

az dls

管理 Data Lake Store 帐户和文件系统。

az dms

管理 Azure 数据迁移服务 (DMS) 实例。

az dnc

管理委派网络。

az dns-resolver

管理 Dns 解析程序。

az dt

管理 Azure 数字孪生解决方案和基础结构。

az edgeorder

管理边缘订单。

az elastic

管理 Microsoft Elastic。

az eventgrid

管理Azure 事件网格主题、域、域主题、系统主题合作伙伴主题、事件订阅、系统主题事件订阅和合作伙伴主题事件订阅。

az eventhubs

管理Azure 事件中心命名空间、事件中心、使用者组和异地恢复配置 - 别名。

az extension

管理和更新 CLI 扩展。

az feature

管理资源提供程序功能。

az feedback

向 Azure CLI 团队发送反馈。

az find

我是 AI 机器人,我的建议基于我们的 Azure 文档以及 Azure CLI 和 Azure ARM 用户的使用模式。 使用我可改进 Azure 产品和文档。

az fleet

用于管理机群的命令。

az fluid-relay

管理 Fluid Relay。

az footprint
az functionapp

管理函数应用。 若要安装 Azure Functions Core 工具,请参阅https://github.com/Azure/azure-functions-core-tools

az fzf

用于通过 fzf 选择活动对象或默认对象的命令。

az grafana

用于管理 Azure Grafana 实例的命令。

az graph

查询 Azure 资源管理器管理的资源。

az group

管理资源组和模板部署。

az guestconfig

管理来宾配置。

az hack

用于管理通常用于学生黑客的资源的命令。

az hanainstance

(PREVIEW) 管理 Azure SAP HANA 实例。

az hdinsight

管理 HDInsight 资源。

az healthbot

使用 healthbot 管理机器人。

az healthcareapis

管理医疗保健 API。

az hpc-cache

用于管理 hpc 缓存的命令。

az identity

托管标识。

az image

管理自定义虚拟机映像。

az import-export

管理导入导出。

az init

这是一个毫不费力地设置配置工具。

az interactive

启动交互模式。 安装交互式扩展(如果尚未安装)。

az internet-analyzer

用于管理 Internet 分析器的命令。

az iot

管理物联网 (IoT) 资产。

az k8sconfiguration

用于管理 Kubernetes 配置的命令。

az k8s-configuration

用于从 Microsoft.KubernetesConfiguration 管理资源的命令。

az k8s-extension

用于管理 Kubernetes 扩展的命令。

az keyvault

管理 KeyVault 密钥、机密和证书。

az kusto

管理 Azure Kusto 资源。

az lab

管理Azure 开发测试实验室。

az lock

管理 Azure 锁。

az logic

管理逻辑。

az logicapp

管理逻辑应用。

az login

登录 Azure。

az logout

注销以删除对 Azure 订阅的访问权限。

az logz

管理 Microsoft Logz。

az maintenance

管理维护。

az managedapp

管理独立软件供应商提供的模板解决方案, (ISV) 。

az managed-cassandra

Azure 托管 Cassandra。

az managedservices

在 Azure 中管理注册分配和定义。

az managementpartner

允许合作伙伴将 Microsoft 合作伙伴网络 (MPN) ID 关联到客户的 Azure 目录中的用户或服务主体。

az maps

管理 Azure Maps。

az mariadb

管理Azure Database for MariaDB服务器。

az mesh

(预览版) 管理 Azure Service Fabric 网格资源。

az ml

使用 Azure CLI ML 扩展 v2 管理 Azure 机器学习资源。

az ml

使用 Azure CLI ML 扩展 v1 管理 Azure 机器学习资源。

az monitor

管理 Azure Monitor 服务。

az mysql

管理Azure Database for MySQL服务器。

az netappfiles

管理 AZURE NETAPP 文件 (ANF) 资源。

az network

管理 Azure 网络资源。

az network-function

管理网络功能。

az next

建议采用下一组命令。

az nginx

管理 NGINX 部署资源。

az notification-hub

管理通知中心。

az offazure

管理要迁移的本地资源。

az orbital

Azure 轨道地面站即服务 (GSaaS) 。

az peering

管理对等互连。

az pipelines

管理 Azure Pipelines。

az policy

管理资源策略。

az portal

管理门户。

az postgres

管理Azure Database for PostgreSQL服务器。

az powerbi

管理 PowerBI 资源。

az ppg

管理邻近放置组。

az private-link

专用链接关联 CLI 命令组。

az provider

管理资源提供程序。

az providerhub

使用 ProviderHub 管理资源。

az purview

管理 Purview。

az quantum

管理 Azure Quantum 工作区并将作业提交到 Azure Quantum 提供程序。

az quota

管理 Azure 配额扩展 API。

az redis

管理 Azure 应用程序的专用 Redis 缓存。

az redisenterprise

管理 Azure 应用程序的专用 Redis Enterprise 缓存。

az relay

管理 Azure 中继服务命名空间、WCF 中继、混合连接和规则。

az remote-rendering-account

使用混合现实管理远程渲染帐户。

az repos

管理 Azure Repos。

az reservations

管理 Azure 预留。

az resource

管理 Azure 资源。

az resourcemanagement

Resourcemanagement CLI 命令组。

az resource-mover

管理资源移动器服务 API。

az rest

调用自定义请求。

az restore-point

使用 res 管理还原点。

az role

使用 Azure Active Directory 和服务主体管理访问控制的用户角色。

az sapmonitor

(预览版) 管理 Azure SAP Monitor。

az scvmm

用于管理 SCVMM 资源的 Arc 的命令。

az search

管理 Azure 搜索服务、管理密钥和查询密钥。

az security

使用适用于云的 Microsoft Defender 管理安全状况。

az self-test

运行 CLI 的自测试。

az sentinel

管理 Microsoft Sentinel。

az serial-console

连接到 Linux/Windows 虚拟机或 VMSS 实例的串行控制台。

az servicebus

管理Azure 服务总线命名空间、队列、主题、订阅、规则和异地灾难恢复配置别名。

az sf

管理和管理 Azure Service Fabric 群集。

az sig

管理共享映像库。

az signalr

管理Azure SignalR 服务。

az snapshot

管理托管磁盘、本机 blob 或其他快照的时间点副本。

az spatial-anchors-account

使用混合现实管理空间定位点帐户。

az spring

用于管理 Azure Spring Apps 的命令。

az spring-cloud

用于管理 Azure Spring Cloud 的命令。

az sql

管理Azure SQL数据库和数据仓库。

az ssh

使用 AAD 颁发的开放证书通过 SSH 连接到 (azure VM、Arc 服务器等) 的资源。

az sshkey

使用 vm 管理 ssh 公钥。

az stack-hci

管理 Azure Stack HCI。

az staticwebapp

管理静态应用。

az storage

管理 Azure 云存储资源。

az storagesync

管理Azure 文件同步。

az stream-analytics

管理流分析。

az support

管理Azure 支持资源。

az survey

接受 Azure CLI 调查。

az synapse

管理和操作 Synapse 工作区、Spark 池、SQL 池。

az tag

对资源进行标记管理。

az term

使用 marketplaceordering 管理市场协议。

az ts

在订阅或资源组范围内管理模板规格。

az tsi

管理 Azure 时序见解。

az upgrade

升级 Azure CLI 和扩展。

az version

默认情况下,以 JSON 格式显示 Azure CLI 模块和扩展的版本,或按 --output 配置的格式。

az vm

管理 Linux 或 Windows 虚拟机。

az vmss

管理 Azure 虚拟机规模集中虚拟机的分组 (VMSS) 。

az vmware

用于管理Azure VMware 解决方案的命令。

az webapp

管理 Web 应用。

az webpubsub

用于管理 Webpubsub 的命令。

az configure

管理 Azure CLI 配置。 此命令是交互式的。

对于自动化方案或设置所有可用选项,请使用新 az config选项。

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

示例

设置默认资源组、Web 应用和 VM 名称。

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

清除默认 Web 应用和 VM 名称。

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

可选参数

--defaults -d

常见参数默认值的空格分隔的“name=value”对。

--list-defaults -l

列出所有适用的默认值。

接受的值: false, true
--scope

默认值的范围。 仅对当前文件夹下有效的设置使用“local”。

接受的值: global, local
默认值: global

az feedback

向 Azure CLI 团队发送反馈。

此命令是交互式的。 如果可能,它会启动默认 Web 浏览器,打开 GitHub 问题创建页面,其中正文自动生成并预填充。 提交问题正文之前,你将有机会编辑问题正文。

az feedback

az find

我是 AI 机器人,建议基于 Azure 文档以及 Azure CLI 和 Azure ARM 用户的使用模式。 使用我可改进 Azure 产品和文档。

az find [<CLI_TERM>]

示例

给我任何 Azure CLI 组,我将显示组中最受欢迎的命令。

az find "az storage"

给我任何 Azure CLI 命令,我将显示最常用的参数和子命令。

az find "az monitor activity-log list"

还可以输入搜索词,我会尝试帮助查找最佳命令。

az find "arm template"

可选参数

<CLI_TERM>

需要示例的 Azure CLI 命令或组。

az init

这是一个毫不费力地设置配置工具。

az init

az interactive

启动交互模式。 安装 Interactive 扩展(如果尚未安装)。

有关交互模式的详细信息,请参阅: 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]

可选参数

--style -s

shell 的颜色。

接受的值: bg, br, contrast, default, grey, halloween, neon, none, pastel, primary, purple, quiet
--update

将交互式扩展更新为最新的可用扩展。

az login

登录 Azure。

默认情况下,此命令使用用户帐户登录。 CLI 将尝试启动 Web 浏览器以交互方式登录。 如果 Web 浏览器不可用,CLI 将回退到设备代码登录名。 若要使用服务主体登录,请指定 --service-principal。

az login [--allow-no-subscriptions]
         [--federated-token]
         [--identity]
         [--password]
         [--scope]
         [--service-principal]
         [--tenant]
         [--use-cert-sn-issuer]
         [--use-device-code]
         [--username]

示例

以交互方式登录。

az login

使用用户名和密码登录。 这不适用于启用了双重身份验证的 Microsoft 帐户或帐户。 如果密码的第一个字符为“-”,请使用 -p=secret。

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

使用客户端密码使用服务主体登录。 如果密码的第一个字符为“-”,请使用 -p=secret。

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

使用客户端证书使用服务主体登录。

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

使用 VM 的系统分配的托管标识登录。

az login --identity

使用 VM 的用户分配托管标识登录。 服务标识的客户端或对象 ID 也起作用。

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

可选参数

--allow-no-subscriptions

支持在没有订阅的情况下访问租户。 运行租户级命令(如“az ad”)并不常见,但很有用。

--federated-token

可用于 OIDC 令牌交换的联合令牌。

--identity -i

使用虚拟机标识登录。

--password -p

凭据(例如用户密码)或服务主体提供客户端密码或 pem 文件,其中包含密钥和公共证书。 如果未提供,将提示。

--scope

在 /authorize 请求中使用。 它只能涵盖一个静态资源。

--service-principal

表示服务主体的凭据。

--tenant -t

AAD 租户在使用服务主体时必须提供。

--use-cert-sn-issuer

与配置了使用者名称和颁发者身份验证的服务主体一起使用,以支持自动证书滚动更新。

--use-device-code

根据设备代码使用 CLI 的旧身份验证流。 如果 CLI 无法代表你启动浏览器(例如在远程 SSH 或Cloud Shell中)也会使用此 CLI。

--username -u

用户名、服务主体或托管服务标识 ID。

az logout

注销以删除对 Azure 订阅的访问权限。

az logout [--username]

可选参数

--username

帐户用户(如果缺少)注销当前活动帐户。

az next

建议采用下一组命令。

有一些自定义配置:

[1] az config set next.execute_in_prompt=True/False 打开/关闭在交互模式下执行推荐命令的步骤。 默认情况下打开。

[2] az config set next.filter_type=True/False 打开/关闭筛选建议类型的步骤。 默认情况下关闭。

[3] az config set next.output=json/jsonc/none/table/tsv/yaml/yamlc/status Set 默认输出格式。 状态为默认值。

[4] az config set next.num_limit={amount_limit} 设置建议项的限制。 5 是默认值。

[5] az config set next.show_arguments=True/False Show/hide the arguments of recommended items. 默认值是 False。

[6] az config set next.print_help=True/False Enable/disable 是否在执行每个命令之前主动打印帮助。 默认值是 False。

az next

az rest

调用自定义请求。

此命令使用登录凭据自动进行身份验证:如果未设置授权标头,则会附加从 AAD 检索到的<token>标头Authorization: Bearer <token>。 令牌的目标资源派生自 --url if --url 以终结点开头 az cloud show --query endpoints。 还可以对自定义资源使用 --resource。 如果未设置 Content-Type 标头,并且 --body 是有效的 JSON 字符串,则 Content-Type 标头将默认为 application/json。

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

示例

通过 Microsoft Graph 获取审核日志

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

更新 Azure Active Directory Graph 用户的显示名称

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

获取虚拟机

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

从 body.json 文件创建公共 IP 地址

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

列出 Bash) 的前三个 (资源

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

必需参数

--uri --url -u

请求 URL。 如果它不以主机开头,CLI 假定它为 Azure 资源 ID,并使用当前云所示 az cloud show --query endpoints.resourceManager的 ARM 终结点作为前缀。 通用令牌 {subscriptionId} 将替换为指定的 az account set当前订阅 ID。

可选参数

--body -b

请求正文。 使用 @{file} 从文件加载。 有关不同终端中的引用问题,请参阅 https://github.com/Azure/azure-cli/blob/dev/doc/use_cli_effectively.md#quoting-issues

--headers

KEY=VALUE 格式或 JSON 字符串中的空格分隔标头。 使用 @{file} 从文件加载。

--method -m

HTTP 请求方法。

接受的值: delete, get, head, options, patch, post, put
默认值: get
--output-file

将响应有效负载保存到文件。

--resource

CLI 应从 AAD 获取令牌才能访问服务的资源 URL。 令牌将放置在授权标头中。 默认情况下,CLI 可以根据 --url 参数来弄清楚这一点,除非你在“az cloud show --query endpoints”列表中不使用这些参数。

--skip-authorization-header

请勿自动追加授权标头。

--uri-parameters --url-parameters

查询 URL 中的参数。 KEY=VALUE 格式或 JSON 字符串中的空格分隔查询。 使用 @{file} 从文件加载。

az self-test

运行 CLI 的自测试。

az self-test

az survey

接受 Azure CLI 调查。

通过共享你的体验来帮助我们改进 Azure CLI。 此调查大约需要 3 分钟。 更多信息请访问 https://go.microsoft.com/fwlink/?linkid=2203309

az survey

az upgrade

升级 Azure CLI 和扩展。

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

可选参数

--all

同时启用更新扩展。

接受的值: false, true
默认值: true
--yes -y

不要提示检查发行说明。

az version

默认情况下,以 JSON 格式或 --output 配置的格式显示 Azure CLI 模块和扩展的版本。

az version