Virtual Machines - Run Command

Voer de opdracht uit op de virtuele machine.

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

URI-parameters

Naam In Vereist Type Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

De naam van de resource group. De naam is hoofdletterongevoelig.

subscriptionId
path True

string

minLength: 1

De ID van het doelabonnement.

vmName
path True

string

De naam van de virtuele machine.

api-version
query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Naam Vereist Type Description
commandId True

string

Hiermee geeft u een commandId van vooraf gedefinieerd ingebouwd script. Opdracht-ID's die beschikbaar zijn voor Linux worden weergegeven op https://aka.ms/RunCommandManagedLinux#available-commands, Windows op https://aka.ms/RunCommandManagedWindows#available-commands.

parameters

RunCommandInputParameter[]

De opdrachtparameters uitvoeren.

script

string[]

Optional. Het script dat moet worden uitgevoerd. Wanneer deze waarde wordt opgegeven, overschrijft het opgegeven script het standaardscript van de opdracht.

Antwoorden

Naam Type Description
200 OK

RunCommandResult

Azure-operatie succesvol voltooid.

202 Accepted

Resourcebewerking geaccepteerd.

Kopteksten

  • Location: string
  • Retry-After: integer
Other Status Codes

CloudError

Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Naam Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

VirtualMachineRunCommand

Voorbeeldaanvraag

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

Voorbeeldrespons

{
  "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=2026-04-01

Definities

Naam Description
ApiError

Api-fout.

ApiErrorBase

Api-foutbasis.

CloudError

Een foutreactie van de Compute-service.

InnerError

Interne foutdetails.

InstanceViewStatus

Status van exemplaarweergave.

RunCommandInput

Parameters voor virtuele machines vastleggen.

RunCommandInputParameter

Beschrijft de eigenschappen van een opdrachtparameter uitvoeren.

RunCommandResult
StatusLevelTypes

De niveaucode.

ApiError

Api-fout.

Naam Type Description
code

string

De foutcode.

details

ApiErrorBase[]

Details van de API-fout

innererror

InnerError

De interne API-fout

message

string

Het foutbericht.

target

string

Het doel van de specifieke fout.

ApiErrorBase

Api-foutbasis.

Naam Type Description
code

string

De foutcode.

message

string

Het foutbericht.

target

string

Het doel van de specifieke fout.

CloudError

Een foutreactie van de Compute-service.

Naam Type Description
error

ApiError

Api-fout.

InnerError

Interne foutdetails.

Naam Type Description
errordetail

string

Het interne foutbericht of de uitzonderingsdump.

exceptiontype

string

Het uitzonderingstype.

InstanceViewStatus

Status van exemplaarweergave.

Naam Type Description
code

string

De statuscode.

displayStatus

string

Het korte lokaliseerbare label voor de status.

level

StatusLevelTypes

De niveaucode.

message

string

Het gedetailleerde statusbericht, inclusief voor waarschuwingen en foutberichten.

time

string (date-time)

Het tijdstip van de status.

RunCommandInput

Parameters voor virtuele machines vastleggen.

Naam Type Description
commandId

string

Hiermee geeft u een commandId van vooraf gedefinieerd ingebouwd script. Opdracht-ID's die beschikbaar zijn voor Linux worden weergegeven op https://aka.ms/RunCommandManagedLinux#available-commands, Windows op https://aka.ms/RunCommandManagedWindows#available-commands.

parameters

RunCommandInputParameter[]

De opdrachtparameters uitvoeren.

script

string[]

Optional. Het script dat moet worden uitgevoerd. Wanneer deze waarde wordt opgegeven, overschrijft het opgegeven script het standaardscript van de opdracht.

RunCommandInputParameter

Beschrijft de eigenschappen van een opdrachtparameter uitvoeren.

Naam Type Description
name

string

De parameternaam van de run-opdracht.

value

string

De parameterwaarde van de opdracht uitvoeren.

RunCommandResult

Naam Type Description
value

InstanceViewStatus[]

Voer het antwoord van de opdrachtbewerking uit.

StatusLevelTypes

De niveaucode.

Waarde Description
Info
Warning
Error