Microsoft.Compute virtualMachines/runCommands 2023-07-01

2025-05-14

Bicep リソース定義

virtualMachines/runCommands リソースの種類は、次をターゲットとする操作と共にデプロイできます。

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

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

リソースの形式

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

resource symbolicname 'Microsoft.Compute/virtualMachines/runCommands@2023-07-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    asyncExecution: bool
    errorBlobManagedIdentity: {
      clientId: 'string'
      objectId: 'string'
    }
    errorBlobUri: 'string'
    outputBlobManagedIdentity: {
      clientId: 'string'
      objectId: 'string'
    }
    outputBlobUri: 'string'
    parameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    protectedParameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    runAsPassword: 'string'
    runAsUser: 'string'
    source: {
      commandId: 'string'
      script: 'string'
      scriptUri: 'string'
      scriptUriManagedIdentity: {
        clientId: 'string'
        objectId: 'string'
      }
    }
    timeoutInSeconds: int
    treatFailureAsDeploymentFailure: bool
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

Microsoft.Compute/virtualMachines/runCommands (英語)

名前	形容	価値
場所	リソースの場所	string (必須)
名前	リソース名	string (必須)
親	Bicep では、子リソースの親リソースを指定できます。このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。詳細については、「親リソースの外部子リソース」を参照してください。	種類のリソースのシンボリック名: virtualMachines
プロパティ	仮想マシンの実行コマンドのプロパティについて説明します。	VirtualMachineRunCommandプロパティ
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください

リソースタグ

名前	形容	価値

RunCommandInputParameter(ランコマンド入力パラメータ)

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

RunCommandManagedIdentity を実行します

名前	形容	価値
クライアントID	ユーザー割り当てマネージド ID のクライアント ID (GUID 値)。 ObjectId を指定する場合は使用しないでください。	糸
オブジェクトID	ユーザー割り当てマネージド ID のオブジェクト ID (GUID 値)。これが指定されている場合は、ClientId を使用しないでください。	糸

VirtualMachineRunCommandプロパティ

名前	形容	価値
非同期実行	随意。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトが完了するまで待機しません。	ブール (bool)
エラーブロブ・マネジメント・アイデンティティ	errorBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てを使用して、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。マネージド ID と実行コマンドの詳細については、https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged を参照してください。	RunCommandManagedIdentity を実行します
エラーブロブリ	スクリプトエラーストリームをアップロードする Azure Storage BLOB を指定します。読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 errorBlobManagedIdentity パラメーターを参照します。	糸
出力ブロブ・マネジメント・アイデンティティ	outputBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てを使用して、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。マネージド ID と実行コマンドの詳細については、https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged を参照してください。	RunCommandManagedIdentity を実行します
出力ブロブURI	スクリプト出力ストリームをアップロードする Azure Storage BLOB を指定します。読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 outputBlobManagedIdentity パラメーターを参照します。	糸
パラメーター	スクリプトで使用されるパラメーター。	RunCommandInputParameter[]
protectedパラメータ	スクリプトで使用されるパラメーター。	RunCommandInputParameter[]
runAsPassword (ランアスパスワード)	実行コマンドの実行時に VM のユーザーアカウントパスワードを指定します。	糸
runAsUser さん	実行コマンドの実行時に VM 上のユーザーアカウントを指定します。	糸
源	実行コマンドスクリプトのソース。	VirtualMachineRunCommandScriptSource
タイムアウトイン秒	run コマンドを実行するためのタイムアウト (秒単位)。	整数 (int)
treatFailureAsDeploymentFailure	随意。 true に設定すると、スクリプト内のエラーはデプロイに失敗し、ProvisioningState は Failed としてマークされます。 false に設定すると、ProvisioningState は、実行コマンドが拡張機能プラットフォームによって実行されたかどうかのみを反映し、スクリプトが失敗した場合にスクリプトが失敗したかどうかを示しません。スクリプトエラーが発生した場合は、run コマンドのインスタンスビューを参照して、executionMessage、output、error を表示します。 https://aka.ms/runcommandmanaged#get-execution-status-and-results	ブール (bool)

VirtualMachineRunCommandScriptSource

名前	形容	価値
コマンドID	定義済みの組み込みスクリプトの commandId を指定します。	糸
スクリプト	VM で実行するスクリプトコンテンツを指定します。	糸
scriptUri です。	スクリプトのダウンロード場所を指定します。読み取りアクセス権を持つ Azure ストレージ BLOB の SAS URI またはパブリック URI のいずれかを指定できます。	糸
scriptUriManagedIdentity (英語)	Azure Storage BLOB の場合に scriptUri にアクセスできるユーザー割り当てマネージド ID。システム割り当て ID の場合は、空のオブジェクトを使用します。 Azure ストレージ BLOB が存在し、マネージド ID に "ストレージ BLOB データ閲覧者" ロールの割り当てで BLOB のコンテナーへのアクセス権が付与されていることを確認します。ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。マネージド ID と実行コマンドの詳細については、「https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged」を参照してください。	RunCommandManagedIdentity を実行します

使用例

Azure クイックスタートのサンプル

次 Azure クイックスタートテンプレート、このリソースの種類をデプロイするための Bicep サンプルが含まれています。

Bicep ファイル	形容
GitLabオムニバス	このテンプレートは、パブリック IP の DNS を利用して、パブリック DNS を使用する仮想マシンへの GitLab Omnibus のデプロイを簡略化します。 Standard_F8s_v2 インスタンスサイズを利用します。これは参照アーキテクチャに合わせ、最大 1,000 ユーザー (20 RPS) をサポートします。インスタンスは、セキュリティで保護された接続に Let's Encrypt 証明書と共に HTTPS を使用するように事前構成されています。

Bicep ファイル

形容

GitLabオムニバス

このテンプレートは、パブリック IP の DNS を利用して、パブリック DNS を使用する仮想マシンへの GitLab Omnibus のデプロイを簡略化します。 Standard_F8s_v2 インスタンスサイズを利用します。これは参照アーキテクチャに合わせ、最大 1,000 ユーザー (20 RPS) をサポートします。インスタンスは、セキュリティで保護された接続に Let's Encrypt 証明書と共に HTTPS を使用するように事前構成されています。

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

virtualMachines/runCommands リソースの種類は、次をターゲットとする操作と共にデプロイできます。

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

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

リソースの形式

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

{
  "type": "Microsoft.Compute/virtualMachines/runCommands",
  "apiVersion": "2023-07-01",
  "name": "string",
  "location": "string",
  "properties": {
    "asyncExecution": "bool",
    "errorBlobManagedIdentity": {
      "clientId": "string",
      "objectId": "string"
    },
    "errorBlobUri": "string",
    "outputBlobManagedIdentity": {
      "clientId": "string",
      "objectId": "string"
    },
    "outputBlobUri": "string",
    "parameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "protectedParameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "runAsPassword": "string",
    "runAsUser": "string",
    "source": {
      "commandId": "string",
      "script": "string",
      "scriptUri": "string",
      "scriptUriManagedIdentity": {
        "clientId": "string",
        "objectId": "string"
      }
    },
    "timeoutInSeconds": "int",
    "treatFailureAsDeploymentFailure": "bool"
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

Microsoft.Compute/virtualMachines/runCommands (英語)

名前	形容	価値
apiVersion (英語)	API のバージョン	'2023-07-01'
場所	リソースの場所	string (必須)
名前	リソース名	string (必須)
プロパティ	仮想マシンの実行コマンドのプロパティについて説明します。	VirtualMachineRunCommandプロパティ
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください
種類	リソースの種類	'Microsoft.Compute/virtualMachines/runCommands'

リソースタグ

名前	形容	価値

RunCommandInputParameter(ランコマンド入力パラメータ)

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

RunCommandManagedIdentity を実行します

名前	形容	価値
クライアントID	ユーザー割り当てマネージド ID のクライアント ID (GUID 値)。 ObjectId を指定する場合は使用しないでください。	糸
オブジェクトID	ユーザー割り当てマネージド ID のオブジェクト ID (GUID 値)。これが指定されている場合は、ClientId を使用しないでください。	糸

VirtualMachineRunCommandプロパティ

名前	形容	価値
非同期実行	随意。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトが完了するまで待機しません。	ブール (bool)
エラーブロブ・マネジメント・アイデンティティ	errorBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てを使用して、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。マネージド ID と実行コマンドの詳細については、https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged を参照してください。	RunCommandManagedIdentity を実行します
エラーブロブリ	スクリプトエラーストリームをアップロードする Azure Storage BLOB を指定します。読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 errorBlobManagedIdentity パラメーターを参照します。	糸
出力ブロブ・マネジメント・アイデンティティ	outputBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てを使用して、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。マネージド ID と実行コマンドの詳細については、https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged を参照してください。	RunCommandManagedIdentity を実行します
出力ブロブURI	スクリプト出力ストリームをアップロードする Azure Storage BLOB を指定します。読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 outputBlobManagedIdentity パラメーターを参照します。	糸
パラメーター	スクリプトで使用されるパラメーター。	RunCommandInputParameter[]
protectedパラメータ	スクリプトで使用されるパラメーター。	RunCommandInputParameter[]
runAsPassword (ランアスパスワード)	実行コマンドの実行時に VM のユーザーアカウントパスワードを指定します。	糸
runAsUser さん	実行コマンドの実行時に VM 上のユーザーアカウントを指定します。	糸
源	実行コマンドスクリプトのソース。	VirtualMachineRunCommandScriptSource
タイムアウトイン秒	run コマンドを実行するためのタイムアウト (秒単位)。	整数 (int)
treatFailureAsDeploymentFailure	随意。 true に設定すると、スクリプト内のエラーはデプロイに失敗し、ProvisioningState は Failed としてマークされます。 false に設定すると、ProvisioningState は、実行コマンドが拡張機能プラットフォームによって実行されたかどうかのみを反映し、スクリプトが失敗した場合にスクリプトが失敗したかどうかを示しません。スクリプトエラーが発生した場合は、run コマンドのインスタンスビューを参照して、executionMessage、output、error を表示します。 https://aka.ms/runcommandmanaged#get-execution-status-and-results	ブール (bool)

VirtualMachineRunCommandScriptSource

名前	形容	価値
コマンドID	定義済みの組み込みスクリプトの commandId を指定します。	糸
スクリプト	VM で実行するスクリプトコンテンツを指定します。	糸
scriptUri です。	スクリプトのダウンロード場所を指定します。読み取りアクセス権を持つ Azure ストレージ BLOB の SAS URI またはパブリック URI のいずれかを指定できます。	糸
scriptUriManagedIdentity (英語)	Azure Storage BLOB の場合に scriptUri にアクセスできるユーザー割り当てマネージド ID。システム割り当て ID の場合は、空のオブジェクトを使用します。 Azure ストレージ BLOB が存在し、マネージド ID に "ストレージ BLOB データ閲覧者" ロールの割り当てで BLOB のコンテナーへのアクセス権が付与されていることを確認します。ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。マネージド ID と実行コマンドの詳細については、「https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged」を参照してください。	RunCommandManagedIdentity を実行します

使用例

Azure クイックスタートテンプレート

このリソースの種類デプロイする Azure クイックスタートテンプレート次に示します。

テンプレート	形容
GitLabオムニバス Azure にデプロイする	このテンプレートは、パブリック IP の DNS を利用して、パブリック DNS を使用する仮想マシンへの GitLab Omnibus のデプロイを簡略化します。 Standard_F8s_v2 インスタンスサイズを利用します。これは参照アーキテクチャに合わせ、最大 1,000 ユーザー (20 RPS) をサポートします。インスタンスは、セキュリティで保護された接続に Let's Encrypt 証明書と共に HTTPS を使用するように事前構成されています。

テンプレート

形容

GitLabオムニバス

Azure にデプロイする

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

virtualMachines/runCommands リソースの種類は、次をターゲットとする操作と共にデプロイできます。

リソースグループ

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachines/runCommands@2023-07-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      asyncExecution = bool
      errorBlobManagedIdentity = {
        clientId = "string"
        objectId = "string"
      }
      errorBlobUri = "string"
      outputBlobManagedIdentity = {
        clientId = "string"
        objectId = "string"
      }
      outputBlobUri = "string"
      parameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      protectedParameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      runAsPassword = "string"
      runAsUser = "string"
      source = {
        commandId = "string"
        script = "string"
        scriptUri = "string"
        scriptUriManagedIdentity = {
          clientId = "string"
          objectId = "string"
        }
      }
      timeoutInSeconds = int
      treatFailureAsDeploymentFailure = bool
    }
  }
}

プロパティ値

Microsoft.Compute/virtualMachines/runCommands (英語)

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

リソースタグ

名前	形容	価値

RunCommandInputParameter(ランコマンド入力パラメータ)

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

RunCommandManagedIdentity を実行します

名前	形容	価値
クライアントID	ユーザー割り当てマネージド ID のクライアント ID (GUID 値)。 ObjectId を指定する場合は使用しないでください。	糸
オブジェクトID	ユーザー割り当てマネージド ID のオブジェクト ID (GUID 値)。これが指定されている場合は、ClientId を使用しないでください。	糸

VirtualMachineRunCommandプロパティ

名前	形容	価値
非同期実行	随意。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトが完了するまで待機しません。	ブール (bool)
エラーブロブ・マネジメント・アイデンティティ	errorBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てを使用して、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。マネージド ID と実行コマンドの詳細については、https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged を参照してください。	RunCommandManagedIdentity を実行します
エラーブロブリ	スクリプトエラーストリームをアップロードする Azure Storage BLOB を指定します。読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 errorBlobManagedIdentity パラメーターを参照します。	糸
出力ブロブ・マネジメント・アイデンティティ	outputBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てを使用して、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。マネージド ID と実行コマンドの詳細については、https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged を参照してください。	RunCommandManagedIdentity を実行します
出力ブロブURI	スクリプト出力ストリームをアップロードする Azure Storage BLOB を指定します。読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 outputBlobManagedIdentity パラメーターを参照します。	糸
パラメーター	スクリプトで使用されるパラメーター。	RunCommandInputParameter[]
protectedパラメータ	スクリプトで使用されるパラメーター。	RunCommandInputParameter[]
runAsPassword (ランアスパスワード)	実行コマンドの実行時に VM のユーザーアカウントパスワードを指定します。	糸
runAsUser さん	実行コマンドの実行時に VM 上のユーザーアカウントを指定します。	糸
源	実行コマンドスクリプトのソース。	VirtualMachineRunCommandScriptSource
タイムアウトイン秒	run コマンドを実行するためのタイムアウト (秒単位)。	整数 (int)
treatFailureAsDeploymentFailure	随意。 true に設定すると、スクリプト内のエラーはデプロイに失敗し、ProvisioningState は Failed としてマークされます。 false に設定すると、ProvisioningState は、実行コマンドが拡張機能プラットフォームによって実行されたかどうかのみを反映し、スクリプトが失敗した場合にスクリプトが失敗したかどうかを示しません。スクリプトエラーが発生した場合は、run コマンドのインスタンスビューを参照して、executionMessage、output、error を表示します。 https://aka.ms/runcommandmanaged#get-execution-status-and-results	ブール (bool)

VirtualMachineRunCommandScriptSource

名前	形容	価値
コマンドID	定義済みの組み込みスクリプトの commandId を指定します。	糸
スクリプト	VM で実行するスクリプトコンテンツを指定します。	糸
scriptUri です。	スクリプトのダウンロード場所を指定します。読み取りアクセス権を持つ Azure ストレージ BLOB の SAS URI またはパブリック URI のいずれかを指定できます。	糸
scriptUriManagedIdentity (英語)	Azure Storage BLOB の場合に scriptUri にアクセスできるユーザー割り当てマネージド ID。システム割り当て ID の場合は、空のオブジェクトを使用します。 Azure ストレージ BLOB が存在し、マネージド ID に "ストレージ BLOB データ閲覧者" ロールの割り当てで BLOB のコンテナーへのアクセス権が付与されていることを確認します。ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。マネージド ID と実行コマンドの詳細については、「https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged」を参照してください。	RunCommandManagedIdentity を実行します

次の方法で共有

Microsoft.Compute virtualMachines/runCommands 2023-07-01

Bicep リソース定義

リソースの形式

プロパティ値

Microsoft.Compute/virtualMachines/runCommands (英語)

リソースタグ

RunCommandInputParameter(ランコマンド入力パラメータ)

RunCommandManagedIdentity を実行します

VirtualMachineRunCommandプロパティ

VirtualMachineRunCommandScriptSource

使用例

Azure クイック スタートのサンプル

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

リソースの形式

プロパティ値

Microsoft.Compute/virtualMachines/runCommands (英語)

リソースタグ

RunCommandInputParameter(ランコマンド入力パラメータ)

RunCommandManagedIdentity を実行します

VirtualMachineRunCommandプロパティ

VirtualMachineRunCommandScriptSource

使用例

Azure クイック スタート テンプレート

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

リソースの形式

プロパティ値

Microsoft.Compute/virtualMachines/runCommands (英語)

リソースタグ

RunCommandInputParameter(ランコマンド入力パラメータ)

RunCommandManagedIdentity を実行します

VirtualMachineRunCommandプロパティ

VirtualMachineRunCommandScriptSource

フィードバック

その他のリソース

Azure クイックスタートのサンプル

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

Azure クイックスタートテンプレート