次の方法で共有


Virtual Machine Run Commands - Get

ある場所にあるサブスクリプションの特定の実行コマンドを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands/{commandId}?api-version=2024-07-01

URI パラメーター

名前 / 必須 説明
commandId
path True

string

コマンド ID。

location
path True

string

実行コマンドのクエリを実行する場所。

正規表現パターン: ^[-\w\._]+$

subscriptionId
path True

string

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。

api-version
query True

string

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

応答

名前 説明
200 OK

RunCommandDocument

わかりました

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

VirtualMachineRunCommandGet

要求のサンプル

GET https://management.azure.com/subscriptions/24fb23e3-6ba3-41f0-9b6e-e41131d5d61e/providers/Microsoft.Compute/locations/SoutheastAsia/runCommands/RunPowerShellScript?api-version=2024-07-01

応答のサンプル

{
  "script": [
    "param(",
    "    [string]$arg1,",
    "    [string]$arg2",
    ")",
    "Write-Host This is a sample script with parameters $arg1 $arg2"
  ],
  "parameters": [
    {
      "name": "arg1",
      "type": "string",
      "defaultValue": "value1"
    },
    {
      "name": "arg2",
      "type": "string",
      "defaultValue": "value2"
    }
  ],
  "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json",
  "id": "RunPowerShellScript",
  "osType": "Windows",
  "label": "Executes a PowerShell script",
  "description": "Custom multiline PowerShell script should be defined in script property. Optional parameters can be set in parameters property."
}

定義

名前 説明
OperatingSystemTypes

オペレーティング システムの種類。

RunCommandDocument

実行コマンドのプロパティについて説明します。

RunCommandParameterDefinition

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

OperatingSystemTypes

オペレーティング システムの種類。

名前 説明
Linux

string

Windows

string

RunCommandDocument

実行コマンドのプロパティについて説明します。

名前 説明
$schema

string

VM 実行コマンド スキーマ。

description

string

VM 実行コマンドの説明。

id

string

VM の実行コマンド ID。

label

string

VM 実行コマンド ラベル。

osType

OperatingSystemTypes

オペレーティング システムの種類。

parameters

RunCommandParameterDefinition[]

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

script

string[]

実行するスクリプト。

RunCommandParameterDefinition

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

名前 規定値 説明
defaultValue

string

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

name

string

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

required

boolean

False

run コマンド パラメーターが必要です。

type

string

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