Virtual Machine Scale Set VM Run Commands - Get

VMSS VM の実行コマンドを取得する操作。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}?$expand={$expand}&api-version=2022-08-01

URI パラメーター

Name In Required Type Description
instanceId
path True
  • string

仮想マシンのインスタンス ID。

resourceGroupName
path True
  • string

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

runCommandName
path True
  • string

仮想マシンの実行コマンドの名前。

subscriptionId
path True
  • string

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

vmScaleSetName
path True
  • string

VM スケール セットの名前。

api-version
query True
  • string

クライアント API のバージョン。

$expand
query
  • string

操作に適用する展開式。

応答

Name Type Description
200 OK

OK

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

Other Status Codes

操作に失敗した理由を説明するエラー応答。

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

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryする

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

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

Get VirtualMachineScaleSet VM run commands.

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand?api-version=2022-08-01

Sample Response

{
  "name": "myRunCommand",
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand",
  "location": "westus",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "source": {
      "script": "Write-Host Hello World!"
    },
    "parameters": [
      {
        "name": "param1",
        "value": "value1"
      },
      {
        "name": "param2",
        "value": "value2"
      }
    ],
    "asyncExecution": false,
    "runAsUser": "user1",
    "timeoutInSeconds": 3600,
    "provisioningState": "Succeeded"
  }
}

定義

ApiError

API エラー。

ApiErrorBase

API エラーベース。

CloudError

コンピューティング サービスからのエラー応答。

ExecutionState

スクリプトの実行状態。

InnerError

内部エラーの詳細。

InstanceViewStatus

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

RunCommandInputParameter

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

StatusLevelTypes

レベル コード。

VirtualMachineRunCommand

仮想マシンの実行コマンドについて説明します。

VirtualMachineRunCommandInstanceView

仮想マシンの実行コマンドのインスタンス ビュー。

VirtualMachineRunCommandScriptSource

run コマンドのスクリプト ソースについて説明します。

ApiError

API エラー。

Name Type Description
code
  • string

エラー コード。

details

Api エラーの詳細

innererror

Api の内部エラー

message
  • string

エラー メッセージ。

target
  • string

特定のエラーのターゲット。

ApiErrorBase

API エラーベース。

Name Type Description
code
  • string

エラー コード。

message
  • string

エラー メッセージ。

target
  • string

特定のエラーのターゲット。

CloudError

コンピューティング サービスからのエラー応答。

Name Type Description
error

API エラー。

ExecutionState

スクリプトの実行状態。

Name Type Description
Canceled
  • string
Failed
  • string
Pending
  • string
Running
  • string
Succeeded
  • string
TimedOut
  • string
Unknown
  • string

InnerError

内部エラーの詳細。

Name Type Description
errordetail
  • string

内部エラー メッセージまたは例外ダンプ。

exceptiontype
  • string

例外の種類。

InstanceViewStatus

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

Name Type Description
code
  • string

ステータス コード。

displayStatus
  • string

状態の短いローカライズ可能なラベル。

level

レベル コード。

message
  • string

アラートやエラー メッセージを含む詳細なステータス メッセージ。

time
  • string

状態の時刻。

RunCommandInputParameter

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

Name Type Description
name
  • string

run コマンド パラメーター名。

value
  • string

run コマンド パラメーターの値。

StatusLevelTypes

レベル コード。

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

VirtualMachineRunCommand

仮想マシンの実行コマンドについて説明します。

Name Type Default Value Description
id
  • string

リソース ID

location
  • string

リソースの場所

name
  • string

リソース名

properties.asyncExecution
  • boolean
False

省略可能。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトの完了を待機しません。

properties.errorBlobUri
  • string

スクリプト エラー ストリームがアップロードされる Azure ストレージ BLOB を指定します。

properties.instanceView

仮想マシンの実行コマンド インスタンス ビュー。

properties.outputBlobUri
  • string

スクリプト出力ストリームをアップロードする Azure Storage BLOB を指定します。

properties.parameters

スクリプトで使用されるパラメーター。

properties.protectedParameters

スクリプトで使用されるパラメーター。

properties.provisioningState
  • string

プロビジョニング状態。応答にのみ表示されます。

properties.runAsPassword
  • string

実行コマンドの実行時に VM のユーザー アカウント パスワードを指定します。

properties.runAsUser
  • string

実行コマンドの実行時に VM 上のユーザー アカウントを指定します。

properties.source

実行コマンド スクリプトのソース。

properties.timeoutInSeconds
  • integer

実行コマンドを実行するタイムアウト (秒単位)。

tags
  • object

リソース タグ

type
  • string

リソースの種類

VirtualMachineRunCommandInstanceView

仮想マシンの実行コマンドのインスタンス ビュー。

Name Type Description
endTime
  • string

スクリプトの終了時刻。

error
  • string

スクリプト エラー ストリーム。

executionMessage
  • string

スクリプト構成エラーまたは実行メッセージを伝えます。

executionState

スクリプトの実行状態。

exitCode
  • integer

スクリプトの実行から返された終了コード。

output
  • string

スクリプト出力ストリーム。

startTime
  • string

スクリプトの開始時刻。

statuses

リソースの状態情報。

VirtualMachineRunCommandScriptSource

run コマンドのスクリプト ソースについて説明します。

Name Type Description
commandId
  • string

定義済みの組み込みスクリプトの commandId を指定します。

script
  • string

VM で実行するスクリプトコンテンツを指定します。

scriptUri
  • string

スクリプトのダウンロード場所を指定します。