Virtual Machines - Run Command

Hizmet:

Compute

API Sürümü:

2025-11-01

KOMUTUNU VM'de çalıştırın.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. İsim büyük/küçük harfe duyarsızdır.
subscriptionId	path	True	string minLength: 1	Hedef aboneliğin kimliği.
vmName	path	True	string	Sanal makinenin adı.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
commandId	True	string	Önceden tanımlanmış yerleşik betiğin commandId değerini belirtir. Linux için kullanılabilen komut kimlikleri , Windows adresinde https://aka.ms/RunCommandManagedLinux#available-commandshttps://aka.ms/RunCommandManagedWindows#available-commandslistelenmiştir.
parameters		RunCommandInputParameter[]	Komut parametrelerini çalıştırın.
script		string[]	Optional. Yürütülecek komut dosyası. Bu değer verildiğinde, verilen betik komutun varsayılan betiğini geçersiz kılar.

Yanıtlar

Name	Tür	Description
200 OK	RunCommandResult	Azure işlemi başarıyla tamamlandı.
202 Accepted		Kaynak işlemi kabul edildi. Üst Bilgiler Location: string Retry-After: integer
Other Status Codes	CloudError	Beklenmeyen bir hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

VirtualMachineRunCommand

Örnek isteği

HTTP

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

{
  "commandId": "RunPowerShellScript"
}

Java

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

/**
 * Samples for VirtualMachines RunCommand.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-11-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: 2025-11-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: 2025-11-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 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 = 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: 2025-11-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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/Compute/stable/2025-11-01/examples/runCommandExamples/VirtualMachineRunCommand.json
// this example is just showing the usage of "VirtualMachines_RunCommand" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VirtualMachineResource created on azure
// for more information of creating VirtualMachineResource, please refer to the document of VirtualMachineResource
string subscriptionId = "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e";
string resourceGroupName = "crptestar98131";
string vmName = "vm3036";
ResourceIdentifier virtualMachineResourceId = VirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName);
VirtualMachineResource virtualMachine = client.GetVirtualMachineResource(virtualMachineResourceId);

// invoke the operation
RunCommandInput input = new RunCommandInput("RunPowerShellScript");
ArmOperation<VirtualMachineRunCommandResult> lro = await virtualMachine.RunCommandAsync(WaitUntil.Completed, input);
VirtualMachineRunCommandResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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

Örnek yanıt

Durum kodu:

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

Durum kodu:

202

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

Tanımlar

Name	Description
ApiError	API hatası.
ApiErrorBase	Api hata tabanı.
CloudError	İşlem hizmetinden bir hata yanıtı.
InnerError	İç hata ayrıntıları.
InstanceViewStatus	Örnek görünümü durumu.
RunCommandInput	Sanal Makine parametrelerini yakalayın.
RunCommandInputParameter	Bir run komut parametresinin özelliklerini açıklar.
RunCommandResult
StatusLevelTypes	Düzey kodu.

ApiError

Nesne

API hatası.

Name	Tür	Description
code	string	Hata kodu.
details	ApiErrorBase[]	Api hata ayrıntıları
innererror	InnerError	Api iç hatası
message	string	Hata iletisi.
target	string	Belirli bir hatanın hedefi.

ApiErrorBase

Nesne

Api hata tabanı.

Name	Tür	Description
code	string	Hata kodu.
message	string	Hata iletisi.
target	string	Belirli bir hatanın hedefi.

CloudError

Nesne

İşlem hizmetinden bir hata yanıtı.

Name	Tür	Description
error	ApiError	API hatası.

InnerError

Nesne

İç hata ayrıntıları.

Name	Tür	Description
errordetail	string	İç hata iletisi veya özel durum dökümü.
exceptiontype	string	Özel durum türü.

InstanceViewStatus

Nesne

Örnek görünümü durumu.

Name	Tür	Description
code	string	Durum kodu.
displayStatus	string	Durum için kısa yerelleştirilebilir etiket.
level	StatusLevelTypes	Düzey kodu.
message	string	Uyarılar ve hata iletileri dahil olmak üzere ayrıntılı durum iletisi.
time	string (date-time)	Durum zamanı.

RunCommandInput

Nesne

Sanal Makine parametrelerini yakalayın.

Name	Tür	Description
commandId	string	Önceden tanımlanmış yerleşik betiğin commandId değerini belirtir. Linux için kullanılabilen komut kimlikleri , Windows adresinde https://aka.ms/RunCommandManagedLinux#available-commandshttps://aka.ms/RunCommandManagedWindows#available-commandslistelenmiştir.
parameters	RunCommandInputParameter[]	Komut parametrelerini çalıştırın.
script	string[]	Optional. Yürütülecek komut dosyası. Bu değer verildiğinde, verilen betik komutun varsayılan betiğini geçersiz kılar.

RunCommandInputParameter

Nesne

Bir run komut parametresinin özelliklerini açıklar.

Name	Tür	Description
name	string	Komut parametresi adını çalıştırın.
value	string	Komut parametresini çalıştırma değeri.

RunCommandResult

Nesne

Name	Tür	Description
value	InstanceViewStatus[]	Komut işlemi yanıtlarını çalıştırın.

StatusLevelTypes

Numaralandırma

Düzey kodu.

Değer	Description
Info
Warning
Error