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

az

注意

此命令组具有在 Azure CLI 和至少一个扩展中定义的命令。 安装每个扩展,使其受益于其扩展功能。 详细了解扩展。

命令

名称 说明 类型 状态
az account

管理 Azure 订阅信息。

核心和扩展 GA
az acr

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

核心和扩展 GA
az ad

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

核心和扩展 GA
az adp

管理 Azure 自治开发平台资源。

扩展 GA
az advisor

管理 Azure 顾问。

核心 GA
az afd

管理 Azure Front Door 标准版/高级版。

核心 预览
az ai-examples

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

扩展 预览
az aks

管理 Azure Kubernetes 服务。

核心和扩展 GA
az aksarc

管理预配的群集。

扩展 GA
az akshybrid

管理预配的群集。

扩展 预览
az alerts-management

管理 Azure 警报管理服务资源。

扩展 GA
az alias

管理 Azure CLI 别名。

扩展 GA
az amlfs

管理 lustre 文件系统。

扩展 GA
az ams

管理Azure 媒体服务资源。

核心 GA
az aosm

用于与 Azure 操作员服务管理器(AOSM)交互的命令。

扩展 预览
az apic

管理 Azure API 中心服务。

扩展 GA
az apim

管理 Azure API 管理服务。

核心 GA
az appconfig

管理应用程序配置。

核心 GA
az appservice

管理应用服务计划。

核心和扩展 GA
az arcappliance

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

扩展 GA
az arcdata

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

扩展 GA
az aro

管理 Azure Red Hat OpenShift 群集。

核心 GA
az artifacts

管理 Azure Artifacts。

扩展 GA
az astronomer

管理 Azure 天文学家资源。

扩展 GA
az attestation

管理 Microsoft Azure 证明 (MAA)。

扩展 实验
az automanage

管理 Automanage。

扩展 GA
az automation

管理自动化帐户。

扩展 GA
az azurestackhci

管理 azurestackhci。

扩展 实验
az backup

管理Azure 备份。

核心 GA
az baremetalinstance

(预览)管理 BareMetal 实例。

扩展 GA
az batch

管理 Azure Batch。

核心和扩展 GA
az batchai

管理 Batch AI 资源。

核心 已放弃
az bicep

Bicep CLI 命令组。

核心 GA
az billing

管理 Azure 计费。

核心 GA
az billing-benefits

Azure 计费权益命令。

扩展 GA
az blockchain

管理区块链。

扩展 GA
az blueprint

用于管理蓝图的命令。

扩展 GA
az boards

管理 Azure Boards。

扩展 GA
az bot

管理 Microsoft Azure 机器人服务。

核心 GA
az cache

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

核心 GA
az capacity

管理容量。

核心 GA
az cdn

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

核心 GA
az change-analysis

列出资源的更改。

扩展 GA
az cli-translator

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

扩展 实验
az cloud

管理已注册的 Azure 云。

核心 GA
az cloud-service

管理云服务。

扩展 实验
az cognitiveservices

管理 Azure 认知服务帐户。

核心 GA
az command-change

CLI 模块元数据管理的命令。

扩展 GA
az communication

使用通信管理通信服务。

扩展 GA
az confcom

用于为 Azure 中的机密容器生成安全策略的命令。

扩展 GA
az confidentialledger

管理机密账本。

扩展 GA
az config

管理 Azure CLI 配置。

核心 实验
az configure

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

核心 GA
az confluent

管理串联资源。

扩展 实验
az connectedk8s

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

扩展 GA
az connectedmachine

管理已启用 Azure Arc 的服务器。

扩展 GA
az connectedvmware

用于管理连接 VMware 的命令。

扩展 GA
az connection

用于管理服务的命令连接或本地连接,允许本地环境连接 Azure 资源。 如果要管理计算服务的连接,请运行“az webapp/containerapp/spring connection”。

核心和扩展 GA
az consumption

管理 Azure 资源的消耗。

核心 预览
az container

管理Azure 容器实例。

核心和扩展 GA
az containerapp

管理 Azure 容器应用。

核心和扩展 GA
az cosmosdb

管理 Azure Cosmos DB 数据库帐户。

核心和扩展 GA
az costmanagement

Costmanagement。

扩展 GA
az csvmware

管理 Azure VMware Solution by CloudSimple。

扩展 预览
az custom-providers

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

扩展 GA
az customlocation

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

扩展 GA
az databox

管理数据框。

扩展 GA
az databoxedge

支持 Data Box Edge 设备和管理。

核心 预览
az databricks

管理 databricks 工作区。

扩展 GA
az datadog

管理 datadog。

扩展 GA
az datafactory

管理数据工厂。

扩展 GA
az datamigration

管理数据迁移。

扩展 GA
az dataprotection

管理数据保护。

扩展 实验
az datashare

管理 Data Share。

扩展 实验
az dedicated-hsm

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

扩展 GA
az demo

有关设计、开发和演示 Azure CLI 的演示。

核心 已放弃
az deployment

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

核心 GA
az deployment-scripts

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

核心 GA
az desktopvirtualization

管理桌面虚拟化。

扩展 GA
az devcenter

使用开发中心管理资源。

扩展 GA
az devops

管理 Azure DevOps 组织级别操作。

扩展 GA
az disk

管理 Azure 托管磁盘。

核心 GA
az disk-access

管理磁盘访问资源。

核心 GA
az disk-encryption-set

磁盘加密集资源。

核心 GA
az disk-pool

管理 Azure 磁盘池。

扩展 GA
az dla

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

核心 预览
az dls

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

核心 预览
az dms

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

核心和扩展 GA
az dnc

管理委派网络。

扩展 预览
az dns-resolver

管理 Dns 解析程序。

扩展 GA
az dt

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

扩展 GA
az dynatrace

管理动态跟踪。

扩展 GA
az edgeorder

管理 Edge 订单。

扩展 GA
az elastic

管理 Microsoft Elastic。

扩展 GA
az elastic-san

管理弹性 SAN。

扩展 GA
az eventgrid

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

核心和扩展 GA
az eventhubs

Eventhubs。

核心 GA
az extension

管理和更新 CLI 扩展。

核心 GA
az feature

管理资源提供程序功能。

核心 GA
az feedback

向 Azure CLI 团队发送反馈。

核心 GA
az find

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

核心 GA
az firmwareanalysis

用于管理固件分析的命令。

扩展 GA
az fleet

用于管理机群的命令。

扩展 GA
az fluid-relay

管理 Fluid Relay。

扩展 GA
az footprint 扩展 GA
az functionapp

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

核心和扩展 GA
az fzf

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

扩展 GA
az grafana

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

扩展 GA
az graph

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

扩展 GA
az graph-services

对 Microsoft.GraphServices 资源类型执行操作。

扩展 GA
az group

管理资源组和模板部署。

核心 GA
az guestconfig

管理来宾配置。

扩展 GA
az hack

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

扩展 GA
az hanainstance

(预览)管理 Azure SAP HANA 实例。

扩展 GA
az hdinsight

管理 HDInsight 资源。

核心 GA
az hdinsight-on-aks

Aks CLI 上的 HDInsight。

扩展 GA
az healthbot

使用 healthbot 管理机器人。

扩展 实验
az healthcareapis

管理医疗保健 API。

扩展 GA
az hpc-cache

用于管理 hpc 缓存的命令。

扩展 GA
az hybridaks

管理已预配的混合群集。

扩展 预览
az identity

托管标识。

核心 GA
az image

管理自定义虚拟机映像。

核心和扩展 GA
az import-export

管理导入导出。

扩展 实验
az init

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

扩展 实验
az interactive

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

核心 预览
az internet-analyzer

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

扩展 GA
az iot

管理物联网(IoT)资产。

核心和扩展 GA
az k8s-configuration

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

扩展 GA
az k8s-extension

用于管理 Kubernetes 扩展的命令。

扩展 GA
az k8s-runtime

管理 Arc Kubernetes 运行时资源。

扩展 预览
az k8sconfiguration

用于管理 Kubernetes 配置的命令。

扩展 预览和弃用
az keyvault

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

核心 GA
az kusto

管理 Azure Kusto 资源。

核心和扩展 GA
az lab

管理Azure 开发测试实验室。

核心 预览
az large-instance

处理计算 Azure 大型实例的操作。

扩展 GA
az large-storage-instance

处理存储 Azure 大型实例的操作。

扩展 GA
az load

管理 Azure 负载测试资源。

扩展 GA
az lock

管理 Azure 锁。

核心 GA
az logic

管理逻辑。

扩展 GA
az logicapp

管理逻辑应用。

核心 GA
az login

登录到 Azure。

核心 GA
az logout

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

核心 GA
az logz

管理 Microsoft Logz。

扩展 实验
az maintenance

管理维护。

扩展 GA
az managed-cassandra

Azure 托管 Cassandra。

核心和扩展 GA
az managedapp

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

核心 GA
az managedservices

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

核心 GA
az managementpartner

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

扩展 GA
az maps

管理 Azure Maps。

核心 GA
az mariadb

管理 Azure Database for MariaDB 服务器。

核心 GA
az mesh

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

扩展 预览
az ml

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

扩展 GA
az ml

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

扩展 GA
az mobile-network

管理移动网络。

扩展 GA
az monitor

管理 Azure Monitor 服务。

核心和扩展 GA
az mysql

管理 Azure Database for MySQL 服务器。

核心和扩展 GA
az netappfiles

管理Azure NetApp 文档(ANF)资源。

核心和扩展 GA
az network

管理 Azure 网络资源。

核心和扩展 GA
az network-analytics

网络分析命令组 Azure Operator Insights 资源操作。

扩展 GA
az network-function

管理网络功能。

扩展 GA
az networkcloud

管理网络云资源。

扩展 预览
az networkfabric

管理 Azure Network Fabric 管理服务 API。

扩展 GA
az new-relic

管理 Azure NewRelic 资源。

扩展 GA
az next

建议使用下一组命令。

扩展 实验
az nginx

管理 NGINX 部署资源。

扩展 GA
az notification-hub

管理通知中心。

扩展 实验
az offazure

管理要迁移的本地资源。

扩展 实验
az orbital

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

扩展 GA
az palo-alto

管理 palo-alto networks 资源。

扩展 GA
az partnercenter

合作伙伴中心管理。

扩展 GA
az peering

管理对等互连。

扩展 GA
az pipelines

管理 Azure Pipelines。

扩展 GA
az policy

管理资源策略。

核心 GA
az portal

管理门户。

扩展 实验
az postgres

管理 Azure Database for PostgreSQL 服务器。

核心和扩展 GA
az powerbi

管理 PowerBI 资源。

扩展 GA
az ppg

管理邻近放置组。

核心 GA
az private-link

专用链接关联 CLI 命令组。

核心 GA
az provider

管理资源提供程序。

核心 GA
az providerhub

使用 ProviderHub 管理资源。

扩展 GA
az purview

管理 Purview。

扩展 预览
az quantum

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

扩展 预览
az qumulo

管理 qumulo。

扩展 GA
az quota

Azure 资源提供程序的管理配额。

扩展 GA
az redis

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

核心 GA
az redisenterprise

管理 redisenterprise 缓存。

扩展 GA
az relay

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

核心 GA
az remote-rendering-account

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

扩展 GA
az repos

管理 Azure Repos。

扩展 GA
az reservations

Azure 预留。

扩展 预览
az resource

管理 Azure 资源。

核心 GA
az resource-mover

管理资源转移器服务 API。

扩展 GA
az resourcemanagement

Resourcemanagement CLI 命令组。

核心 GA
az rest

调用自定义请求。

核心 GA
az restore-point

使用 res 管理还原点。

核心 GA
az role

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

核心 GA
az sapmonitor

(预览)管理 Azure SAP Monitor。

扩展 GA
az scenario

E2E 方案使用指南。

扩展 GA
az scvmm

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

扩展 GA
az search

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

核心 GA
az security

使用 Microsoft Defender for Cloud 管理安全状况。

核心 GA
az self-help

Azure SelfHelp 将帮助你排查 Azure 资源的问题。

扩展 预览
az self-test

运行 CLI 的自测试。

核心 已放弃
az sentinel

管理 Microsoft Sentinel。

扩展 GA
az serial-console

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

扩展 GA
az servicebus

Servicebus。

核心 GA
az sf

管理和管理 Azure Service Fabric 群集。

核心 GA
az sig

管理共享映像库。

核心和扩展 GA
az signalr

管理Azure SignalR 服务。

核心 GA
az site-recovery

管理 Site Recovery 服务。

扩展 GA
az snapshot

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

核心 GA
az spatial-anchors-account

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

扩展 GA
az sphere

管理 Azure Sphere。

扩展 GA
az spring

用于管理 Azure Spring Apps 的命令。

核心和扩展 GA
az spring-cloud

用于管理 Azure Spring Cloud 的命令。

核心和扩展 已放弃
az sql

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

核心和扩展 GA
az ssh

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

扩展 GA
az sshkey

使用 vm 管理 ssh 公钥。

核心 GA
az stack

部署堆栈是一种本机 Azure 资源类型,可用于将资源集合作为原子单元执行操作。

核心 GA
az stack-hci

管理 Azure Stack HCI。

扩展 GA
az stack-hci-vm

使用 stack-hci-vm 管理 virtualmachine。

扩展 实验
az staticwebapp

管理静态应用。

核心和扩展 GA
az storage

管理 Azure 云存储资源。

核心和扩展 GA
az storage-mover

管理顶级存储 Mover 资源。

扩展 GA
az storagesync

管理Azure 文件同步。

扩展 GA
az stream-analytics

管理流分析。

扩展 GA
az support

管理Azure 支持资源。

扩展 GA
az survey

接受 Azure CLI 调查。

核心 GA
az synapse

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

核心 GA
az tag

对资源进行标记管理。

核心 GA
az term

使用 marketplaceordering 管理市场协议。

核心 实验
az ts

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

核心 GA
az tsi

管理 Azure 时序见解。

扩展 GA
az upgrade

升级 Azure CLI 和扩展。

核心 预览
az version

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

核心 GA
az vm

管理 Linux 或 Windows 虚拟机。

核心和扩展 GA
az vmss

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

核心 GA
az vmware

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

扩展 GA
az webapp

管理 Web 应用。

核心和扩展 GA
az webpubsub

用于管理 Webpubsub 的命令。

扩展 GA
az workloads

管理工作负荷。

扩展 预览

az configure

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

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

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

示例

设置默认资源组、webapp 和 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
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az feedback

向 Azure CLI 团队发送反馈。

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

az feedback
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

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 命令或组。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az init

实验

此命令是实验性的,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

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

az init
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az interactive

预览

此命令处于预览阶段,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

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

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

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

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

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”)并不常见,但很有用。

默认值: False
--federated-token

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

--identity -i

使用虚拟机的标识登录。

默认值: False
--password -p

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

--scope

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

--service-principal

表示服务主体的凭据。

--tenant -t

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

--use-cert-sn-issuer

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

--use-device-code

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

默认值: False
--username -u

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

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az logout

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

az logout [--username]

可选参数

--username

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

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az next

实验

此命令是实验性的,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

建议使用下一组命令。

有一些自定义配置:

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

[2] az config set next.recommended_type=all/scenario/command Set the default recommended type. All 是默认值。

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

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

[5] az config set next.scenario_num_limit={scenario_amount_limit} 设置建议方案项的限制。 5 是默认值。

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

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

az next [--command]
        [--scenario]

可选参数

--command -c

指定此参数将仅推荐命令。

默认值: False
--scenario -s

指定此参数将仅推荐 E2E 方案。

默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az rest

调用自定义请求。

此命令使用登录凭据自动进行身份验证:如果未设置授权标头,则会附加标头 Authorization: Bearer <token>,从 AAD 检索到标头 <token> 。 令牌的目标资源派生自 --url if --url 以终结点开头 az cloud show --query endpoints。 还可以对自定义资源使用 --resource。

如果未设置 Content-Type 标头,并且 --body 是有效的 JSON 字符串,则 Content-Type 标头将默认为 application/json。

有关在 PowerShell 中传递 JSON,请参阅 https://github.com/Azure/azure-cli/blob/dev/doc/quoting-issues-with-powershell.md

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 用户的显示名称

(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\"}'

获取虚拟机

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.resourceManagerARM 终结点作为前缀。 通用令牌 {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,以便访问服务。 令牌将放置在 Authorization 标头中。 默认情况下,CLI 可以根据 --url 参数来弄清楚这一点,除非你未在“az cloud show --query endpoints”列表中使用。

--skip-authorization-header

不要自动追加授权标头。

默认值: False
--uri-parameters --url-parameters

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

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az self-test

已放弃

此命令已弃用,将在将来的版本中删除。

运行 CLI 的自测试。

az self-test
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az survey

接受 Azure CLI 调查。

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

az survey
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az upgrade

预览

此命令处于预览阶段,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

升级 Azure CLI 和扩展。

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

可选参数

--all

同时启用更新扩展。

接受的值: false, true
默认值: true
--allow-preview --allow-preview-extensions

包括用于扩展安装的预览包(如果存在)。

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

不要提示检查发行说明。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az version

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

az version
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。