Virtual Machines - Run Command

Dienst:: Compute

API-Version:: 2025-11-01

Führen Sie den Befehl auf dem virtuellen Computer aus.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
vmName	path	True	string	Der Name des virtuellen Computers.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
commandId	True	string	Gibt eine CommandId des vordefinierten integrierten Skripts an. Die für Linux verfügbaren Befehls-IDs sind unter https://aka.ms/RunCommandManagedLinux#available-commands, Windows unter https://aka.ms/RunCommandManagedWindows#available-commandsaufgeführt.
parameters		RunCommandInputParameter[]	Die Befehlsparameter ausführen.
script		string[]	Dies ist optional. Das Skript, das ausgeführt werden soll. Wenn dieser Wert angegeben wird, überschreibt das angegebene Skript das Standardskript des Befehls.

Antworten

Name	Typ	Beschreibung
200 OK	RunCommandResult	Azure-Operation erfolgreich abgeschlossen.
202 Accepted		Ressourcenvorgang akzeptiert. Header Location: string Retry-After: integer
Other Status Codes	CloudError	Unerwartete Fehlerantwort.

Name

Typ

Beschreibung

200 OK

RunCommandResult

Azure-Operation erfolgreich abgeschlossen.

202 Accepted

Ressourcenvorgang akzeptiert.

Header

Location: string
Retry-After: integer

Other Status Codes

CloudError

Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

VirtualMachineRunCommand

Beispielanforderung

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

Beispiel für eine Antwort

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

Statuscode:: 202

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

Definitionen

Name	Beschreibung
ApiError	API-Fehler.
ApiErrorBase	API-Fehlerbasis.
CloudError	Eine Fehlerantwort vom Compute-Dienst.
InnerError	Innere Fehlerdetails.
InstanceViewStatus	Instanzansichtsstatus.
RunCommandInput	Erfassen Sie Parameter des virtuellen Computers.
RunCommandInputParameter	Beschreibt die Eigenschaften eines Befehlsparameters für die Ausführung.
RunCommandResult
StatusLevelTypes	Der Ebenencode.

ApiError

Objekt

API-Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	ApiErrorBase[]	Die Details zum API-Fehler
innererror	InnerError	Der innere API-Fehler
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

ApiErrorBase

Objekt

API-Fehlerbasis.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

CloudError

Objekt

Eine Fehlerantwort vom Compute-Dienst.

Name	Typ	Beschreibung
error	ApiError	API-Fehler.

InnerError

Objekt

Innere Fehlerdetails.

Name	Typ	Beschreibung
errordetail	string	Die interne Fehlermeldung oder der Ausnahmedump.
exceptiontype	string	Der Ausnahmetyp.

InstanceViewStatus

Objekt

Instanzansichtsstatus.

Name	Typ	Beschreibung
code	string	Der Statuscode.
displayStatus	string	Die kurze lokalisierbare Bezeichnung für den Status.
level	StatusLevelTypes	Der Ebenencode.
message	string	Die detaillierte Statusmeldung, einschließlich warnungen und Fehlermeldungen.
time	string (date-time)	Die Uhrzeit des Status.

RunCommandInput

Objekt

Erfassen Sie Parameter des virtuellen Computers.

Name	Typ	Beschreibung
commandId	string	Gibt eine CommandId des vordefinierten integrierten Skripts an. Die für Linux verfügbaren Befehls-IDs sind unter https://aka.ms/RunCommandManagedLinux#available-commands, Windows unter https://aka.ms/RunCommandManagedWindows#available-commandsaufgeführt.
parameters	RunCommandInputParameter[]	Die Befehlsparameter ausführen.
script	string[]	Dies ist optional. Das Skript, das ausgeführt werden soll. Wenn dieser Wert angegeben wird, überschreibt das angegebene Skript das Standardskript des Befehls.

RunCommandInputParameter

Objekt

Beschreibt die Eigenschaften eines Befehlsparameters für die Ausführung.

Name	Typ	Beschreibung
name	string	Der Name des Ausführen-Befehlsparameters.
value	string	Der Wert des Ausführen-Befehlsparameters.

RunCommandResult

Objekt

Name	Typ	Beschreibung
value	InstanceViewStatus[]	Ausführen der Befehlsvorgangsantwort.

StatusLevelTypes

Enumeration

Der Ebenencode.

Wert	Beschreibung
Info
Warning
Error