Virtual Machine Scale Set VM Run Commands - Get

Der Vorgang zum Abrufen des VMSS-VM-Ausführungsbefehls.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}?$expand={$expand}&api-version=2022-08-01

URI-Parameter

Name In Required Type Description
instanceId
path True
  • string

Die Instanz-ID des virtuellen Computers.

resourceGroupName
path True
  • string

Der Name der Ressourcengruppe.

runCommandName
path True
  • string

Der Name des Befehls "Virtueller Computer ausführen"

subscriptionId
path True
  • string

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

vmScaleSetName
path True
  • string

Der Name des VM-Skalierungssatzes.

api-version
query True
  • string

Client-API-Version.

$expand
query
  • string

Der erweiterungsausdruck, der auf den Vorgang angewendet werden soll.

Antworten

Name Type Description
200 OK

OK

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

Other Status Codes

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

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

Sicherheit

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 Identitätswechsel Ihres Benutzerkontos

Beispiele

Get VirtualMachineScaleSet VM run commands.

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand?api-version=2022-08-01

Sample Response

{
  "name": "myRunCommand",
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand",
  "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,
    "runAsUser": "user1",
    "timeoutInSeconds": 3600,
    "provisioningState": "Succeeded"
  }
}

Definitionen

ApiError

API-Fehler.

ApiErrorBase

Api-Fehlerbasis.

CloudError

Eine Fehlerantwort des Compute-Diensts.

ExecutionState

Skriptausführungsstatus.

InnerError

Innere Fehlerdetails.

InstanceViewStatus

Instanzansichtsstatus.

RunCommandInputParameter

Beschreibt die Eigenschaften eines Ausführenbefehlsparameters.

StatusLevelTypes

Der Levelcode.

VirtualMachineRunCommand

Beschreibt einen Befehl zum Ausführen eines virtuellen Computers.

VirtualMachineRunCommandInstanceView

Die Instanzansicht eines virtuellen Computers wird ausgeführt.

VirtualMachineRunCommandScriptSource

Beschreibt die Skriptquellen für den Befehl "Ausführen".

ApiError

API-Fehler.

Name Type Description
code
  • string

Der Fehlercode.

details

Die Api-Fehlerdetails

innererror

Der innere Api-Fehler

message
  • string

Die Fehlermeldung.

target
  • string

Das Ziel des bestimmten Fehlers.

ApiErrorBase

Api-Fehlerbasis.

Name Type Description
code
  • string

Der Fehlercode.

message
  • string

Die Fehlermeldung.

target
  • string

Das Ziel des bestimmten Fehlers.

CloudError

Eine Fehlerantwort des Compute-Diensts.

Name Type Description
error

API-Fehler.

ExecutionState

Skriptausführungsstatus.

Name Type Description
Canceled
  • string
Failed
  • string
Pending
  • string
Running
  • string
Succeeded
  • string
TimedOut
  • string
Unknown
  • string

InnerError

Innere Fehlerdetails.

Name Type Description
errordetail
  • string

Die interne Fehlermeldung oder Ausnahmeabbildbild.

exceptiontype
  • string

Der Ausnahmetyp.

InstanceViewStatus

Instanzansichtsstatus.

Name Type Description
code
  • string

Der Statuscode.

displayStatus
  • string

Die kurze gebietsschemaierbare Bezeichnung für den Status.

level

Der Levelcode.

message
  • string

Die detaillierte Statusmeldung, einschließlich warnungen und Fehlermeldungen.

time
  • string

Die Uhrzeit des Status.

RunCommandInputParameter

Beschreibt die Eigenschaften eines Ausführenbefehlsparameters.

Name Type Description
name
  • string

Der Name des Befehlsparameters.

value
  • string

Der Wert des Befehlsparameters.

StatusLevelTypes

Der Levelcode.

Name Type Description
Error
  • string
Info
  • string
Warning
  • string

VirtualMachineRunCommand

Beschreibt einen Befehl zum Ausführen eines virtuellen Computers.

Name Type Default Value Description
id
  • string

Ressourcen-ID

location
  • string

Ressourcenspeicherort

name
  • string

Ressourcenname

properties.asyncExecution
  • boolean
False

Dies ist optional. Wenn "true" festgelegt ist, wird die Bereitstellung abgeschlossen, sobald das Skript gestartet wird und nicht darauf wartet, dass das Skript abgeschlossen ist.

properties.errorBlobUri
  • string

Gibt den Azure-Speicher-Blob an, in dem Skriptfehlerdatenstrom hochgeladen wird.

properties.instanceView

Der virtuelle Computer führt die Befehlsinstanzansicht aus.

properties.outputBlobUri
  • string

Gibt den Azure-Speicher-Blob an, in dem der Skriptausgabestream hochgeladen wird.

properties.parameters

Die parameter, die vom Skript verwendet werden.

properties.protectedParameters

Die parameter, die vom Skript verwendet werden.

properties.provisioningState
  • string

Der Bereitstellungszustand, der nur in der Antwort angezeigt wird.

properties.runAsPassword
  • string

Gibt das Kennwort des Benutzerkontos auf der VM 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

Die Quelle des Ausführenbefehlsskripts.

properties.timeoutInSeconds
  • integer

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

tags
  • object

Ressourcentags

type
  • string

Ressourcentyp

VirtualMachineRunCommandInstanceView

Die Instanzansicht eines virtuellen Computers wird ausgeführt.

Name Type Description
endTime
  • string

Skript-Endzeit.

error
  • string

Skriptfehlerdatenstrom.

executionMessage
  • string

Kommunizieren von Skriptkonfigurationsfehlern oder Ausführungsnachrichten.

executionState

Skriptausführungsstatus.

exitCode
  • integer

Beenden Sie den von der Skriptausführung zurückgegebenen Code.

output
  • string

Skriptausgabedatenstrom.

startTime
  • string

Skriptstartzeit.

statuses

Die Ressourcenstatusinformationen.

VirtualMachineRunCommandScriptSource

Beschreibt die Skriptquellen für den Befehl "Ausführen".

Name Type Description
commandId
  • string

Gibt eine CommandId von vordefinierten integrierten Skripts an.

script
  • string

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

scriptUri
  • string

Gibt den Speicherort des Skriptdownloads an.