Compartilhar via


VirtualMachineRunCommand Classe

Descreve um comando de execução de máquina virtual.

As variáveis são preenchidas apenas pelo servidor e serão ignoradas ao enviar uma solicitação.

Todos os parâmetros necessários devem ser preenchidos para enviar ao Azure.

Herança
azure.mgmt.compute.v2023_03_01.models._models_py3.Resource
VirtualMachineRunCommand

Construtor

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

Local do recurso. Obrigatórios.

tags
dict[str, str]

Marcas de recurso.

source
VirtualMachineRunCommandScriptSource

A origem do script de comando de execução.

parameters
list[RunCommandInputParameter]

Os parâmetros usados pelo script.

protected_parameters
list[RunCommandInputParameter]

Os parâmetros usados pelo script.

async_execution
bool

Opcional. Se definido como true, o provisionamento será concluído assim que o script for iniciado e não aguardará a conclusão do script.

run_as_user
str

Especifica a conta de usuário na VM ao executar o comando executar.

run_as_password
str

Especifica a senha da conta de usuário na VM ao executar o comando executar.

timeout_in_seconds
int

O tempo limite em segundos para executar o comando de execução.

output_blob_uri
str

Especifica o blob de armazenamento do Azure em que o fluxo de saída de script será carregado. Use um URI SAS com acesso gerenciado de leitura, acréscimo, criação, gravação ou use a identidade gerenciada para fornecer à VM acesso ao blob. Consulte o parâmetro outputBlobManagedIdentity.

error_blob_uri
str

Especifica o blob de armazenamento do Azure em que o fluxo de erros de script será carregado. Use um URI SAS com acesso gerenciado de leitura, acréscimo, criação, gravação ou use a identidade gerenciada para fornecer à VM acesso ao blob. Consulte o parâmetro errorBlobManagedIdentity.

output_blob_managed_identity
RunCommandManagedIdentity

Identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento outputBlobUri. Use um objeto vazio no caso de identidade atribuída pelo sistema. Verifique se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Colaborador de Dados de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, adicione-a sob a identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.

error_blob_managed_identity
RunCommandManagedIdentity

Identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento errorBlobUri. Use um objeto vazio no caso de identidade atribuída pelo sistema. Verifique se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Colaborador de Dados de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, adicione-a sob a identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.

treat_failure_as_deployment_failure
bool

Opcional. Se definido como true, qualquer falha no script falhará na implantação e ProvisioningState será marcado como Falha. Se definido como false, ProvisioningState refletirá apenas se o comando de execução foi executado ou não pela plataforma de extensões, não indicaria se o script falhou em caso de falhas de script. Confira a exibição de instância do comando run em caso de falhas de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results.

Variáveis

id
str

ID do recurso.

name
str

Nome do recurso.

type
str

Tipo de recurso.

location
str

Local do recurso. Obrigatórios.

tags
dict[str, str]

Marcas de recurso.

source
VirtualMachineRunCommandScriptSource

A origem do script de comando de execução.

parameters
list[RunCommandInputParameter]

Os parâmetros usados pelo script.

protected_parameters
list[RunCommandInputParameter]

Os parâmetros usados pelo script.

async_execution
bool

Opcional. Se definido como true, o provisionamento será concluído assim que o script for iniciado e não aguardará a conclusão do script.

run_as_user
str

Especifica a conta de usuário na VM ao executar o comando executar.

run_as_password
str

Especifica a senha da conta de usuário na VM ao executar o comando executar.

timeout_in_seconds
int

O tempo limite em segundos para executar o comando de execução.

output_blob_uri
str

Especifica o blob de armazenamento do Azure em que o fluxo de saída de script será carregado. Use um URI SAS com acesso gerenciado de leitura, acréscimo, criação, gravação ou use a identidade gerenciada para fornecer à VM acesso ao blob. Consulte o parâmetro outputBlobManagedIdentity.

error_blob_uri
str

Especifica o blob de armazenamento do Azure em que o fluxo de erros de script será carregado. Use um URI SAS com acesso gerenciado de leitura, acréscimo, criação, gravação ou use a identidade gerenciada para fornecer à VM acesso ao blob. Consulte o parâmetro errorBlobManagedIdentity.

output_blob_managed_identity
RunCommandManagedIdentity

Identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento outputBlobUri. Use um objeto vazio no caso de identidade atribuída pelo sistema. Verifique se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Colaborador de Dados de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, adicione-a sob a identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.

error_blob_managed_identity
RunCommandManagedIdentity

Identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento errorBlobUri. Use um objeto vazio no caso de identidade atribuída pelo sistema. Verifique se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Colaborador de Dados de Blob de Armazenamento'. No caso de identidade atribuída pelo usuário, adicione-a sob a identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.

provisioning_state
str

O estado de provisionamento, que aparece apenas na resposta. Se treatFailureAsDeploymentFailure for definido como true, qualquer falha no script falhará na implantação e ProvisioningState será marcada como Falha. Se treatFailureAsDeploymentFailure for definido como false, ProvisioningState refletirá apenas se o comando de execução foi executado ou não pela plataforma de extensões, ele não indicaria se o script falhou em caso de falhas de script. Confira a exibição de instância do comando run em caso de falhas de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results.

instance_view
VirtualMachineRunCommandInstanceView

A exibição da instância de comando de execução da máquina virtual.

treat_failure_as_deployment_failure
bool

Opcional. Se definido como true, qualquer falha no script falhará na implantação e ProvisioningState será marcado como Falha. Se definido como false, ProvisioningState refletirá apenas se o comando de execução foi executado ou não pela plataforma de extensões, não indicaria se o script falhou em caso de falhas de script. Confira a exibição de instância do comando run em caso de falhas de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results.