Virtual Machine Scale Set VMs - Run Command

Service:

Compute

API Version:

2024-03-01

VM スケール セット内の仮想マシンでコマンドを実行します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/runCommand?api-version=2024-03-01

URI パラメーター

名前	/	必須	型	説明
instanceId	path	True	string	仮想マシンのインスタンス ID。
resourceGroupName	path	True	string	リソース グループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
vmScaleSetName	path	True	string	VM スケール セットの名前。
api-version	query	True	string	クライアント API のバージョン。

要求本文

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

名前	必須	型	説明
commandId	True	string	run コマンド ID。
parameters		RunCommandInputParameter[]	run コマンド パラメーター。
script		string[]	省略可能。 実行するスクリプト。 この値を指定すると、指定されたスクリプトによってコマンドの既定のスクリプトがオーバーライドされます。

応答

名前	型	説明
200 OK	RunCommandResult	OK Media Types: "application/json", "text/json"
202 Accepted		同意 Media Types: "application/json", "text/json"

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

VirtualMachineScaleSetVMs_RunCommand

Sample Request

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet/virtualmachines/0/runCommand?api-version=2024-03-01

{
  "commandId": "RunPowerShellScript",
  "script": [
    "Write-Host Hello World!"
  ]
}

Java

import com.azure.resourcemanager.compute.models.RunCommandInput;
import java.util.Arrays;

/**
 * Samples for VirtualMachineScaleSetVMs RunCommand.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/
     * VirtualMachineScaleSetVMRunCommand.json
     */
    /**
     * Sample code: VirtualMachineScaleSetVMs_RunCommand.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualMachineScaleSetVMsRunCommand(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetVMs().runCommand(
            "myResourceGroup", "myVirtualMachineScaleSet", "0", new RunCommandInput()
                .withCommandId("RunPowerShellScript").withScript(Arrays.asList("Write-Host Hello World!")),
            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 typing import Any, IO, Union

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_scale_set_vm_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_machine_scale_set_vms.begin_run_command(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="myVirtualMachineScaleSet",
        instance_id="0",
        parameters={"commandId": "RunPowerShellScript", "script": ["Write-Host Hello World!"]},
    ).result()
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand.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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand.json
func ExampleVirtualMachineScaleSetVMsClient_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("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewVirtualMachineScaleSetVMsClient().BeginRunCommand(ctx, "myResourceGroup", "myVirtualMachineScaleSet", "0", armcompute.RunCommandInput{
		CommandID: to.Ptr("RunPowerShellScript"),
		Script: []*string{
			to.Ptr("Write-Host Hello World!")},
	}, 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 pull 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.RunCommandResult = armcompute.RunCommandResult{
	// 	Value: []*armcompute.InstanceViewStatus{
	// 		{
	// 			Code: to.Ptr("ComponentStatus/StdOut/succeeded"),
	// 			DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 			Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 			Message: to.Ptr("Hello World!"),
	// 		},
	// 		{
	// 			Code: to.Ptr("ComponentStatus/StdErr/succeeded"),
	// 			DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 			Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 			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 a virtual machine in a VM scale set.
 *
 * @summary Run command on a virtual machine in a VM scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand.json
 */
async function virtualMachineScaleSetVMSRunCommand() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "myVirtualMachineScaleSet";
  const instanceId = "0";
  const parameters = {
    commandId: "RunPowerShellScript",
    script: ["Write-Host Hello World!"],
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSetVMs.beginRunCommandAndWait(
    resourceGroupName,
    vmScaleSetName,
    instanceId,
    parameters,
  );
  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

Sample Response

Status code:

200

{
  "value": [
    {
      "code": "ComponentStatus/StdOut/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "message": "Hello World!"
    },
    {
      "code": "ComponentStatus/StdErr/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "message": ""
    }
  ]
}

Status code:

202

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

定義

名前	説明
InstanceViewStatus	インスタンス ビューの状態。
RunCommandInput	仮想マシンのパラメーターをキャプチャします。
RunCommandInputParameter	実行コマンド パラメーターのプロパティについて説明します。
RunCommandResult
StatusLevelTypes	レベル コード。

InstanceViewStatus

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

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

RunCommandInput

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

名前	型	説明
commandId	string	run コマンド ID。
parameters	RunCommandInputParameter[]	run コマンド パラメーター。
script	string[]	省略可能。 実行するスクリプト。 この値を指定すると、指定されたスクリプトによってコマンドの既定のスクリプトがオーバーライドされます。

RunCommandInputParameter

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

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

RunCommandResult

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

StatusLevelTypes

レベル コード。

名前	型	説明
Error	string
Info	string
Warning	string