共用方式為


Virtual Machines - Run Command

在 VM 上執行命令。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommand?api-version=2024-07-01

URI 參數

名稱 位於 必要 類型 Description
resourceGroupName
path True

string

資源群組的名稱。

subscriptionId
path True

string

可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。

vmName
path True

string

虛擬機的名稱。

api-version
query True

string

用戶端 API 版本。

要求本文

Media Types: "application/json", "text/json"

名稱 必要 類型 Description
commandId True

string

執行命令標識碼。

parameters

RunCommandInputParameter[]

執行命令參數。

script

string[]

自選。 要執行的腳本。 指定此值時,指定的腳本會覆寫命令的預設腳本。

回應

名稱 類型 Description
200 OK

RunCommandResult

還行

Media Types: "application/json", "text/json"

202 Accepted

接受

Media Types: "application/json", "text/json"

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

VirtualMachineRunCommand

範例要求

POST https://management.azure.com/subscriptions/24fb23e3-6ba3-41f0-9b6e-e41131d5d61e/resourceGroups/crptestar98131/providers/Microsoft.Compute/virtualMachines/vm3036/runCommand?api-version=2024-07-01

{
  "commandId": "RunPowerShellScript"
}

範例回覆

{
  "value": [
    {
      "code": "ComponentStatus/StdOut/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "message": "This is a sample script with parameters value1 value2"
    },
    {
      "code": "ComponentStatus/StdErr/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "message": ""
    }
  ]
}
Location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2024-07-01

定義

名稱 Description
InstanceViewStatus

實例檢視狀態。

RunCommandInput

擷取虛擬機參數。

RunCommandInputParameter

描述執行命令參數的屬性。

RunCommandResult
StatusLevelTypes

層級程序代碼。

InstanceViewStatus

實例檢視狀態。

名稱 類型 Description
code

string

狀態代碼。

displayStatus

string

狀態的簡短可當地語系化標籤。

level

StatusLevelTypes

層級程序代碼。

message

string

詳細的狀態消息,包括警示和錯誤訊息。

time

string (date-time)

狀態的時間。

RunCommandInput

擷取虛擬機參數。

名稱 類型 Description
commandId

string

執行命令標識碼。

parameters

RunCommandInputParameter[]

執行命令參數。

script

string[]

自選。 要執行的腳本。 指定此值時,指定的腳本會覆寫命令的預設腳本。

RunCommandInputParameter

描述執行命令參數的屬性。

名稱 類型 Description
name

string

執行命令參數名稱。

value

string

run 命令參數值。

RunCommandResult

名稱 類型 Description
value

InstanceViewStatus[]

執行命令作業回應。

StatusLevelTypes

層級程序代碼。

Description
Error
Info
Warning