概觀:Azure CLI 術語和支持層級

本文說明 Azure CLI 術語。 有語法元件、參考類型和狀態。

Azure CLI 語法元件

Azure CLI 語法是群組、參考、命令和參數的組合。 完整參考命令通常稱為 命令

Azure Service 參考群組 參考子群組(s) Command 完整參考命令 參數範例
Azure CLI az config az config --local, --output -o
Azure 網路 az network application-gateway create az network application-gateway create --name, --resource-group, --capacity
Azure DevOps az pipelines 代理程式 清單 az pipelines agent list --pool-id、--agent-name、-demands

參考子群組可以有多個層級,例如az network application-gateway private-link ip-config add

參考群組 子群組 1 子群組 2 子群組 3 Command
network application-gateway private-link ip-config add

如需參考命令的完整清單,請參閱 參考清單 A 到 Z

什麼是參考類型?

Azure CLI 命令是核心 Azure CLI 服務的一部分,或是擴充功能。 擴充功能是選擇性附加元件。 參考類型會決定發行排程、狀態和安裝方法,如下所述:

術語 核心 副檔名
參考 屬於主要 Azure CLI 服務的一部分 是必須安裝的選擇性參考命令
安裝 MSI 安裝程式聯合 使用 az extension add 個別
已發行 在排程上 隨著新功能或更新的推出
狀態 可以是 GA(正式推出)、預覽或已淘汰 也可以是 GA、預覽或已淘汰

若要取得命令群組的清單,請執行 az。 如需延伸模組清單,請使用 az extension list-available --output table 命令。

# Get list of all command groups
az

# Get list of extensions
az extension list-available --output table

核心

已發行為 CLI 永久部分的 Azure CLI 參考稱為 核心參考。 所有核心參考都會隨 Azure CLI 一起安裝,而且您無法選擇參考的子集。 如果您透過 Azure Cloud Shell 執行 CLI,核心參考一律為最新狀態。

副檔名

擴充功能不會隨附為 CLI 的一部分,而是以 CLI 命令的形式執行。 某些擴充功能是 Azure CLI 的永久部分,但擴充功能通常可讓您存取預覽和實驗命令。 單一參考群組,例如 az iot hub,可以同時擁有核心和擴充命令。 以下提供兩個範例:

完整參考命令 Is Core Is Extension
az iot hub list
az iot hub job list

系統會提示您在第一次使用時安裝擴充功能。 您也可以執行 az extension add 命令來安裝擴充功能。

您可以在搭配 Azure CLI 使用擴充功能中深入瞭解延伸模塊參考,包括安裝和更新。 如需延伸模組參考命令的完整清單,請參閱 Azure CLI 可用的擴充功能。

什麼是參考狀態?

不論參考類型為何,Azure CLI 參考都分為三種狀態類別: GA (正式推出)、 公開預覽淘汰。 這是判斷穩定性的參考命令狀態(不是類型)。

GA 公開預覽 已淘汰
穩定性 持續性 可以變更以回應客戶的意見反應。 受限於 Microsoft Azure 預覽版的條款 將會移除。

注意

指出 公開預覽 淘汰的警告是 Azure CLI 命令輸出的一部分,且應該預期。

單一參考的大部分命令和參數都有單一狀態,但不一定。 為了提供更多命令而建置的 GA 參考可以同時擁有 GA 和預覽參考命令。 隨著新增參數來增加功能,單一命令也可以有屬於不同狀態類別的參數。 以下是具有不同狀態的範例參考:

完整參考命令 參數 類型 GA 公開預覽 已淘汰
az network dns zone list 全部 核心
az network dns zone create --name、 --resource-group、-if-none-match、--parent-name 核心
--existingParameter5 核心
--newParameter6 核心
az network vhub list 全部 Extension
az network vhub create --address-prefix、--name、--resource-group、-vwan、--location、--sku Extension
--exsitingParameter7 Extension
--newParameter8 Extension
az network firewall create 全部 Extension

上述表格只是一個範例,而且 代表 的 az network目前參考狀態。

另請參閱