az connectedmachine extension

參考

注意

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

在已啟用 Azure Arc 的伺服器上管理 VM 擴充功能。

命令

名稱	Description	類型	狀態
az connectedmachine extension create	要建立延伸模組的作業。	副檔名	GA
az connectedmachine extension delete	要刪除延伸模組的作業。	副檔名	GA
az connectedmachine extension image	管理適用于已啟用 Azure Arc 的伺服器的 VM 擴充功能中繼資料。	副檔名	GA
az connectedmachine extension image list	根據位置、發行者、extensionType 列出所有擴充功能版本。	副檔名	GA
az connectedmachine extension image show	根據位置、發行者、extensionType 和版本取得延伸模組中繼資料。	副檔名	GA
az connectedmachine extension list	取得非 Azure 機器之所有延伸模組的作業。	副檔名	GA
az connectedmachine extension show	建立或更新延伸模組的作業。	副檔名	GA
az connectedmachine extension update	更新作業以更新擴充功能。	副檔名	GA
az connectedmachine extension wait	將 CLI 置於等候狀態，直到符合條件為止。	副檔名	GA

az connectedmachine extension create

要建立延伸模組的作業。

az connectedmachine extension create --extension-name
                                     --machine-name
                                     --resource-group
                                     [--auto-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--auto-upgrade-minor {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]

範例

擴充功能建立的範例命令

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> 。

選擇性參數

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

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

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

--auto-upgrade-minor --auto-upgrade-minor-version --upgrade-minor-ver

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

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

--force-update-tag

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

--instance-view

電腦擴充實例檢視。支援速記語法、json-file 和 yaml-file。請嘗試「？？」以顯示更多。

--location -l

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

--no-wait

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

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

--protected-settings

延伸模組可以包含 protected設定或 protected設定FromKeyVault 或完全沒有受保護的設定。支援 json-file 和 yaml-file。

--publisher

擴充處理常式發行者的名稱。

--settings

擴充功能的 Json 格式化公用設定。支援 json-file 和 yaml-file。

--tags

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

--type

指定延伸模組的類型;例如「CustomScriptExtension」。

--type-handler-version

指定腳本處理常式的版本。

全域參數

--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 connectedmachine extension delete

要刪除延伸模組的作業。

az connectedmachine extension delete [--extension-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

選擇性參數

--extension-name --name -n

電腦擴充功能的名稱。

--ids

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

--machine-name

應該刪除擴充功能的電腦名稱稱。

--no-wait

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

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

--resource-group -g

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

--subscription

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

--yes -y

不提示確認。

預設值: 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 connectedmachine extension list

取得非 Azure 機器之所有延伸模組的作業。

az connectedmachine extension list --machine-name
                                   --resource-group
                                   [--expand]

範例

延伸模組清單的範例命令

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

必要參數

--machine-name

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

--resource-group -g

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

選擇性參數

--expand

要套用至作業的展開運算式。

全域參數

--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 connectedmachine extension show

建立或更新延伸模組的作業。

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

範例

延伸模組顯示的範例命令

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

選擇性參數

--extension-name --name -n

電腦擴充功能的名稱。

--ids

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

--machine-name

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

--resource-group -g

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

--subscription

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

全域參數

--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 connectedmachine extension update

更新作業以更新擴充功能。

az connectedmachine extension update [--add]
                                     [--auto-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--auto-upgrade-minor {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--extension-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

選擇性參數

--add

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

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

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

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

--auto-upgrade-minor --auto-upgrade-minor-version --upgrade-minor-ver

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

--extension-name --name -n

電腦擴充功能的名稱。

--force-string

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

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

--force-update-tag

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

--ids

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

--instance-view

電腦擴充實例檢視。支援速記語法、json-file 和 yaml-file。請嘗試「？？」以顯示更多。

--machine-name

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

--no-wait

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

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

--protected-settings

延伸模組可以包含 protected設定或 protected設定FromKeyVault 或完全沒有受保護的設定。支援 json-file 和 yaml-file。

--publisher

擴充處理常式發行者的名稱。

--remove

從清單中移除屬性或專案。範例：--remove property.list OR --remove 屬性ToRemove。

--resource-group -g

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

--set

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

--settings

擴充功能的 Json 格式化公用設定。支援 json-file 和 yaml-file。

--subscription

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

--tags

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

--type

指定延伸模組的類型;例如「CustomScriptExtension」。

--type-handler-version

指定腳本處理常式的版本。

全域參數

--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 connectedmachine extension wait

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

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

選擇性參數

--created

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

預設值: False

--custom

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

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--extension-name --name -n

計算機擴充功能的名稱。

--ids

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

--interval

輪詢間隔以秒為單位。

預設值: 30

--machine-name

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

--resource-group -g

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

--subscription

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

--timeout

以秒為單位的等候上限。

預設值: 3600

--updated

等到 provisioningState 更新為 'Succeeded'。

預設值: 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 connectedmachine extension

命令

az connectedmachine extension create

範例

必要參數

選擇性參數

az connectedmachine extension delete

範例

選擇性參數

az connectedmachine extension list

範例

必要參數

選擇性參數

az connectedmachine extension show

範例

選擇性參數

az connectedmachine extension update

範例

選擇性參數

az connectedmachine extension wait

選擇性參數

意見反應

其他資源