VirtualMachineRunCommand interface

Paket:

@azure/arm-compute

Beschreibt einen Befehl zum Ausführen eines virtuellen Computers.

Extends

TrackedResource

Eigenschaften

asyncExecution	Wahlfrei. Wenn "true" festgelegt ist, wird die Bereitstellung abgeschlossen, sobald das Skript gestartet wird und nicht auf den Abschluss des Skripts wartet.
errorBlobManagedIdentity	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
errorBlobUri	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".
instanceView	Der virtuelle Computer führt befehlsinstanzansicht aus. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
outputBlobManagedIdentity	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
outputBlobUri	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.
parameters	Die vom Skript verwendeten Parameter.
protectedParameters	Die vom Skript verwendeten Parameter.
provisioningState	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. Siehe Instanzansicht des Ausführungsbefehls bei Skriptfehlern, um executionMessage, Ausgabe, Fehler: https://aka.ms/runcommandmanaged#get-execution-status-and-results HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
runAsPassword	Gibt das Kennwort für das Benutzerkonto auf dem virtuellen Computer an, wenn der Ausführungsbefehl ausgeführt wird.
runAsUser	Gibt das Benutzerkonto auf dem virtuellen Computer an, wenn der Ausführungsbefehl ausgeführt wird.
source	Die Quelle des Ausführen-Befehlsskripts.
timeoutInSeconds	Das Timeout in Sekunden, um den Ausführungsbefehl auszuführen.
treatFailureAsDeploymentFailure	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

Geerbte Eigenschaften

id	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
location	Der geografische Standort, an dem sich die Ressource befindet
name	Der Name der RessourcenHINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
tags	Ressourcentags.
type	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts": Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

Details zur Eigenschaft

asyncExecution

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

asyncExecution?: boolean

Eigenschaftswert

boolean

errorBlobManagedIdentity

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

errorBlobManagedIdentity?: RunCommandManagedIdentity

Eigenschaftswert

RunCommandManagedIdentity

errorBlobUri

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

errorBlobUri?: string

Eigenschaftswert

string

instanceView

Der virtuelle Computer führt befehlsinstanzansicht aus. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

instanceView?: VirtualMachineRunCommandInstanceView

Eigenschaftswert

VirtualMachineRunCommandInstanceView

outputBlobManagedIdentity

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

outputBlobManagedIdentity?: RunCommandManagedIdentity

Eigenschaftswert

RunCommandManagedIdentity

outputBlobUri

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.

outputBlobUri?: string

Eigenschaftswert

string

parameters

Die vom Skript verwendeten Parameter.

parameters?: RunCommandInputParameter[]

Eigenschaftswert

RunCommandInputParameter[]

protectedParameters

Die vom Skript verwendeten Parameter.

protectedParameters?: RunCommandInputParameter[]

Eigenschaftswert

RunCommandInputParameter[]

provisioningState

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. Siehe Instanzansicht des Ausführungsbefehls bei Skriptfehlern, um executionMessage, Ausgabe, Fehler: https://aka.ms/runcommandmanaged#get-execution-status-and-results HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

provisioningState?: string

Eigenschaftswert

string

runAsPassword

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

runAsPassword?: string

Eigenschaftswert

string

runAsUser

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

runAsUser?: string

Eigenschaftswert

string

source

Die Quelle des Ausführen-Befehlsskripts.

source?: VirtualMachineRunCommandScriptSource

Eigenschaftswert

VirtualMachineRunCommandScriptSource

timeoutInSeconds

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

timeoutInSeconds?: number

Eigenschaftswert

number

treatFailureAsDeploymentFailure

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

treatFailureAsDeploymentFailure?: boolean

Eigenschaftswert

boolean

Geerbte Eigenschaftsdetails

id

Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

id?: string

Eigenschaftswert

string

geerbt vonTrackedResource.id

location

Der geografische Standort, an dem sich die Ressource befindet

location: string

Eigenschaftswert

string

geerbt vonTrackedResource.location

name

Der Name der RessourcenHINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

name?: string

Eigenschaftswert

string

geerbt vonTrackedResource.name

systemData

Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

systemData?: SystemData

Eigenschaftswert

SystemData

geerbt vonTrackedResource.systemData-

tags

Ressourcentags.

tags?: {[propertyName: string]: string}

Eigenschaftswert

{[propertyName: string]: string}

vonTrackedResource.tags geerbt

type

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts": Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

type?: string

Eigenschaftswert

string

geerbt vonTrackedResource.type