Compartir a través de


VirtualMachineRunCommand Clase

Describe un comando de ejecución de máquina virtual.

Las variables solo se rellenan mediante el servidor y se omitirán al enviar una solicitud.

Todos los parámetros necesarios deben rellenarse para enviarlos a Azure.

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

Constructor

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

Ubicación del recurso Necesario.

tags
dict[str, str]

Etiquetas del recurso.

source
VirtualMachineRunCommandScriptSource

Origen del script de comando de ejecución.

parameters
list[RunCommandInputParameter]

Parámetros usados por el script.

protected_parameters
list[RunCommandInputParameter]

Parámetros usados por el script.

async_execution
bool

Opcional. Si se establece en true, el aprovisionamiento se completará en cuanto se inicie el script y no esperará a que se complete el script.

run_as_user
str

Especifica la cuenta de usuario en la máquina virtual al ejecutar el comando run.

run_as_password
str

Especifica la contraseña de la cuenta de usuario en la máquina virtual al ejecutar el comando run.

timeout_in_seconds
int

Tiempo de espera en segundos para ejecutar el comando run.

output_blob_uri
str

Especifica el blob de Azure Storage donde se cargará el flujo de salida del script. Use un URI de SAS con lectura, anexión, creación, acceso de escritura O use la identidad administrada para proporcionar acceso a la máquina virtual al blob. Consulte el parámetro outputBlobManagedIdentity.

error_blob_uri
str

Especifica el blob de Azure Storage donde se cargará el flujo de error del script. Use un URI de SAS con lectura, anexión, creación, acceso de escritura O use la identidad administrada para proporcionar acceso a la máquina virtual al blob. Consulte el parámetro errorBlobManagedIdentity.

output_blob_managed_identity
RunCommandManagedIdentity

Identidad administrada asignada por el usuario que tiene acceso al blob de almacenamiento outputBlobUri. Use un objeto vacío en caso de identidad asignada por el sistema. Asegúrese de que se ha concedido acceso a la identidad administrada al contenedor del blob con la asignación de roles "Colaborador de datos de Storage Blob". En el caso de la identidad asignada por el usuario, asegúrese de agregarla en la identidad de la máquina virtual. Para obtener más información sobre la identidad administrada y Ejecutar comando, consulte https://aka.ms/ManagedIdentity y https://aka.ms/RunCommandManaged.

error_blob_managed_identity
RunCommandManagedIdentity

Identidad administrada asignada por el usuario que tiene acceso al blob de almacenamiento errorBlobUri. Use un objeto vacío en caso de identidad asignada por el sistema. Asegúrese de que se ha concedido acceso a la identidad administrada al contenedor del blob con la asignación de roles "Colaborador de datos de Storage Blob". En el caso de la identidad asignada por el usuario, asegúrese de agregarla en la identidad de la máquina virtual. Para obtener más información sobre la identidad administrada y Ejecutar comando, consulte https://aka.ms/ManagedIdentity y https://aka.ms/RunCommandManaged.

treat_failure_as_deployment_failure
bool

Opcional. Si se establece en true, cualquier error en el script producirá un error en la implementación y ProvisioningState se marcará como Error. Si se establece en false, ProvisioningState solo reflejaría si la plataforma de extensiones ejecutó o no el comando de ejecución, no indicaría si se produjo un error en el script en caso de errores de script. Consulte la vista de instancia del comando run en caso de errores de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results.

Variables

id
str

Identificador de recurso.

name
str

Nombre del recurso.

type
str

Tipo de recurso.

location
str

Ubicación del recurso Necesario.

tags
dict[str, str]

Etiquetas del recurso.

source
VirtualMachineRunCommandScriptSource

Origen del script de comando de ejecución.

parameters
list[RunCommandInputParameter]

Parámetros usados por el script.

protected_parameters
list[RunCommandInputParameter]

Parámetros usados por el script.

async_execution
bool

Opcional. Si se establece en true, el aprovisionamiento se completará en cuanto se inicie el script y no esperará a que se complete el script.

run_as_user
str

Especifica la cuenta de usuario en la máquina virtual al ejecutar el comando run.

run_as_password
str

Especifica la contraseña de la cuenta de usuario en la máquina virtual al ejecutar el comando run.

timeout_in_seconds
int

Tiempo de espera en segundos para ejecutar el comando run.

output_blob_uri
str

Especifica el blob de Azure Storage donde se cargará el flujo de salida del script. Use un URI de SAS con lectura, anexión, creación, acceso de escritura O use la identidad administrada para proporcionar acceso a la máquina virtual al blob. Consulte el parámetro outputBlobManagedIdentity.

error_blob_uri
str

Especifica el blob de Azure Storage donde se cargará el flujo de error del script. Use un URI de SAS con lectura, anexión, creación, acceso de escritura O use la identidad administrada para proporcionar acceso a la máquina virtual al blob. Consulte el parámetro errorBlobManagedIdentity.

output_blob_managed_identity
RunCommandManagedIdentity

Identidad administrada asignada por el usuario que tiene acceso al blob de almacenamiento outputBlobUri. Use un objeto vacío en caso de identidad asignada por el sistema. Asegúrese de que se ha concedido acceso a la identidad administrada al contenedor del blob con la asignación de roles "Colaborador de datos de Storage Blob". En el caso de la identidad asignada por el usuario, asegúrese de agregarla en la identidad de la máquina virtual. Para obtener más información sobre la identidad administrada y Ejecutar comando, consulte https://aka.ms/ManagedIdentity y https://aka.ms/RunCommandManaged.

error_blob_managed_identity
RunCommandManagedIdentity

Identidad administrada asignada por el usuario que tiene acceso al blob de almacenamiento errorBlobUri. Use un objeto vacío en caso de identidad asignada por el sistema. Asegúrese de que se ha concedido acceso a la identidad administrada al contenedor del blob con la asignación de roles "Colaborador de datos de Storage Blob". En el caso de la identidad asignada por el usuario, asegúrese de agregarla en la identidad de la máquina virtual. Para obtener más información sobre la identidad administrada y Ejecutar comando, consulte https://aka.ms/ManagedIdentity y https://aka.ms/RunCommandManaged.

provisioning_state
str

Estado de aprovisionamiento, que solo aparece en la respuesta. Si treatFailureAsDeploymentFailure se establece en true, cualquier error en el script producirá un error en la implementación y ProvisioningState se marcará como Error. Si treatFailureAsDeploymentFailure se establece en false, ProvisioningState solo reflejaría si la plataforma de extensiones ejecutó o no el comando de ejecución, no indicaría si se produjo un error en el script en caso de errores de script. Consulte la vista de instancia del comando run en caso de errores de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results.

instance_view
VirtualMachineRunCommandInstanceView

Vista de la instancia de comandos de ejecución de la máquina virtual.

treat_failure_as_deployment_failure
bool

Opcional. Si se establece en true, cualquier error en el script producirá un error en la implementación y ProvisioningState se marcará como Error. Si se establece en false, ProvisioningState solo reflejaría si la plataforma de extensiones ejecutó o no el comando de ejecución, no indicaría si se produjo un error en el script en caso de errores de script. Consulte la vista de instancia del comando run en caso de errores de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results.