Virtual Machines Run Commands - Run Command

VM でコマンドを実行します。

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

URI パラメーター

Name In Required Type Description
resourceGroupName
path True
  • string

リソース グループの名前。

subscriptionId
path True
  • string

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

vmName
path True
  • string

仮想マシンの名前。

api-version
query True
  • string

クライアント Api バージョン。

要求本文

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

Name Required Type Description
commandId True
  • string

Run コマンド id。

parameters

Run コマンドのパラメーターです。

script
  • string[]

任意。 実行するスクリプト。 この値を指定すると、指定したスクリプトによってコマンドの既定のスクリプトがオーバーライドされます。

応答

Name Type Description
200 OK

OK

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

202 Accepted

同意

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

セキュリティ

azure_auth

Azure Active DirectoryOAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザーアカウントの権限を借用する

VirtualMachineRunCommand

Sample Request

POST https://management.azure.com/subscriptions/24fb23e3-6ba3-41f0-9b6e-e41131d5d61e/resourceGroups/crptestar98131/providers/Microsoft.Compute/virtualMachines/vm3036/runCommand?api-version=2021-04-01
{
  "commandId": "RunPowerShellScript"
}

Sample Response

{
  "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": ""
    }
  ]
}

定義

InstanceViewStatus

インスタンスビューの状態。

RunCommandInput

仮想マシンのパラメーターをキャプチャします。

RunCommandInputParameter

Run コマンドパラメーターのプロパティについて説明します。

RunCommandResult
StatusLevelTypes

レベルコード。

InstanceViewStatus

インスタンスビューの状態。

Name Type Description
code
  • string

ステータス コード。

displayStatus
  • string

ステータスのローカライズ可能な短いラベル。

level

レベルコード。

message
  • string

アラートやエラーメッセージなどの詳細なステータスメッセージ。

time
  • string

状態の時刻。

RunCommandInput

仮想マシンのパラメーターをキャプチャします。

Name Type Description
commandId
  • string

Run コマンド id。

parameters

Run コマンドのパラメーターです。

script
  • string[]

任意。 実行するスクリプト。 この値を指定すると、指定したスクリプトによってコマンドの既定のスクリプトがオーバーライドされます。

RunCommandInputParameter

Run コマンドパラメーターのプロパティについて説明します。

Name Type Description
name
  • string

Run コマンドのパラメーター名。

value
  • string

Run コマンドのパラメーター値です。

RunCommandResult

Name Type Description
value

コマンド操作の応答を実行します。

StatusLevelTypes

レベルコード。

Name Type Description
Error
  • string
Info
  • string
Warning
  • string