Freigeben über


VirtualMachineRunCommand Klasse

Beschreibt einen Befehl zum Ausführen eines virtuellen Computers.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

Zum Senden an Azure müssen alle erforderlichen Parameter aufgefüllt werden.

Vererbung
azure.mgmt.compute.v2023_09_01.models._models_py3.Resource
VirtualMachineRunCommand

Konstruktor

VirtualMachineRunCommand(*, location: str, tags: Dict[str, str] | None = None, source: _models.VirtualMachineRunCommandScriptSource | None = None, parameters: List[_models.RunCommandInputParameter] | None = None, protected_parameters: List[_models.RunCommandInputParameter] | None = None, async_execution: bool = False, run_as_user: str | None = None, run_as_password: str | None = None, timeout_in_seconds: int | None = None, output_blob_uri: str | None = None, error_blob_uri: str | None = None, output_blob_managed_identity: _models.RunCommandManagedIdentity | None = None, error_blob_managed_identity: _models.RunCommandManagedIdentity | None = None, treat_failure_as_deployment_failure: bool = False, **kwargs: Any)

Keyword-Only Parameters

location
str

Ressourcenspeicherort Erforderlich.

tags
dict[str, str]

Ressourcentags.

source
VirtualMachineRunCommandScriptSource

Die Quelle des Ausführungsbefehlsskripts.

parameters
list[RunCommandInputParameter]

Die vom Skript verwendeten Parameter.

protected_parameters
list[RunCommandInputParameter]

Die vom Skript verwendeten Parameter.

async_execution
bool

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

run_as_user
str

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

run_as_password
str

Gibt das Benutzerkontokennwort auf dem virtuellen Computer an, wenn der Befehl "ausführen" ausgeführt wird.

timeout_in_seconds
int

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

output_blob_uri
str

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.

error_blob_uri
str

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.

output_blob_managed_identity
RunCommandManagedIdentity

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.

error_blob_managed_identity
RunCommandManagedIdentity

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.

treat_failure_as_deployment_failure
bool

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.

Variablen

id
str

Ressourcen-ID.

name
str

Name der Ressource.

type
str

Der Ressourcentyp.

location
str

Ressourcenspeicherort Erforderlich.

tags
dict[str, str]

Ressourcentags.

source
VirtualMachineRunCommandScriptSource

Die Quelle des Ausführungsbefehlsskripts.

parameters
list[RunCommandInputParameter]

Die vom Skript verwendeten Parameter.

protected_parameters
list[RunCommandInputParameter]

Die vom Skript verwendeten Parameter.

async_execution
bool

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

run_as_user
str

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

run_as_password
str

Gibt das Benutzerkontokennwort auf dem virtuellen Computer an, wenn der Befehl "ausführen" ausgeführt wird.

timeout_in_seconds
int

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

output_blob_uri
str

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.

error_blob_uri
str

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.

output_blob_managed_identity
RunCommandManagedIdentity

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.

error_blob_managed_identity
RunCommandManagedIdentity

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.

provisioning_state
str

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ührens des Befehls bei Skriptfehlern, um executionMessage, Output, Error zu sehen: https://aka.ms/runcommandmanaged#get-execution-status-and-results.

instance_view
VirtualMachineRunCommandInstanceView

Der Vm führt den Befehl instance Ansicht aus.

treat_failure_as_deployment_failure
bool

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.