az connectedmachine run-command

注意

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

此命令群組處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

在已啟用 Azure Arc 的伺服器上管理執行命令。

命令

名稱	Description	類型	狀態
az connectedmachine run-command create	建立作業以建立或更新執行命令。	副檔名	預覽
az connectedmachine run-command delete	刪除作業以刪除執行命令。	副檔名	預覽
az connectedmachine run-command list	列出作業以取得非 Azure 機器的所有執行命令。	副檔名	預覽
az connectedmachine run-command show	取得作業以取得執行命令。	副檔名	預覽
az connectedmachine run-command update	更新作業以建立或更新執行命令。	副檔名	預覽
az connectedmachine run-command wait	將 CLI 置於等候狀態，直到符合條件為止。	副檔名	預覽

az connectedmachine run-command create

預覽

命令群組 'az connectedmachine run-command' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

建立作業以建立或更新執行命令。

az connectedmachine run-command create --machine-name
                                       --name
                                       --resource-group
                                       [--async {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--command-id]
                                       [--error-blob-managed-identity]
                                       [--error-blob-uri]
                                       [--location]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--output-blob-managed-identity]
                                       [--output-blob-uri]
                                       [--parameters]
                                       [--password]
                                       [--protected-parameters]
                                       [--run-as-user]
                                       [--script]
                                       [--script-uri]
                                       [--script-uri-managed-id]
                                       [--tags]
                                       [--timeout]

範例

run-command create 的範例命令

az connectedmachine run-command create --resource-group "myResourceGroup" --location "West US" --async false --parameters "[{"name":"param1","value":"value1"}]" --password "<runAsPassword>" --user "user1" --script "Write-Host Hello World!" --timeout 3600 --name "myRunCommand" --machine-name "myMachine" --subscription "mySubscription"
az connectedmachine run-command create --resource-group "myResourceGroup" --location "West US" --script "Write-Host Hello World!" --name "myRunCommand" --machine-name "myMachine" --output-uri "https://mystorageaccount.blob.core.windows.net/mycontainer/RuncommandOutput.txt?sp=racw&st=2022-10-17T19:02:15Z&se=2022-10-18T03:02:15Z&spr=https&sv=2021-06-08&sr=b&sig=3BxtEasfdasdfasdfdYki9yvYsqc60V0%3D" --subscription "mySubscription"

必要參數

--machine-name

混合式電腦的名稱。

--name --run-command-name -n

run 命令的名稱。

--resource-group -g

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

選擇性參數

--async --async-execution

選擇性。 如果設定為 true，布建會在腳本啟動時立即完成，而且不會等待腳本完成。

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

預設值: False

--command-id

指定預先定義內建腳本的 commandId。

--error-blob-managed-identity --error-id

使用者指派的受控識別可存取 errorBlobUri 儲存體 Blob。 在系統指派的身分識別的情況下，請使用空白物件。 請確定受控識別已獲得 Blob 容器的存取權，並具有「儲存體 Blob 資料參與者」角色指派。 如果是使用者指派的身分識別，請務必將其新增到 VM 的身分識別之下。 如需受控識別和執行命令的詳細資訊，請參閱 https://aka.ms/ManagedIdentity 及 https://aka.ms/RunCommandManaged 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--error-blob-uri --error-uri

指定將上傳腳本錯誤資料流程的 Azure 儲存體 Blob。 使用具有讀取、附加、建立、寫入存取權的 SAS URI，或使用受控識別來提供 Blob 的 VM 存取權。 請參閱 errorBlobManagedIdentity 參數。

--location -l

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

--no-wait

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

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

--output-blob-managed-identity --output-id

使用者指派的受控識別可存取 outputBlobUri 儲存體 Blob。 在系統指派的身分識別的情況下，請使用空白物件。 請確定受控識別已獲得 Blob 容器的存取權，並具有「儲存體 Blob 資料參與者」角色指派。 如果是使用者指派的身分識別，請務必將其新增到 VM 的身分識別之下。 如需受控識別和執行命令的詳細資訊，請參閱 https://aka.ms/ManagedIdentity 及 https://aka.ms/RunCommandManaged 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--output-blob-uri --output-uri

指定將上傳腳本輸出資料流程的 Azure 儲存體 Blob。 使用具有讀取、附加、建立、寫入存取權的 SAS URI，或使用受控識別來提供 Blob 的 VM 存取權。 請參閱 outputBlobManagedIdentity 參數。

--parameters

腳本所使用的參數。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--password --run-as-password

在執行執行命令時，指定電腦上的使用者帳戶密碼。

--protected-parameters

腳本所使用的參數。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--run-as-user --user

在執行執行命令時，指定電腦上的使用者帳戶。

--script

指定要在機器上執行的腳本內容。

--script-uri

指定腳本下載位置。 它可以是具有讀取權限或公用 URI 的 Azure 儲存體 Blob SAS URI。

--script-uri-managed-id --script-uri-managed-identity

使用者指派的受控識別，可存取 Azure 儲存體 Blob 時可存取 scriptUri。 在系統指派的身分識別的情況下，請使用空白物件。 請確定 Azure 儲存體 Blob 存在，且受控識別已獲得具有「儲存體 Blob 資料讀取者」角色指派之 Blob 容器的存取權。 如果是使用者指派的身分識別，請務必將其新增到 VM 的身分識別之下。 如需受控識別和執行命令的詳細資訊，請參閱 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged 。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--tags

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

--timeout --timeout-in-seconds

執行命令的逾時以秒為單位。

全域參數

--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 run-command delete

預覽

命令群組 'az connectedmachine run-command' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

刪除作業以刪除執行命令。

az connectedmachine run-command delete [--ids]
                                       [--machine-name]
                                       [--name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--resource-group]
                                       [--subscription]
                                       [--yes]

範例

run-command delete 的範例命令

az connectedmachine run-command delete --resource-group "myResourceGroup" --name "myRunCommand" --machine-name "myMachine"

選擇性參數

--ids

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

--machine-name

混合式電腦的名稱。

--name --run-command-name -n

run 命令的名稱。

--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 run-command list

預覽

命令群組 'az connectedmachine run-command' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

列出作業以取得非 Azure 機器的所有執行命令。

az connectedmachine run-command list --machine-name
                                     --resource-group
                                     [--expand]

範例

run-command 清單的範例命令

az connectedmachine run-command list --resource-group "myResourceGroup" --machine-name "myMachine"

必要參數

--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 run-command show

預覽

命令群組 'az connectedmachine run-command' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

取得作業以取得執行命令。

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

範例

run-command show 的範例命令

az connectedmahine run-command show --resource-group "myResourceGroup" --name "myRunCommand" --machine-name "myMachine"

選擇性參數

--ids

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

--machine-name

混合式電腦的名稱。

--name --run-command-name -n

run 命令的名稱。

--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 run-command update

預覽

命令群組 『az connectedmachine run-command』 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

更新作業以建立或更新執行命令。

az connectedmachine run-command update [--add]
                                       [--async {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--error-blob-managed-identity]
                                       [--error-blob-uri]
                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--ids]
                                       [--machine-name]
                                       [--name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--output-blob-managed-identity]
                                       [--output-blob-uri]
                                       [--parameters]
                                       [--password]
                                       [--protected-parameters]
                                       [--remove]
                                       [--resource-group]
                                       [--run-as-user]
                                       [--set]
                                       [--source]
                                       [--subscription]
                                       [--tags]
                                       [--timeout]

範例

run-command update 的範例命令

az connetcedmachine run-command update --resource-group "myResourceGroup" --name "myRunCommand" --machine-name "myMachine" --subscription "mySubscription" --tags Tag1=Value1

選擇性參數

--add

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

--async --async-execution

選擇性。 如果設定為 true，布建會在腳本啟動時立即完成，而且不會等待腳本完成。

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

--error-blob-managed-identity --error-id

使用者指派的受控識別可存取 errorBlobUri 記憶體 Blob。 在系統指派的身分識別的情況下，請使用空白物件。 請確定受控識別已獲得 Blob 容器的存取權，並具有「儲存體 Blob 數據參與者」角色指派。 如果是使用者指派的身分識別，請務必將其新增到 VM 的身分識別之下。 如需受控識別和執行命令的詳細資訊，請參閱 https://aka.ms/ManagedIdentity 及 https://aka.ms/RunCommandManaged 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--error-blob-uri --error-uri

指定將上傳文稿錯誤數據流的 Azure 記憶體 Blob。 使用具有讀取、附加、建立、寫入存取權的SAS URI，或使用受控識別來提供 Blob 的 VM 存取權。 請參閱 errorBlobManagedIdentity 參數。

--force-string

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

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

--ids

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

--machine-name

混合式計算機的名稱。

--name --run-command-name -n

run 命令的名稱。

--no-wait

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

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

--output-blob-managed-identity --output-id

使用者指派的受控識別可存取 outputBlobUri 記憶體 Blob。 在系統指派的身分識別的情況下，請使用空白物件。 請確定受控識別已獲得 Blob 容器的存取權，並具有「儲存體 Blob 數據參與者」角色指派。 如果是使用者指派的身分識別，請務必將其新增到 VM 的身分識別之下。 如需受控識別和執行命令的詳細資訊，請參閱 https://aka.ms/ManagedIdentity 及 https://aka.ms/RunCommandManaged 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--output-blob-uri --output-uri

指定將上傳文本輸出數據流的 Azure 記憶體 Blob。 使用具有讀取、附加、建立、寫入存取權的SAS URI，或使用受控識別來提供 Blob 的 VM 存取權。 請參閱 outputBlobManagedIdentity 參數。

--parameters

腳本所使用的參數。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--password --run-as-password

在執行執行命令時，指定電腦上的用戶帳戶密碼。

--protected-parameters

腳本所使用的參數。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--remove

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

--resource-group -g

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

--run-as-user --user

在執行執行命令時，指定電腦上的用戶帳戶。

--set

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

--source

執行命令腳本的來源。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--subscription

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

--tags

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

--timeout --timeout-in-seconds

執行命令的逾時以秒為單位。

全域參數

--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 run-command wait

預覽

命令群組 『az connectedmachine run-command』 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

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

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

選擇性參數

--created

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

預設值: False

--custom

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

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--ids

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

--interval

輪詢間隔以秒為單位。

預設值: 30

--machine-name

混合式計算機的名稱。

--name --run-command-name -n

run 命令的名稱。

--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 來取得完整偵錯記錄。