Virtual Machines - Run Command

Služba:

Compute

Verze rozhraní API:

2026-04-01

Spusťte příkaz na virtuálním počítači.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny zdrojů. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
vmName	path	True	string	Název virtuálního počítače.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
commandId	True	string	Určuje commandId předdefinovaného předdefinovaného skriptu. ID příkazů dostupná pro Linux jsou uvedena na https://aka.ms/RunCommandManagedLinux#available-commands, Windows na https://aka.ms/RunCommandManagedWindows#available-commands.
parameters		RunCommandInputParameter[]	Parametry příkazu spustit.
script		string[]	Optional. Skript, který se má spustit. Pokud je tato hodnota zadaná, daný skript přepíše výchozí skript příkazu.

Odpovědi

Name	Typ	Description
200 OK	RunCommandResult	Operace Azure byla úspěšně dokončena.
202 Accepted		Operace prostředku byla přijata. Hlavičky Location: string Retry-After: integer
Other Status Codes	CloudError	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok OAuth2 služby Azure Active Directory.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	vydávat se za svůj uživatelský účet

Příklady

VirtualMachineRunCommand

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

202

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

Definice

Name	Description
ApiError	Chyba rozhraní API
ApiErrorBase	Základ chyb rozhraní API.
CloudError	Odpověď na chybu z výpočetní služby
InnerError	Podrobnosti vnitřní chyby.
InstanceViewStatus	Stav zobrazení instance
RunCommandInput	Zachyťte parametry virtuálního počítače.
RunCommandInputParameter	Popisuje vlastnosti parametru příkazu run.
RunCommandResult
StatusLevelTypes	Kód úrovně.

ApiError

Objekt

Chyba rozhraní API

Name	Typ	Description
code	string	Kód chyby.
details	ApiErrorBase[]	Podrobnosti o chybě rozhraní API
innererror	InnerError	Vnitřní chyba rozhraní API
message	string	Chybová zpráva.
target	string	Cíl konkrétní chyby.

ApiErrorBase

Objekt

Základ chyb rozhraní API.

Name	Typ	Description
code	string	Kód chyby.
message	string	Chybová zpráva.
target	string	Cíl konkrétní chyby.

CloudError

Objekt

Odpověď na chybu z výpočetní služby

Name	Typ	Description
error	ApiError	Chyba rozhraní API

InnerError

Objekt

Podrobnosti vnitřní chyby.

Name	Typ	Description
errordetail	string	Vnitřní chybová zpráva nebo výpis výjimky.
exceptiontype	string	Typ výjimky.

InstanceViewStatus

Objekt

Stav zobrazení instance

Name	Typ	Description
code	string	Stavový kód.
displayStatus	string	Krátký lokalizovatelný popisek stavu.
level	StatusLevelTypes	Kód úrovně.
message	string	Podrobná stavová zpráva, včetně výstrah a chybových zpráv.
time	string (date-time)	Čas stavu.

RunCommandInput

Objekt

Zachyťte parametry virtuálního počítače.

Name	Typ	Description
commandId	string	Určuje commandId předdefinovaného předdefinovaného skriptu. ID příkazů dostupná pro Linux jsou uvedena na https://aka.ms/RunCommandManagedLinux#available-commands, Windows na https://aka.ms/RunCommandManagedWindows#available-commands.
parameters	RunCommandInputParameter[]	Parametry příkazu spustit.
script	string[]	Optional. Skript, který se má spustit. Pokud je tato hodnota zadaná, daný skript přepíše výchozí skript příkazu.

RunCommandInputParameter

Objekt

Popisuje vlastnosti parametru příkazu run.

Name	Typ	Description
name	string	Název parametru příkazu run.
value	string	Hodnota parametru příkazu run.

RunCommandResult

Objekt

Name	Typ	Description
value	InstanceViewStatus[]	Spusťte odpověď na operaci příkazu.

StatusLevelTypes

Výčet

Kód úrovně.

Hodnota	Description
Info
Warning
Error