VirtualMachineRunCommand interface

Paket:

@azure/arm-compute

Beschreibt einen Befehl zum Ausführen eines virtuellen Computers.

Extends

Resource

Eigenschaften

asyncExecution	Optional. Wenn true festgelegt ist, wird die Bereitstellung abgeschlossen, sobald das Skript gestartet wird, und wartet nicht auf den Abschluss des Skripts.
errorBlobManagedIdentity	Benutzerseitig zugewiesene verwaltete Identität, die Zugriff auf errorBlobUri-Speicherblob hat. Verwenden Sie ein leeres Objekt bei systemseitig zugewiesener Identität. Stellen Sie sicher, dass die verwaltete Identität zugriff auf den Container des Blobs mit der Rollenzuweisung "Storage Blob Data Contributor" erhalten hat. Stellen Sie bei benutzerseitig zugewiesener 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-Speicherblob an, in das der Skriptfehlerstream hochgeladen wird. Verwenden Sie einen SAS-URI mit Lese-, Anfüge-, Erstellungs- oder Schreibzugriff oder mit verwalteter Identität, um dem virtuellen Computer Zugriff auf das Blob zu gewähren. Weitere Informationen finden Sie unter errorBlobManagedIdentity-Parameter.
instanceView	Der Vm führt den Befehl instance Ansicht aus. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
outputBlobManagedIdentity	Benutzerseitig zugewiesene verwaltete Identität, die Zugriff auf outputBlobUri-Speicherblob hat. Verwenden Sie ein leeres Objekt bei systemseitig zugewiesener Identität. Stellen Sie sicher, dass die verwaltete Identität zugriff auf den Container des Blobs mit der Rollenzuweisung "Storage Blob Data Contributor" erhalten hat. Stellen Sie bei benutzerseitig zugewiesener 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 Skriptausgabestream hochgeladen wird. Verwenden Sie einen SAS-URI mit Lese-, Anfüge-, Erstellungs- oder Schreibzugriff oder mit verwalteter Identität, um dem virtuellen Computer Zugriff auf das Blob zu gewähren. Weitere Informationen finden Sie unter 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 Fehler markiert. Wenn treatFailureAsDeploymentFailure auf false festgelegt ist, gibt ProvisioningState nur an, ob der Ausführungsbefehl von der Erweiterungsplattform ausgeführt wurde oder nicht. Dies gibt nicht an, ob ein Skriptfehler bei Skriptfehlern aufgetreten ist. Siehe instance Ansicht des Ausführungsbefehls bei Skriptfehlern, um executionMessage, Output, Error: HINWEIS: https://aka.ms/runcommandmanaged#get-execution-status-and-results Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
runAsPassword	Gibt das Benutzerkontokennwort auf dem virtuellen Computer an, wenn der Befehl "ausführen" ausgeführt wird.
runAsUser	Gibt das Benutzerkonto auf dem virtuellen Computer an, wenn der Ausführungsbefehl ausgeführt wird.
source	Die Quelle des Ausführungsbefehlsskripts.
timeoutInSeconds	Das Timeout in Sekunden, um den Befehl ausführen zu können.
treatFailureAsDeploymentFailure	Optional. Wenn auf true festgelegt ist, tritt bei jedem Fehler im Skript ein Fehler bei der Bereitstellung auf, und ProvisioningState wird als Fehler markiert. Wenn dieser Wert auf false festgelegt ist, gibt ProvisioningState nur an, ob der Ausführungsbefehl von der Erweiterungsplattform ausgeführt wurde oder nicht. Dies gibt nicht an, ob ein Skriptfehler bei Skriptfehlern aufgetreten ist. Siehe instance Ansicht des Ausführens des Befehls bei Skriptfehlern, um executionMessage, Output, Error zu sehen:https://aka.ms/runcommandmanaged#get-execution-status-and-results

Geerbte Eigenschaften

id	Ressourcen-ID HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
location	Ressourcenspeicherort
name	Ressourcenname HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
tags	Ressourcentags
type	Ressourcentyp HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

Details zur Eigenschaft

asyncExecution

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

asyncExecution?: boolean

Eigenschaftswert

boolean

errorBlobManagedIdentity

Benutzerseitig zugewiesene verwaltete Identität, die Zugriff auf errorBlobUri-Speicherblob hat. Verwenden Sie ein leeres Objekt bei systemseitig zugewiesener Identität. Stellen Sie sicher, dass die verwaltete Identität zugriff auf den Container des Blobs mit der Rollenzuweisung "Storage Blob Data Contributor" erhalten hat. Stellen Sie bei benutzerseitig zugewiesener 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-Speicherblob an, in das der Skriptfehlerstream hochgeladen wird. Verwenden Sie einen SAS-URI mit Lese-, Anfüge-, Erstellungs- oder Schreibzugriff oder mit verwalteter Identität, um dem virtuellen Computer Zugriff auf das Blob zu gewähren. Weitere Informationen finden Sie unter errorBlobManagedIdentity-Parameter.

errorBlobUri?: string

Eigenschaftswert

string

instanceView

Der Vm führt den Befehl instance Ansicht aus. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

instanceView?: VirtualMachineRunCommandInstanceView

Eigenschaftswert

VirtualMachineRunCommandInstanceView

outputBlobManagedIdentity

Benutzerseitig zugewiesene verwaltete Identität, die Zugriff auf outputBlobUri-Speicherblob hat. Verwenden Sie ein leeres Objekt bei systemseitig zugewiesener Identität. Stellen Sie sicher, dass die verwaltete Identität zugriff auf den Container des Blobs mit der Rollenzuweisung "Storage Blob Data Contributor" erhalten hat. Stellen Sie bei benutzerseitig zugewiesener 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 Skriptausgabestream hochgeladen wird. Verwenden Sie einen SAS-URI mit Lese-, Anfüge-, Erstellungs- oder Schreibzugriff oder mit verwalteter Identität, um dem virtuellen Computer Zugriff auf das Blob zu gewähren. Weitere Informationen finden Sie unter 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 Fehler markiert. Wenn treatFailureAsDeploymentFailure auf false festgelegt ist, gibt ProvisioningState nur an, ob der Ausführungsbefehl von der Erweiterungsplattform ausgeführt wurde oder nicht. Dies gibt nicht an, ob ein Skriptfehler bei Skriptfehlern aufgetreten ist. Siehe instance Ansicht des Ausführungsbefehls bei Skriptfehlern, um executionMessage, Output, Error: HINWEIS: https://aka.ms/runcommandmanaged#get-execution-status-and-results Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

provisioningState?: string

Eigenschaftswert

string

runAsPassword

Gibt das Benutzerkontokennwort auf dem virtuellen Computer an, wenn der Befehl "ausführen" 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ührungsbefehlsskripts.

source?: VirtualMachineRunCommandScriptSource

Eigenschaftswert

VirtualMachineRunCommandScriptSource

timeoutInSeconds

Das Timeout in Sekunden, um den Befehl ausführen zu können.

timeoutInSeconds?: number

Eigenschaftswert

number

treatFailureAsDeploymentFailure

Optional. Wenn auf true festgelegt ist, tritt bei jedem Fehler im Skript ein Fehler bei der Bereitstellung auf, und ProvisioningState wird als Fehler markiert. Wenn dieser Wert auf false festgelegt ist, gibt ProvisioningState nur an, ob der Ausführungsbefehl von der Erweiterungsplattform ausgeführt wurde oder nicht. Dies gibt nicht an, ob ein Skriptfehler bei Skriptfehlern aufgetreten ist. Siehe instance Ansicht des Ausführens des Befehls bei Skriptfehlern, um executionMessage, Output, Error zu sehen:https://aka.ms/runcommandmanaged#get-execution-status-and-results

treatFailureAsDeploymentFailure?: boolean

Eigenschaftswert

boolean

Geerbte Eigenschaftsdetails

id

Ressourcen-ID HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

id?: string

Eigenschaftswert

string

Geerbt vonResource.id

location

Ressourcenspeicherort

location: string

Eigenschaftswert

string

Geerbt vonResource.location

name

Ressourcenname HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

name?: string

Eigenschaftswert

string

Geerbt vonResource.name

tags

Ressourcentags

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

Eigenschaftswert

{[propertyName: string]: string}

Geerbt vonResource.tags

type

Ressourcentyp HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

type?: string

Eigenschaftswert

string

Geerbt vonResource.type