az extension

管理及更新 CLI 延伸模組。

命令

名稱	Description	類型	狀態
az extension add	新增延伸模組。	核心	GA
az extension list	列出已安裝的延伸模組。	核心	GA
az extension list-available	列出公開可用的延伸模組。	核心	GA
az extension list-versions	列出延伸模組的可用版本。	核心	GA
az extension remove	移除延伸模組。	核心	GA
az extension show	顯示延伸模組。	核心	GA
az extension update	更新延伸模組。	核心	GA

az extension add

新增延伸模組。

若要瞭解如何自動安裝延伸模組，請瀏覽 https://aka.ms/AzExtDynamicInstall。

az extension add [--allow-preview {false, true}]
                 [--name]
                 [--pip-extra-index-urls]
                 [--pip-proxy]
                 [--source]
                 [--system]
                 [--upgrade]
                 [--version]
                 [--yes]

範例

依名稱新增擴充功能

az extension add --name anextension

從 URL 新增擴充功能

az extension add --source https://contoso.com/anextension-0.0.1-py2.py3-none-any.whl

從本機磁碟新增擴充功能

az extension add --source ~/anextension-0.0.1-py2.py3-none-any.whl

從本機磁碟新增擴充功能，並使用 pip Proxy 進行相依性

az extension add --source ~/anextension-0.0.1-py2.py3-none-any.whl --pip-proxy https://user:pass@proxy.server:8080

將擴充功能新增至系統目錄

az extension add --name anextension --system

新增特定版本的擴充功能

az extension add --name anextension --version 1.0.0

如果已安裝，請升級延伸模組

az extension add --upgrade --name anextension

選擇性參數

--allow-preview

如果存在，請包含延伸模組安裝的預覽套件。

接受的值: false, true

--name -n

延伸模組的名稱。

--pip-extra-index-urls

要使用之套件索引的額外 URL 清單 (以空格分隔)。 這應該指向符合 PEP 503 規範的存放庫 (簡易存放庫 API)，或以相同格式顯示的本機目錄。

--pip-proxy

pip 的 Proxy，以 [user：passwd@]proxy.server：port 的形式用於延伸模組相依性。

--source -s

擴展名的 Filepath 或 URL。

--system

使用擴充功能的系統目錄。

默認路徑是執行 python 環境連結庫路徑的 CLI 下 azure-cli-extensions 資料夾，可由環境變數AZURE_EXTENSION_SYS_DIR設定。 在 Windows 上，您可能需要以 管理員 istrator 開啟殼層，才能以正確的許可權執行。

--upgrade

如果已安裝，請更新延伸模組，否則只要安裝擴充功能即可。

--version

擴充功能的特定版本。

預設值: latest

--yes -y

不提示確認。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az extension list

列出已安裝的延伸模組。

az extension list

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az extension list-available

列出公開可用的延伸模組。

az extension list-available [--show-details]

範例

列出所有公開可用的擴充功能

az extension list-available

列出特定擴充功能的詳細數據

az extension list-available --show-details --query anextension

選擇性參數

--show-details -d

顯示延伸模組索引的原始數據。

預設值: False

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az extension list-versions

列出延伸模組的可用版本。

az extension list-versions --name

範例

列出延伸模組的可用版本

az extension list-versions --name anextension

必要參數

--name -n

延伸模組的名稱。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az extension remove

移除延伸模組。

az extension remove --name

範例

移除延伸模組。 （ 自動產生 ）

az extension remove --name MyExtension

必要參數

--name -n

延伸模組的名稱。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az extension show

顯示延伸模組。

az extension show --name

範例

顯示延伸模組。 （ 自動產生 ）

az extension show --name MyExtension

必要參數

--name -n

延伸模組的名稱。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az extension update

更新延伸模組。

az extension update --name
                    [--allow-preview {false, true}]
                    [--pip-extra-index-urls]
                    [--pip-proxy]

範例

依名稱更新擴充功能

az extension update --name anextension

依名稱更新延伸模組，並使用 pip Proxy 進行相依性

az extension update --name anextension --pip-proxy https://user:pass@proxy.server:8080

必要參數

--name -n

延伸模組的名稱。

選擇性參數

--allow-preview

如果存在，請包含延伸模組安裝的預覽套件。

接受的值: false, true

--pip-extra-index-urls

要使用之套件索引的額外 URL 清單 (以空格分隔)。 這應該指向符合 PEP 503 規範的存放庫 (簡易存放庫 API)，或以相同格式顯示的本機目錄。

--pip-proxy

pip 的 Proxy，以 [user：passwd@]proxy.server：port 的形式用於延伸模組相依性。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。