Virtual Machines - Run Command

Service:

Compute

API バージョン:

2026-04-01

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

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

URI パラメーター

Name	/	必須	型	説明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前は大文字と小文字を区別しません。
subscriptionId	path	True	string minLength: 1	ターゲット サブスクリプションの ID。
vmName	path	True	string	仮想マシンの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

Name	必須	型	説明
commandId	True	string	定義済みの組み込みスクリプトの commandId を指定します。 Linux で使用可能なコマンド ID は、 https://aka.ms/RunCommandManagedLinux#available-commands、Windows の https://aka.ms/RunCommandManagedWindows#available-commands に記載されています。
parameters		RunCommandInputParameter[]	run コマンド のパラメーター。
script		string[]	Optional. 実行するスクリプト。 この値を指定すると、指定されたスクリプトによってコマンドの既定のスクリプトがオーバーライドされます。

応答

Name	型	説明
200 OK	RunCommandResult	Azureの運用は無事に完了しました。
202 Accepted		リソース操作が受け入れられます。 ヘッダー Location: string Retry-After: integer
Other Status Codes	CloudError	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

Name	説明
user_impersonation	あなたのユーザー アカウントになりすます

例

VirtualMachineRunCommand

要求のサンプル

HTTP

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

{
  "commandId": "RunPowerShellScript"
}

Java

import com.azure.resourcemanager.compute.models.RunCommandInput;

/**
 * Samples for VirtualMachines RunCommand.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-04-01/runCommandExamples/VirtualMachineRunCommand.json
     */
    /**
     * Sample code: VirtualMachineRunCommand.
     * 
     * @param manager Entry point to ComputeManager.
     */
    public static void virtualMachineRunCommand(com.azure.resourcemanager.compute.ComputeManager manager) {
        manager.serviceClient().getVirtualMachines().runCommand("crptestar98131", "vm3036",
            new RunCommandInput().withCommandId("RunPowerShellScript"), com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_run_command.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.virtual_machines.begin_run_command(
        resource_group_name="crptestar98131",
        vm_name="vm3036",
        parameters={"commandId": "RunPowerShellScript"},
    ).result()
    print(response)


# x-ms-original-file: 2026-04-01/runCommandExamples/VirtualMachineRunCommand.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v8"
)

// Generated from example definition: 2026-04-01/runCommandExamples/VirtualMachineRunCommand.json
func ExampleVirtualMachinesClient_BeginRunCommand() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("24fb23e3-6ba3-41f0-9b6e-e41131d5d61e", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewVirtualMachinesClient().BeginRunCommand(ctx, "crptestar98131", "vm3036", armcompute.RunCommandInput{
		CommandID: to.Ptr("RunPowerShellScript"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to poll the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armcompute.VirtualMachinesClientRunCommandResponse{
	// 	RunCommandResult: armcompute.RunCommandResult{
	// 		Value: []*armcompute.InstanceViewStatus{
	// 			{
	// 				Code: to.Ptr("ComponentStatus/StdOut/succeeded"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 				Message: to.Ptr("This is a sample script with parameters value1 value2"),
	// 			},
	// 			{
	// 				Code: to.Ptr("ComponentStatus/StdErr/succeeded"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 				Message: to.Ptr(""),
	// 			},
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to run command on the VM.
 *
 * @summary run command on the VM.
 * x-ms-original-file: 2026-04-01/runCommandExamples/VirtualMachineRunCommand.json
 */
async function virtualMachineRunCommand() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e";
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.runCommand("crptestar98131", "vm3036", {
    commandId: "RunPowerShellScript",
  });
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

200

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

状態コード:

202

Location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2026-04-01

定義

Name	説明
ApiError	API エラー。
ApiErrorBase	API エラーベース。
CloudError	コンピューティング サービスからのエラー応答。
InnerError	内部エラーの詳細。
InstanceViewStatus	インスタンス ビューの状態。
RunCommandInput	仮想マシンのパラメーターをキャプチャします。
RunCommandInputParameter	run コマンド パラメーターのプロパティについて説明します。
RunCommandResult
StatusLevelTypes	レベル コード。

ApiError

Object

API エラー。

Name	型	説明
code	string	エラー コード。
details	ApiErrorBase[]	Api エラーの詳細
innererror	InnerError	Api 内部エラー
message	string	エラー メッセージ。
target	string	特定のエラーのターゲット。

ApiErrorBase

Object

API エラーベース。

Name	型	説明
code	string	エラー コード。
message	string	エラー メッセージ。
target	string	特定のエラーのターゲット。

CloudError

Object

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

Name	型	説明
error	ApiError	API エラー。

InnerError

Object

内部エラーの詳細。

Name	型	説明
errordetail	string	内部エラー メッセージまたは例外ダンプ。
exceptiontype	string	例外の種類。

InstanceViewStatus

Object

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

Name	型	説明
code	string	状態コード。
displayStatus	string	状態の短いローカライズ可能なラベル。
level	StatusLevelTypes	レベル コード。
message	string	アラートやエラー メッセージを含む詳細なステータス メッセージ。
time	string (date-time)	状態の時刻。

RunCommandInput

Object

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

Name	型	説明
commandId	string	定義済みの組み込みスクリプトの commandId を指定します。 Linux で使用可能なコマンド ID は、 https://aka.ms/RunCommandManagedLinux#available-commands、Windows の https://aka.ms/RunCommandManagedWindows#available-commands に記載されています。
parameters	RunCommandInputParameter[]	run コマンド のパラメーター。
script	string[]	Optional. 実行するスクリプト。 この値を指定すると、指定されたスクリプトによってコマンドの既定のスクリプトがオーバーライドされます。

RunCommandInputParameter

Object

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

Name	型	説明
name	string	run コマンド のパラメーター名。
value	string	run コマンド パラメーターの値。

RunCommandResult

Object

Name	型	説明
value	InstanceViewStatus[]	コマンド操作の応答を実行します。

StatusLevelTypes

列挙

レベル コード。

値	説明
Info
Warning
Error