az connectedmachine extension

Note

此參考文獻是Azure CLIconnectedmachine擴充功能（版本 2.75.0 或更高版本）的一部分。 當您第一次執行 az connectedmachine extension 命令時，擴充功能會自動安裝。 深入了解擴充功能。

管理一個 Azure Arc 啟用伺服器上的虛擬機擴充功能。

命令

名稱	Description	類型	狀態
az connectedmachine extension create	建立一個擴充功能。	Extension	GA
az connectedmachine extension delete	刪除擴充功能。	Extension	GA
az connectedmachine extension image	管理 Azure Arc-enabled Servers 可用嘅 VM extension metadata。	Extension	GA
az connectedmachine extension image list	根據位置、發行者、extensionType 列出所有擴充功能版本。	Extension	GA
az connectedmachine extension image show	根據位置、發行者、extensionType和版本取得延伸模組元數據。	Extension	GA
az connectedmachine extension list	取得非 Azure 機器的所有擴充功能。	Extension	GA
az connectedmachine extension publisher	管理 Publisher。	Extension	GA
az connectedmachine extension publisher list	根據地點列出所有 Extension 出版商。	Extension	GA
az connectedmachine extension show	顯示非 Azure 機器的擴充功能。	Extension	GA
az connectedmachine extension type	管理擴充功能類型。	Extension	GA
az connectedmachine extension type list	根據地點和發佈者列出所有擴充功能類型。	Extension	GA
az connectedmachine extension update	更新延伸模組。	Extension	GA
az connectedmachine extension wait	將 CLI 置於等候狀態，直到符合條件為止。	Extension	GA

az connectedmachine extension create

建立一個擴充功能。

az connectedmachine extension create --extension-name --name
                                     --machine-name
                                     --resource-group
                                     [--acquire-policy-token]
                                     [--auto-upgrade-min --auto-upgrade-minor-version {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--change-reference]
                                     [--enable-auto-upgrade --enable-automatic-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--force-update-tag]
                                     [--instance-view]
                                     [--location]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--protected-settings]
                                     [--publisher]
                                     [--settings]
                                     [--tags]
                                     [--type]
                                     [--type-handler-version]

範例

擴充名 create 的範例指令

az connectedmachine extension create --name CustomScriptExtension --location eastus2euap --type CustomScriptExtension --publisher Microsoft.Compute --type-handler-version 1.10 --machine-name myMachine --resource-group myResourceGroup

必要參數

--extension-name --name -n

計算機擴充功能的名稱。

--machine-name

應該建立或更新擴充功能的計算機名稱。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--auto-upgrade-min --auto-upgrade-minor-version

指出如果部署期間有新的次要版本，擴充功能是否應該使用較新的次要版本。 不過，部署之後，除非重新部署，否則擴充功能不會升級次要版本，即使此屬性設定為 true 也一定會升級。

屬性	值
參數群組:	Properties Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--enable-auto-upgrade --enable-automatic-upgrade

指出如果有較新版本可用，平臺是否應該自動升級延伸模組。

屬性	值
參數群組:	Properties Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--force-update-tag

即使延伸模組組態尚未變更，延伸模組處理程式也應該強制更新。

屬性	值
參數群組:	Properties Arguments

--instance-view

計算機擴充實例檢視。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--location -l

未指定資源所在的地理位置，將會使用資源群組的位置。

屬性	值
參數群組:	Resource Arguments

--no-wait

請勿等候長時間執行的作業完成。

屬性	值
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--protected-settings

延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--publisher

擴充處理程序發行者的名稱。

屬性	值
參數群組:	Properties Arguments

--settings

擴充功能的 Json 格式化公用設定。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--tags

資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Resource Arguments

--type

指定延伸模組的類型;例如“CustomScriptExtension”。

屬性	值
參數群組:	Properties Arguments

--type-handler-version

指定文稿處理程式的版本。

屬性	值
參數群組:	Properties Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az connectedmachine extension delete

刪除擴充功能。

az connectedmachine extension delete [--acquire-policy-token]
                                     [--change-reference]
                                     [--extension-name --name]
                                     [--ids]
                                     [--machine-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]
                                     [--yes]

範例

擴充名刪除的範例指令

az connectedmachine extension delete --name myName --machine-name myMachine --resource-group myResourceGroup

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--extension-name --name -n

計算機擴充功能的名稱。

屬性	值
參數群組:	Resource Id Arguments

--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性	值
參數群組:	Resource Id Arguments

--machine-name

應該刪除擴充功能的計算機名稱。

屬性	值
參數群組:	Resource Id Arguments

--no-wait

請勿等候長時間執行的作業完成。

屬性	值
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

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

屬性	值
參數群組:	Resource Id Arguments

--yes -y

請勿提示確認。

屬性	值
預設值:	False

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az connectedmachine extension list

取得非 Azure 機器的所有擴充功能。

az connectedmachine extension list --machine-name
                                   --resource-group
                                   [--expand]
                                   [--max-items]
                                   [--next-token]

範例

延伸模組清單的範例命令

az connectedmachine extension list --machine-name myMachine --resource-group myResourceGroup

必要參數

--machine-name

包含擴充功能的機器名稱。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--expand

要套用至作業的展開表達式。

--max-items

命令輸出中要傳回的項目總數。 如果可用的專案總數超過指定的值，則會在命令的輸出中提供令牌。 若要繼續分頁，請在後續命令的 --next-token 自變數中提供令牌值。

屬性	值
參數群組:	Pagination Arguments

--next-token

標記，指定要開始分頁的位置。 這是先前截斷回應中的令牌值。

屬性	值
參數群組:	Pagination Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az connectedmachine extension show

顯示非 Azure 機器的擴充功能。

az connectedmachine extension show [--extension-name --name]
                                   [--ids]
                                   [--machine-name]
                                   [--resource-group]
                                   [--subscription]

範例

擴充顯示的範例指令

az connectedmachine extension show --name CustomScriptExtension --machine-name myMachine --resource-group myResourceGroup

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--extension-name --name -n

計算機擴充功能的名稱。

屬性	值
參數群組:	Resource Id Arguments

--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性	值
參數群組:	Resource Id Arguments

--machine-name

包含擴充功能的機器名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

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

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az connectedmachine extension update

更新延伸模組。

az connectedmachine extension update [--acquire-policy-token]
                                     [--add]
                                     [--auto-upgrade-min --auto-upgrade-minor-version {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--change-reference]
                                     [--enable-auto-upgrade --enable-automatic-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--extension-name --name]
                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--force-update-tag]
                                     [--ids]
                                     [--instance-view]
                                     [--machine-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--protected-settings]
                                     [--publisher]
                                     [--remove]
                                     [--resource-group]
                                     [--set]
                                     [--settings]
                                     [--subscription]
                                     [--tags]
                                     [--type]
                                     [--type-handler-version]

範例

擴充功能更新範例指令

az connectedmachine extension update --name CustomScriptExtension --type CustomScriptExtension --publisher Microsoft.Compute --type-handler-version 1.10 --machine-name myMachine --resource-group myResourceGroup

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。 範例：--add property.listProperty <key=value, string or JSON string>。

屬性	值
參數群組:	Generic Update Arguments

--auto-upgrade-min --auto-upgrade-minor-version

指出如果部署期間有新的次要版本，擴充功能是否應該使用較新的次要版本。 不過，部署之後，除非重新部署，否則擴充功能不會升級次要版本，即使此屬性設定為 true 也一定會升級。

屬性	值
參數群組:	Properties Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--enable-auto-upgrade --enable-automatic-upgrade

指出如果有較新版本可用，平臺是否應該自動升級延伸模組。

屬性	值
參數群組:	Properties Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--extension-name --name -n

計算機擴充功能的名稱。

屬性	值
參數群組:	Resource Id Arguments

--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

屬性	值
參數群組:	Generic Update Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--force-update-tag

即使延伸模組組態尚未變更，延伸模組處理程式也應該強制更新。

屬性	值
參數群組:	Properties Arguments

--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性	值
參數群組:	Resource Id Arguments

--instance-view

計算機擴充實例檢視。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--machine-name

包含擴充功能的機器名稱。

屬性	值
參數群組:	Resource Id Arguments

--no-wait

請勿等候長時間執行的作業完成。

屬性	值
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--protected-settings

延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--publisher

擴充處理程序發行者的名稱。

屬性	值
參數群組:	Properties Arguments

--remove

從清單中移除屬性或專案。 範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

屬性	值
參數群組:	Generic Update Arguments

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--set

指定要設定的屬性路徑和值，以更新物件。 範例：--set property1.property2=<value>。

屬性	值
參數群組:	Generic Update Arguments

--settings

擴充功能的 Json 格式化公用設定。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--subscription

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

屬性	值
參數群組:	Resource Id Arguments

--tags

資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Resource Arguments

--type

指定延伸模組的類型;例如“CustomScriptExtension”。

屬性	值
參數群組:	Properties Arguments

--type-handler-version

指定文稿處理程式的版本。

屬性	值
參數群組:	Properties Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az connectedmachine extension wait

將 CLI 置於等候狀態，直到符合條件為止。

az connectedmachine extension wait [--acquire-policy-token]
                                   [--change-reference]
                                   [--created]
                                   [--custom]
                                   [--deleted]
                                   [--exists]
                                   [--extension-name --name]
                                   [--ids]
                                   [--interval]
                                   [--machine-name]
                                   [--resource-group]
                                   [--subscription]
                                   [--timeout]
                                   [--updated]

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--custom

等到條件符合自定義 JMESPath 查詢為止。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

屬性	值
參數群組:	Wait Condition Arguments

--deleted

等到刪除為止。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--exists

等候資源存在。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--extension-name --name -n

計算機擴充功能的名稱。

屬性	值
參數群組:	Resource Id Arguments

--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性	值
參數群組:	Resource Id Arguments

--interval

輪詢間隔以秒為單位。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	30

--machine-name

包含擴充功能的機器名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

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

屬性	值
參數群組:	Resource Id Arguments

--timeout

以秒為單位的等候上限。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	3600

--updated

等到 provisioningState 更新為 'Succeeded'。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False