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

本文說明 Azure CLI 術語。 有語法元件、參考類型和狀態。 這是決定支援層級的狀態。

Azure CLI 語法元件

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

Azure 服務 參考群組 參考子群組 (s) 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 命令
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

核心

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

延伸模組

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

完整參考命令 是否為核心 是否為擴充功能
az iot hub list
az iot hub job list

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

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

什麼是參考狀態?

不論參考類型為何,Azure CLI 參考都會分成三種狀態類別: GA (正式推出) 、 公開預覽實驗性。 這是 (不是) 判斷穩定性和支援層級的參考命令狀態。

GA 公開預覽 實驗
穩定性 持續性 可以變更以回應客戶的意見反應。 受限於 Microsoft Azure 預覽的條款。 可以變更以回應客戶的意見反應。 通常會移轉至公開預覽。 可加以移除。
支援層級 完整 Partial

注意

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

單一參考的大部分命令和參數都有單一狀態,但不一定。 為提供更多命令而建置的 GA 參考可以具有 GA、預覽和實驗參考命令。 由於新增了新的參數以提升功能,因此單一命令也可以具有歸類為不同狀態類別的參數。 以下是具有不同狀態的範例參考:

完整參考命令 參數 類型 GA 公開預覽 實驗
az network dns zone list 全部 核心
az network dns zone create --name、--resource-group、--if-none-match、--parent-name 核心
--newFutureParameter1 核心
--newFutureParameter2 核心
az network vhub list 全部 延伸模組
az network vhub create --address-prefix、--name、--resource-group、-vwan、--location、--sku 延伸模組
--newFutureParameter1 延伸模組
--newFutureParameter2 延伸模組
az network firewall create 全部 延伸模組

上表只是範例, 而且不 代表範例的目前參考狀態。

另請參閱