Freigeben über


Virtual Machine Run Commands - List By Virtual Machine

Der Vorgang zum Abrufen aller Ausführungsbefehle eines virtuellen Computers.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands?api-version=2024-03-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands?$expand={$expand}&api-version=2024-03-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

Der Name der Ressourcengruppe.

subscriptionId
path True

string

Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

vmName
path True

string

Der Name des virtuellen Computers, der den Befehl "Ausführen" enthält.

api-version
query True

string

Client-API-Version.

$expand
query

string

Der erweiterungsausdruck, der für den Vorgang angewendet werden soll.

Antworten

Name Typ Beschreibung
200 OK

VirtualMachineRunCommandsListResult

OKAY

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

Other Status Codes

CloudError

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

List run commands in a Virtual Machine.

Beispielanforderung

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands?api-version=2024-03-01

Beispiel für eine Antwort

{
  "value": [
    {
      "name": "myRunCommand",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand",
      "type": "Microsoft.Compute/virtualMachines/runCommands",
      "location": "westus",
      "tags": {
        "tag1": "value1",
        "tag2": "value2"
      },
      "properties": {
        "source": {
          "script": "Write-Host Hello World!"
        },
        "parameters": [
          {
            "name": "param1",
            "value": "value1"
          },
          {
            "name": "param2",
            "value": "value2"
          }
        ],
        "asyncExecution": false,
        "treatFailureAsDeploymentFailure": false,
        "runAsUser": "user1",
        "timeoutInSeconds": 0,
        "provisioningState": "Succeeded",
        "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
        "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"
      }
    }
  ]
}

Definitionen

Name Beschreibung
ApiError

API-Fehler.

ApiErrorBase

API-Fehlerbasis.

CloudError

Eine Fehlerantwort des Computediensts.

ExecutionState

Skriptausführungsstatus.

InnerError

Innere Fehlerdetails.

InstanceViewStatus

Instanzansichtsstatus.

RunCommandInputParameter

Beschreibt die Eigenschaften eines Ausführungsbefehlsparameters.

RunCommandManagedIdentity

Enthält "clientId" oder "objectId" (verwenden Sie nur eine, nicht beide) einer vom Benutzer zugewiesenen verwalteten Identität, die Zugriff auf speicher-BLOB hat, die im Befehl "Ausführen" verwendet wird. Verwenden Sie ein leeres RunCommandManagedIdentity -Objekt im Fall der vom System zugewiesenen Identität. Stellen Sie sicher, dass das Azure Storage-Blob im Falle von scriptUri vorhanden ist, und der verwaltete Identität wurde Zugriff auf den Container des Blobs mit der Rollenzuweisung "Storage Blob Data Reader" mit scriptUri-Blob und "Storage Blob Data Contributor" für Append blobs(outputBlobUri, errorBlobUri) gewährt. Stellen Sie bei der vom Benutzer zugewiesenen Identität sicher, dass Sie sie unter der Identität des virtuellen Computers hinzufügen. Weitere Informationen zu verwalteter Identität und Befehl ausführen finden Sie unter https://aka.ms/ManagedIdentity und https://aka.ms/RunCommandManaged.

StatusLevelTypes

Der Ebenencode.

VirtualMachineRunCommand

Beschreibt einen Befehl zum Ausführen eines virtuellen Computers.

VirtualMachineRunCommandInstanceView

Die Instanzansicht eines Ausführungsbefehls eines virtuellen Computers.

VirtualMachineRunCommandScriptSource

Beschreibt die Skriptquellen für den Ausführungsbefehl. Verwenden Sie nur ein Skript, scriptUri, commandId.

VirtualMachineRunCommandsListResult

Antwort des Befehlsvorgangs "Auflisten ausführen"

ApiError

API-Fehler.

Name Typ Beschreibung
code

string

Der Fehlercode.

details

ApiErrorBase[]

Die API-Fehlerdetails

innererror

InnerError

Interner API-Fehler

message

string

Die Fehlermeldung.

target

string

Das Ziel des bestimmten Fehlers.

ApiErrorBase

API-Fehlerbasis.

Name Typ Beschreibung
code

string

Der Fehlercode.

message

string

Die Fehlermeldung.

target

string

Das Ziel des bestimmten Fehlers.

CloudError

Eine Fehlerantwort des Computediensts.

Name Typ Beschreibung
error

ApiError

API-Fehler.

ExecutionState

Skriptausführungsstatus.

Name Typ Beschreibung
Canceled

string

Failed

string

Pending

string

Running

string

Succeeded

string

TimedOut

string

Unknown

string

InnerError

Innere Fehlerdetails.

Name Typ Beschreibung
errordetail

string

Die interne Fehlermeldung oder das Ausnahmeabbild.

exceptiontype

string

Der Ausnahmetyp.

InstanceViewStatus

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

Die Uhrzeit des Status.

RunCommandInputParameter

Beschreibt die Eigenschaften eines Ausführungsbefehlsparameters.

Name Typ Beschreibung
name

string

Der Name des Ausführen-Befehlsparameters.

value

string

Der Wert des Ausführen-Befehlsparameters.

RunCommandManagedIdentity

Enthält "clientId" oder "objectId" (verwenden Sie nur eine, nicht beide) einer vom Benutzer zugewiesenen verwalteten Identität, die Zugriff auf speicher-BLOB hat, die im Befehl "Ausführen" verwendet wird. Verwenden Sie ein leeres RunCommandManagedIdentity -Objekt im Fall der vom System zugewiesenen Identität. Stellen Sie sicher, dass das Azure Storage-Blob im Falle von scriptUri vorhanden ist, und der verwaltete Identität wurde Zugriff auf den Container des Blobs mit der Rollenzuweisung "Storage Blob Data Reader" mit scriptUri-Blob und "Storage Blob Data Contributor" für Append blobs(outputBlobUri, errorBlobUri) gewährt. Stellen Sie bei der vom Benutzer zugewiesenen Identität sicher, dass Sie sie unter der Identität des virtuellen Computers hinzufügen. Weitere Informationen zu verwalteter Identität und Befehl ausführen finden Sie unter https://aka.ms/ManagedIdentity und https://aka.ms/RunCommandManaged.

Name Typ Beschreibung
clientId

string

Client-ID (GUID-Wert) der vom Benutzer zugewiesenen verwalteten Identität. ObjectId sollte nicht verwendet werden, wenn dies angegeben wird.

objectId

string

Objekt-ID (GUID-Wert) der vom Benutzer zugewiesenen verwalteten Identität. ClientId sollte nicht verwendet werden, wenn dies angegeben wird.

StatusLevelTypes

Der Ebenencode.

Name Typ Beschreibung
Error

string

Info

string

Warning

string

VirtualMachineRunCommand

Beschreibt einen Befehl zum Ausführen eines virtuellen Computers.

Name Typ Standardwert Beschreibung
id

string

Ressourcen-ID

location

string

Ressourcenspeicherort

name

string

Ressourcenname

properties.asyncExecution

boolean

False

Wahlfrei. Wenn "true" festgelegt ist, wird die Bereitstellung abgeschlossen, sobald das Skript gestartet wird und nicht auf den Abschluss des Skripts wartet.

properties.errorBlobManagedIdentity

RunCommandManagedIdentity

Vom Benutzer zugewiesene verwaltete Identität, die Zugriff auf den FehlerBlobUri-Speicherblob hat. Verwenden Sie ein leeres Objekt im Fall der vom System zugewiesenen Identität. Stellen Sie sicher, dass der Container eines Blobs mit der Rollenzuweisung "Storage Blob Data Contributor" auf verwaltete Identität zugreifen konnte. Stellen Sie bei der vom Benutzer zugewiesenen Identität sicher, dass Sie sie unter der Identität des virtuellen Computers hinzufügen. Weitere Informationen zu verwalteter Identität und Befehl ausführen finden Sie unter https://aka.ms/ManagedIdentity und https://aka.ms/RunCommandManaged

properties.errorBlobUri

string

Gibt das Azure Storage-Blob an, bei dem der Skriptfehlerdatenstrom hochgeladen wird. Verwenden Sie einen SAS-URI mit Lese-, Anfüge-, Erstellungs-, Schreibzugriff ODER verwalteter Identität, um den VM-Zugriff auf das Blob bereitzustellen. Verweisen Sie auf den Parameter "errorBlobManagedIdentity".

properties.instanceView

VirtualMachineRunCommandInstanceView

Der virtuelle Computer führt befehlsinstanzansicht aus.

properties.outputBlobManagedIdentity

RunCommandManagedIdentity

Vom Benutzer zugewiesene verwaltete Identität, die Zugriff auf outputBlobUri-Speicherblob hat. Verwenden Sie ein leeres Objekt im Fall der vom System zugewiesenen Identität. Stellen Sie sicher, dass der Container eines Blobs mit der Rollenzuweisung "Storage Blob Data Contributor" auf verwaltete Identität zugreifen konnte. Stellen Sie bei der vom Benutzer zugewiesenen Identität sicher, dass Sie sie unter der Identität des virtuellen Computers hinzufügen. Weitere Informationen zu verwalteter Identität und Befehl ausführen finden Sie unter https://aka.ms/ManagedIdentity und https://aka.ms/RunCommandManaged

properties.outputBlobUri

string

Gibt das Azure Storage-Blob an, in das der Skriptausgabedatenstrom hochgeladen wird. Verwenden Sie einen SAS-URI mit Lese-, Anfüge-, Erstellungs-, Schreibzugriff ODER verwalteter Identität, um den VM-Zugriff auf das Blob bereitzustellen. Verweisen Sie auf outputBlobManagedIdentity-Parameter.

properties.parameters

RunCommandInputParameter[]

Die vom Skript verwendeten Parameter.

properties.protectedParameters

RunCommandInputParameter[]

Die vom Skript verwendeten Parameter.

properties.provisioningState

string

Der Bereitstellungsstatus, der nur in der Antwort angezeigt wird. Wenn "TreatFailureAsDeploymentFailure" auf "true" festgelegt ist, schlägt jeder Fehler im Skript die Bereitstellung fehl, und ProvisioningState wird als fehlgeschlagen markiert. Wenn "TreatFailureAsDeploymentFailure" auf "false" festgelegt ist, gibt ProvisioningState nur an, ob der Ausführungsbefehl von der Erweiterungsplattform ausgeführt wurde oder nicht, es würde nicht angegeben, ob das Skript bei Skriptfehlern fehlgeschlagen ist. Anzeigen der Instanzansicht des Ausführungsbefehls im Falle von Skriptfehlern zum Anzeigen von executionMessage, Ausgabe, Fehler: https://aka.ms/runcommandmanaged#get-execution-status-and-results

properties.runAsPassword

string

Gibt das Kennwort für das Benutzerkonto auf dem virtuellen Computer an, wenn der Ausführungsbefehl ausgeführt wird.

properties.runAsUser

string

Gibt das Benutzerkonto auf dem virtuellen Computer an, wenn der Ausführungsbefehl ausgeführt wird.

properties.source

VirtualMachineRunCommandScriptSource

Die Quelle des Ausführen-Befehlsskripts.

properties.timeoutInSeconds

integer

Das Timeout in Sekunden, um den Ausführungsbefehl auszuführen.

properties.treatFailureAsDeploymentFailure

boolean

False

Wahlfrei. Wenn dieser Wert auf "true" festgelegt ist, schlägt ein Fehler im Skript fehl, und "ProvisioningState" wird als fehlgeschlagen markiert. Wenn dieser Wert auf "false" festgelegt ist, gibt ProvisioningState nur an, ob der Ausführungsbefehl von der Erweiterungsplattform ausgeführt wurde oder nicht, es würde nicht angegeben, ob das Skript bei Skriptfehlern fehlgeschlagen ist. Anzeigen der Instanzansicht des Ausführungsbefehls im Falle von Skriptfehlern zum Anzeigen von executionMessage, Ausgabe, Fehler: https://aka.ms/runcommandmanaged#get-execution-status-and-results

tags

object

Ressourcentags

type

string

Ressourcentyp

VirtualMachineRunCommandInstanceView

Die Instanzansicht eines Ausführungsbefehls eines virtuellen Computers.

Name Typ Beschreibung
endTime

string

Skript-Endzeit.

error

string

Skriptfehlerdatenstrom.

executionMessage

string

Kommunizieren von Skriptkonfigurationsfehlern oder Ausführungsmeldungen.

executionState

ExecutionState

Skriptausführungsstatus.

exitCode

integer

Exit code returned from script execution.

output

string

Skriptausgabedatenstrom.

startTime

string

Startzeit des Skripts.

statuses

InstanceViewStatus[]

Die Ressourcenstatusinformationen.

VirtualMachineRunCommandScriptSource

Beschreibt die Skriptquellen für den Ausführungsbefehl. Verwenden Sie nur ein Skript, scriptUri, commandId.

Name Typ Beschreibung
commandId

string

Gibt eine CommandId des vordefinierten integrierten Skripts an.

script

string

Gibt den Skriptinhalt an, der auf dem virtuellen Computer ausgeführt werden soll.

scriptUri

string

Gibt den Speicherort für den Skriptdownload an. Es kann entweder SAS-URI eines Azure Storage-Blobs mit Lesezugriff oder öffentlicher URI sein.

scriptUriManagedIdentity

RunCommandManagedIdentity

Vom Benutzer zugewiesene verwaltete Identität, die Zugriff auf ScriptUri im Falle eines Azure Storage-BLOB hat. Verwenden Sie ein leeres Objekt im Fall der vom System zugewiesenen Identität. Stellen Sie sicher, dass das Azure Storage-Blob vorhanden ist, und die verwaltete Identität wurde zugriff auf den Container des Blobs mit der Rollenzuweisung "Storage Blob Data Reader" erhalten. Stellen Sie bei der vom Benutzer zugewiesenen Identität sicher, dass Sie sie unter der Identität des virtuellen Computers hinzufügen. Weitere Informationen zu verwalteter Identität und Befehl ausführen finden Sie unter https://aka.ms/ManagedIdentity und https://aka.ms/RunCommandManaged.

VirtualMachineRunCommandsListResult

Antwort des Befehlsvorgangs "Auflisten ausführen"

Name Typ Beschreibung
nextLink

string

Der URI zum Abrufen der nächsten Seite der Ausführungsbefehle.

value

VirtualMachineRunCommand[]

Die Liste der Ausführungsbefehle