Azure CLI

Microsoft Azure CLI

优秀的云服务需要优秀的工具；我们很高兴推出 Azure CLI，这是面向 Azure 的新一代多平台命令行体验。

现在就从 Azure Cloud Shell 开始试用！

安装

详细安装说明请参阅安装指南。

常见安装问题及其解决方法请参阅安装故障排除。

开发者安装（见下文）

• Docker
• Edge Builds
• 开发者设置

使用方法

$ az [ group ] [ subgroup ] [ command ] {parameters}

快速入门

详细说明请参阅“快速入门”指南。

如需使用说明和帮助内容，请传入 -h 参数，例如：

$ az storage -h
$ az vm create -h

亮点

以下是一些功能和概念，可帮助你充分利用 Azure CLI。

以下示例使用 --output table 格式，你可以使用 az configure 命令更改默认格式。

Tab 补全

我们支持对组、命令和部分参数进行 Tab 补全

# looking up resource group and name
$ az vm show -g [tab][tab]
AccountingGroup   RGOne  WebPropertiesRG

$ az vm show -g WebPropertiesRG -n [tab][tab]
StoreVM  Bizlogic

$ az vm show -g WebPropertiesRG -n Bizlogic

查询

你可以使用 --query 参数和 JMESPath 查询语法自定义输出。

$ az vm list --query "[?provisioningState=='Succeeded'].{ name: name, os: storageProfile.osDisk.osType }"
Name                    Os
----------------------  -------
storevm                 Linux
bizlogic                Linux
demo32111vm             Windows
dcos-master-39DB807E-0  Linux

退出代码

为便于编写脚本，我们会针对不同情况输出特定的退出代码。

退出代码	情况
0	命令运行成功。
1	一般错误；服务器返回错误状态代码、CLI 验证失败等。
2	解析器错误；请检查命令行输入。
3	缺少 ARM 资源；用于通过 show 命令检查资源是否存在。

常见场景及有效使用 Azure CLI 的方法

请参阅有效使用 Azure CLI 的技巧。其中介绍了一些常见场景：

• 输出格式（json、table 或 tsv）
• 将一个命令的值传递给另一个命令
• 异步操作
• 通用更新参数
• 通用资源命令 - az resource
• REST API 命令 - az rest
• 引号问题
• 通过代理工作
• 并发生成

更多示例和代码片段

如需查看更多用法示例，请查看我们的 GitHub 示例仓库或 https://learn.microsoft.com/cli/azure/overview。

在 Visual Studio Code 中编写并运行命令

使用 Azure CLI Tools Visual Studio Code 扩展，你可以创建 .azcli 文件并使用以下功能：

• 为命令及其参数提供 IntelliSense。
• 提供命令代码片段，并自动插入必需参数。
• 在集成终端中运行当前命令。
• 运行当前命令，并在并排显示的编辑器中查看其输出。
• 将鼠标悬停时显示文档。
• 在状态栏中显示当前订阅和默认值。
• 如需为 .ps1 或 .sh 等其他文件类型启用 IntelliSense，请参阅 microsoft/vscode-azurecli#48。

数据收集

本软件可能会收集关于你以及你使用本软件的信息，并将其发送给 Microsoft。Microsoft 可能会使用这些信息来提供服务并改进我们的产品和服务。你可以按照存储库中的说明关闭遥测。本软件中的某些功能还可能允许你和 Microsoft 收集应用程序用户的数据。如果你使用这些功能，则必须遵守适用法律，包括向应用程序用户提供适当的通知，并附上 Microsoft 隐私声明的副本。我们的隐私声明位于 https://go.microsoft.com/fwlink/?LinkID=824704。你可以在帮助文档和我们的隐私声明中了解有关数据收集和使用的更多信息。使用本软件即表示你同意这些做法。

遥测配置

默认情况下，遥测收集处于启用状态。若要选择退出，请运行 az config set core.collect_telemetry=no 将其关闭。

报告问题和提供反馈

如果你在使用该工具时遇到任何错误，请在我们 GitHub 存储库的 Issues 部分提交问题。

若要通过命令行提供反馈，请尝试使用 az feedback 命令。

[Microsoft 内部] 你可以通过 [email protected] 联系开发团队。

开发者安装

Docker

我们维护了一个预配置 Azure CLI 的 Docker 镜像。 请查看我们的 Docker 标签，了解可用版本。

$ docker run -u $(id -u):$(id -g) -v ${HOME}:/home/az -e HOME=/home/az --rm -it mcr.microsoft.com/azure-cli:<version>

Edge 版本

如果你想获取 dev 分支的最新构建，可以使用我们的 “edge” 版本。

你可以通过以下链接下载最新构建：

包	链接
MSI	https://aka.ms/InstallAzureCliWindowsEdge
Ubuntu Bionic Deb	https://aka.ms/InstallAzureCliBionicEdge
Ubuntu Focal Deb	https://aka.ms/InstallAzureCliFocalEdge
Ubuntu Jammy Deb	https://aka.ms/InstallAzureCliJammyEdge
RPM el8	https://aka.ms/InstallAzureCliRpmEl8Edge

在 Windows 上，安装 edge 构建之前，需要先卸载官方版本。（请参阅 https://github.com/Azure/azure-cli/issues/25607#issuecomment-1452855212）

你可以在 Ubuntu Jammy 上使用以下命令安装 edge 构建：

curl --location --silent --output azure-cli_jammy.deb https://aka.ms/InstallAzureCliJammyEdge && dpkg -i azure-cli_jammy.deb

使用 rpm 包在 RHEL 8 或 CentOS Stream 8 上安装 edge 构建：

dnf install -y $(curl --location --silent --output /dev/null --write-out %{url_effective} https://aka.ms/InstallAzureCliRpmEl8Edge)

以下示例展示了如何在虚拟环境中使用 pip3 安装 edge 构建。--upgrade-strategy=eager 选项也会安装依赖项的 edge 构建。

$ python3 -m venv env
$ . env/bin/activate
$ pip3 install --pre azure-cli --extra-index-url https://azurecliprod.blob.core.windows.net/edge --upgrade-strategy=eager

若要升级当前的 edge 构建，请传入 --upgrade 选项。由于软件源会频繁更新，因此也建议使用 --no-cache-dir 选项。

$ pip3 install --upgrade --pre azure-cli --extra-index-url https://azurecliprod.blob.core.windows.net/edge --no-cache-dir --upgrade-strategy=eager

每次将 PR 合并到 dev 分支时，Azure DevOps Pipelines 都会生成 edge 构建。

获取任意提交或 PR 的构建版本

如果你想获取任意提交或 PR 的构建版本，请参阅：

在发布前试用新功能

开发环境设置

如果你想设置开发环境并为 CLI 做出贡献，请参阅：

配置你的计算机

编写命令模块

代码生成

贡献代码

本项目采用了 Microsoft 开源行为准则。

如需了解更多信息，请参阅行为准则常见问题解答，或发送邮件至 [email protected] 联系我们，提出其他问题或意见。

如果你希望成为本项目的活跃贡献者，请按照 Microsoft 开源指南中的说明操作。