你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
本文解释了 Azure CLI 术语。 包括语法组件、引用类型和状态。
Azure CLI 语法组件
Azure CLI 语法是组、引用、命令和参数的组合。 通常,完整的引用命令称为命令。
| Azure 服务 | 参考组 | 参考子组 | Command | 完整引用命令 | 参数示例 |
|---|---|---|---|---|---|
| Azure CLI | az config | az config |
--local、--output、-o |
||
| Azure 网络 | az network | application-gateway | 创建 | az network application-gateway create |
--name、--resource-group、--capacity |
| Azure DevOps | az pipelines | 代理 | list | az pipelines agent list |
--pool-id、--agent-name、--demands |
引用子组可以有多个级别,例如 az network application-gateway private-link ip-config add。
| 参照组 | 子组 1 | 子组 2 | 子组 3 | Command |
|---|---|---|---|---|
| 网络 | application-gateway | private-link | ip-config | add |
有关引用命令的完整列表,请参阅引用列表 A - Z。
什么是引用类型?
Azure CLI 命令要么是核心 Azure CLI 服务的一部分,要么是扩展。 扩展是可选加载项。 引用类型确定发布计划、状态和安装方法,如下所述:
| Term | Core | Extension |
|---|---|---|
| References | 是主要 Azure CLI 服务的一部分 | 是必须安装的可选引用命令 |
| Install | 与 MSI 安装程序结合使用 | 单独使用 az extension add |
| Released | 按计划 | 在新功能或更新可用时 |
| Status | 可以是正式版、预览版或已弃用的版本 | 也可以是 GA、预览版或已弃用 |
要获取命令组列表,请运行 az。
# Get list of all command groups
az
有关扩展列表,请使用 az extension list-available --output table 命令。
# Get list of extensions
az extension list-available --output table
Core
发布为 Azure CLI 永久部分的引用被称为核心引用。 所有核心引用都随 Azure CLI 一起安装,不能选择引用的子集。 如果通过 Azure Cloud Shell 运行 Azure CLI,则核心引用始终是最新的。
Extension
扩展未作为 Azure CLI 的一部分提供,而是作为 Azure CLI 命令运行。 一些扩展是 Azure CLI 的永久组成部分,但通常的情况是,使用扩展可以访问预览版和试验版命令。 一个引用组(例如 az iot hub)可以同时包含核心命令和扩展命令。 这里是两个示例:
| 完整引用命令 | 是否核心 | 是扩展 |
|---|---|---|
| 列出 IoT 中心的 az iot hub | yes | |
| az iot 中心任务列表 | yes |
首次使用时,系统会提示你安装扩展。 还可以通过运行 az extension add 命令来安装扩展。
要详细了解扩展引用(包括安装和更新),可参阅将扩展与 Azure CLI 结合使用。 有关扩展引用命令的完整列表,请参阅 Azure CLI 的可用扩展。
什么是引用状态?
无论引用类型如何,Azure CLI 引用都分为三种状态类别: 正式 版(正式发布)、 公共预览 版或 已弃用。 确定稳定性的是引用命令的状态(而非类型)。
| GA | 公共预览 | Deprecated | |
|---|---|---|---|
| Stability | Permanent | 可根据客户反馈更改。 需遵守 Microsoft Azure 预览版的条款。 | 将被删除。 |
Note
指示 公共预览版 或 已弃用 的警告是 Azure CLI 命令输出的一部分,应为预期。
单个引用的大多数命令和参数都有单个状态,但情况并不总是如此。 正在构建以提供更多命令的 GA 引用可以同时包含 GA 和预览参考命令。 随着添加新参数来增加功能,一个命令也可具有属于不同状态类别的参数。 下面是具有不同状态的示例引用:
| 完整引用命令 | Parameters | 类型 | GA | 公共预览 | Deprecated |
|---|---|---|---|---|---|
az network dns zone list |
All | Core | yes | ||
az network dns zone create |
--name、--resource-group、--if-none-match、--parent-name |
Core | yes | ||
--existingParameter5 |
Core | yes | |||
--newParameter6 |
Core | yes | |||
az network vhub list |
All | Extension | yes | ||
az network vhub create |
--address-prefix、--name、--resource-group、-vwan、--location、--sku |
Extension | yes | ||
--existingParameter7 |
Extension | yes | |||
--newParameter8 |
Extension | yes | |||
az network firewall create |
All | Extension | yes |
上表只是一个示例,不表示当前引用状态 az network。