Partilhar via


VirtualMachineRunCommand Classe

Descreve um comando de execução de Máquina Virtual.

As variáveis só são preenchidas pelo servidor e serão ignoradas ao enviar um pedido.

Todos os parâmetros necessários têm de ser preenchidos para serem enviados para o Azure.

Herança
azure.mgmt.compute.v2023_09_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

Localização do recurso. Obrigatório.

tags
dict[str, str]

Etiquetas de recursos.

source
VirtualMachineRunCommandScriptSource

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

parameters
list[RunCommandInputParameter]

Os parâmetros utilizados pelo script.

protected_parameters
list[RunCommandInputParameter]

Os parâmetros utilizados pelo script.

async_execution
bool

Opcional. Se estiver definido como verdadeiro, o aprovisionamento será concluído assim que o script for iniciado e não aguardará pela conclusão do script.

run_as_user
str

Especifica a conta de utilizador na VM ao executar o comando executar.

run_as_password
str

Especifica a palavra-passe da conta de utilizador na VM ao executar o comando executar.

timeout_in_seconds
int

O tempo limite em segundos para executar o comando executar.

output_blob_uri
str

Especifica o blob de armazenamento do Azure onde o fluxo de saída do script será carregado. Utilize um URI de SAS com acesso de leitura, acréscimo, criação, escrita ou utilize a identidade gerida para fornecer à VM acesso ao blob. Veja o parâmetro outputBlobManagedIdentity.

error_blob_uri
str

Especifica o blob de armazenamento do Azure onde o fluxo de erros do script será carregado. Utilize um URI de SAS com acesso de leitura, acréscimo, criação, escrita ou utilize a identidade gerida para fornecer à VM acesso ao blob. Veja o parâmetro errorBlobManagedIdentity.

output_blob_managed_identity
RunCommandManagedIdentity

Identidade gerida atribuída pelo utilizador que tem acesso ao blob de armazenamento outputBlobUri. Utilize um objeto vazio em caso de identidade atribuída pelo sistema. Certifique-se de que foi concedido acesso à identidade gerida ao contentor do blob com a atribuição da função "Contribuidor de Dados de Blobs de Armazenamento". Em caso de identidade atribuída pelo utilizador, certifique-se de que a adiciona na identidade da VM. Para obter mais informações sobre a identidade gerida e o Comando Executar, veja https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.

error_blob_managed_identity
RunCommandManagedIdentity

Identidade gerida atribuída pelo utilizador que tem acesso ao blob de armazenamento errorBlobUri. Utilize um objeto vazio em caso de identidade atribuída pelo sistema. Certifique-se de que foi concedido acesso à identidade gerida ao contentor do blob com a atribuição da função "Contribuidor de Dados de Blobs de Armazenamento". Em caso de identidade atribuída pelo utilizador, certifique-se de que a adiciona na identidade da VM. Para obter mais informações sobre a identidade gerida e o Comando Executar, veja https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.

treat_failure_as_deployment_failure
bool

Opcional. Se estiver definido como verdadeiro, qualquer falha no script falhará na implementação e ProvisioningState será marcado como Falha. Se estiver definido como falso, ProvisioningState só refletiria 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. Veja a vista de instância do comando executar 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

Localização do recurso. Obrigatório.

tags
dict[str, str]

Etiquetas de recursos.

source
VirtualMachineRunCommandScriptSource

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

parameters
list[RunCommandInputParameter]

Os parâmetros utilizados pelo script.

protected_parameters
list[RunCommandInputParameter]

Os parâmetros utilizados pelo script.

async_execution
bool

Opcional. Se estiver definido como verdadeiro, o aprovisionamento será concluído assim que o script for iniciado e não aguardará pela conclusão do script.

run_as_user
str

Especifica a conta de utilizador na VM ao executar o comando executar.

run_as_password
str

Especifica a palavra-passe da conta de utilizador na VM ao executar o comando executar.

timeout_in_seconds
int

O tempo limite em segundos para executar o comando executar.

output_blob_uri
str

Especifica o blob de armazenamento do Azure onde o fluxo de saída do script será carregado. Utilize um URI de SAS com acesso de leitura, acréscimo, criação, escrita ou utilize a identidade gerida para fornecer à VM acesso ao blob. Veja o parâmetro outputBlobManagedIdentity.

error_blob_uri
str

Especifica o blob de armazenamento do Azure onde o fluxo de erros do script será carregado. Utilize um URI de SAS com acesso de leitura, acréscimo, criação, escrita ou utilize a identidade gerida para fornecer à VM acesso ao blob. Veja o parâmetro errorBlobManagedIdentity.

output_blob_managed_identity
RunCommandManagedIdentity

Identidade gerida atribuída pelo utilizador que tem acesso ao blob de armazenamento outputBlobUri. Utilize um objeto vazio em caso de identidade atribuída pelo sistema. Certifique-se de que foi concedido acesso à identidade gerida ao contentor do blob com a atribuição da função "Contribuidor de Dados de Blobs de Armazenamento". Em caso de identidade atribuída pelo utilizador, certifique-se de que a adiciona na identidade da VM. Para obter mais informações sobre a identidade gerida e o Comando Executar, veja https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.

error_blob_managed_identity
RunCommandManagedIdentity

Identidade gerida atribuída pelo utilizador que tem acesso ao blob de armazenamento errorBlobUri. Utilize um objeto vazio em caso de identidade atribuída pelo sistema. Certifique-se de que foi concedido acesso à identidade gerida ao contentor do blob com a atribuição da função "Contribuidor de Dados de Blobs de Armazenamento". Em caso de identidade atribuída pelo utilizador, certifique-se de que a adiciona na identidade da VM. Para obter mais informações sobre a identidade gerida e o Comando Executar, veja https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged.

provisioning_state
str

O estado de aprovisionamento, que só aparece na resposta. Se treatFailureAsDeploymentFailure definido como verdadeiro, qualquer falha no script falhará na implementação e ProvisioningState será marcado como Falha. Se treatFailureAsDeploymentFailure definido como falso, ProvisioningState apenas refletiria 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. Veja a vista de instância do comando executar em caso de falhas de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results.

instance_view
VirtualMachineRunCommandInstanceView

A vista de instância de comandos de execução da máquina virtual.

treat_failure_as_deployment_failure
bool

Opcional. Se estiver definido como verdadeiro, qualquer falha no script falhará na implementação e ProvisioningState será marcado como Falha. Se estiver definido como falso, ProvisioningState só refletiria 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. Veja a vista de instância do comando executar em caso de falhas de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results.