次の方法で共有

Microsoft.Compute virtualMachineScaleSets/virtualMachines/runCommands 2021-11-01

  • [アーティクル]

Bicep リソース定義

virtualMachineScaleSets/virtualMachines/runCommands リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2021-11-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    asyncExecution: bool
    errorBlobUri: 'string'
    outputBlobUri: 'string'
    parameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    protectedParameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    runAsPassword: 'string'
    runAsUser: 'string'
    source: {
      commandId: 'string'
      script: 'string'
      scriptUri: 'string'
    }
    timeoutInSeconds: int
  }
}

プロパティ値

virtualMachineScaleSets/virtualMachines/runCommands

名前 形容 価値
名前 リソース名

Bicepで子リソースの名前と種類 設定する方法を参照してください。		 string (必須)
場所 リソースの場所 string (必須)
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
親 Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「親リソースの外部 子リソース」を参照してください。		 種類のリソースのシンボリック名: virtualMachines
プロパティ 仮想マシンの実行コマンドのプロパティについて説明します。 VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

名前 形容 価値
asyncExecution 随意。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトが完了するまで待機しません。 bool
errorBlobUri スクリプト エラー ストリームをアップロードする Azure Storage BLOB を指定します。 糸
outputBlobUri スクリプト出力ストリームをアップロードする Azure Storage BLOB を指定します。 糸
パラメーター スクリプトで使用されるパラメーター。 RunCommandInputParameter[]
protectedParameters スクリプトで使用されるパラメーター。 RunCommandInputParameter[]
runAsPassword 実行コマンドの実行時に VM のユーザー アカウント パスワードを指定します。 糸
runAsUser 実行コマンドの実行時に VM 上のユーザー アカウントを指定します。 糸
源 実行コマンド スクリプトのソース。 VirtualMachineRunCommandScriptSource
timeoutInSeconds run コマンドを実行するためのタイムアウト (秒単位)。 int

RunCommandInputParameter

名前 形容 価値
名前 run コマンド のパラメーター名。 string (必須)
価値 run コマンド パラメーターの値。 string (必須)

VirtualMachineRunCommandScriptSource

名前 形容 価値
commandId 定義済みの組み込みスクリプトの commandId を指定します。 糸
スクリプト VM で実行するスクリプトコンテンツを指定します。 糸
scriptUri スクリプトのダウンロード場所を指定します。 糸

ARM テンプレート リソース定義

virtualMachineScaleSets/virtualMachines/runCommands リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
  "apiVersion": "2021-11-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "asyncExecution": "bool",
    "errorBlobUri": "string",
    "outputBlobUri": "string",
    "parameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "protectedParameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "runAsPassword": "string",
    "runAsUser": "string",
    "source": {
      "commandId": "string",
      "script": "string",
      "scriptUri": "string"
    },
    "timeoutInSeconds": "int"
  }
}

プロパティ値

virtualMachineScaleSets/virtualMachines/runCommands

名前 形容 価値
種類 リソースの種類 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands'
apiVersion リソース API のバージョン '2021-11-01'
名前 リソース名

JSON ARM テンプレートで子リソースの名前と型 設定する方法を参照してください。		 string (必須)
場所 リソースの場所 string (必須)
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
プロパティ 仮想マシンの実行コマンドのプロパティについて説明します。 VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

名前 形容 価値
asyncExecution 随意。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトが完了するまで待機しません。 bool
errorBlobUri スクリプト エラー ストリームをアップロードする Azure Storage BLOB を指定します。 糸
outputBlobUri スクリプト出力ストリームをアップロードする Azure Storage BLOB を指定します。 糸
パラメーター スクリプトで使用されるパラメーター。 RunCommandInputParameter[]
protectedParameters スクリプトで使用されるパラメーター。 RunCommandInputParameter[]
runAsPassword 実行コマンドの実行時に VM のユーザー アカウント パスワードを指定します。 糸
runAsUser 実行コマンドの実行時に VM 上のユーザー アカウントを指定します。 糸
源 実行コマンド スクリプトのソース。 VirtualMachineRunCommandScriptSource
timeoutInSeconds run コマンドを実行するためのタイムアウト (秒単位)。 int

RunCommandInputParameter

名前 形容 価値
名前 run コマンド のパラメーター名。 string (必須)
価値 run コマンド パラメーターの値。 string (必須)

VirtualMachineRunCommandScriptSource

名前 形容 価値
commandId 定義済みの組み込みスクリプトの commandId を指定します。 糸
スクリプト VM で実行するスクリプトコンテンツを指定します。 糸
scriptUri スクリプトのダウンロード場所を指定します。 糸

Terraform (AzAPI プロバイダー) リソース定義

virtualMachineScaleSets/virtualMachines/runCommands リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2021-11-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      asyncExecution = bool
      errorBlobUri = "string"
      outputBlobUri = "string"
      parameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      protectedParameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      runAsPassword = "string"
      runAsUser = "string"
      source = {
        commandId = "string"
        script = "string"
        scriptUri = "string"
      }
      timeoutInSeconds = int
    }
  })
}

プロパティ値

virtualMachineScaleSets/virtualMachines/runCommands

名前 形容 価値
種類 リソースの種類 "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2021-11-01"
名前 リソース名 string (必須)
場所 リソースの場所 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: virtualMachines
タグ リソース タグ タグ名と値のディクショナリ。
プロパティ 仮想マシンの実行コマンドのプロパティについて説明します。 VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

名前 形容 価値
asyncExecution 随意。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトが完了するまで待機しません。 bool
errorBlobUri スクリプト エラー ストリームをアップロードする Azure Storage BLOB を指定します。 糸
outputBlobUri スクリプト出力ストリームをアップロードする Azure Storage BLOB を指定します。 糸
パラメーター スクリプトで使用されるパラメーター。 RunCommandInputParameter[]
protectedParameters スクリプトで使用されるパラメーター。 RunCommandInputParameter[]
runAsPassword 実行コマンドの実行時に VM のユーザー アカウント パスワードを指定します。 糸
runAsUser 実行コマンドの実行時に VM 上のユーザー アカウントを指定します。 糸
源 実行コマンド スクリプトのソース。 VirtualMachineRunCommandScriptSource
timeoutInSeconds run コマンドを実行するためのタイムアウト (秒単位)。 int

RunCommandInputParameter

名前 形容 価値
名前 run コマンド のパラメーター名。 string (必須)
価値 run コマンド パラメーターの値。 string (必須)

VirtualMachineRunCommandScriptSource

名前 形容 価値
commandId 定義済みの組み込みスクリプトの commandId を指定します。 糸
スクリプト VM で実行するスクリプトコンテンツを指定します。 糸
scriptUri スクリプトのダウンロード場所を指定します。 糸