Virtual Machines - Run Command

Run command on the VM.

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

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The name of the resource group.

subscriptionId
path True

string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

vmName
path True

string

The name of the virtual machine.

api-version
query True

string

Client Api Version.

Request Body

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

Name Required Type Description
commandId True

string

The run command id.

parameters

RunCommandInputParameter[]

The run command parameters.

script

string[]

Optional. The script to be executed. When this value is given, the given script will override the default script of the command.

Responses

Name Type Description
200 OK

RunCommandResult

OK

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

202 Accepted

Accepted

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

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

VirtualMachineRunCommand

Sample request

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

{
  "commandId": "RunPowerShellScript"
}

Sample response

{
  "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": ""
    }
  ]
}
Location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2024-03-01

Definitions

Name Description
InstanceViewStatus

Instance view status.

RunCommandInput

Capture Virtual Machine parameters.

RunCommandInputParameter

Describes the properties of a run command parameter.

RunCommandResult
StatusLevelTypes

The level code.

InstanceViewStatus

Instance view status.

Name Type Description
code

string

The status code.

displayStatus

string

The short localizable label for the status.

level

StatusLevelTypes

The level code.

message

string

The detailed status message, including for alerts and error messages.

time

string

The time of the status.

RunCommandInput

Capture Virtual Machine parameters.

Name Type Description
commandId

string

The run command id.

parameters

RunCommandInputParameter[]

The run command parameters.

script

string[]

Optional. The script to be executed. When this value is given, the given script will override the default script of the command.

RunCommandInputParameter

Describes the properties of a run command parameter.

Name Type Description
name

string

The run command parameter name.

value

string

The run command parameter value.

RunCommandResult

Name Type Description
value

InstanceViewStatus[]

Run command operation response.

StatusLevelTypes

The level code.

Name Type Description
Error

string

Info

string

Warning

string