VirtualMachineRunCommand interface
Descreve um comando de execução de Máquina Virtual.
- Extends
Propriedades
| async |
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. |
| error |
Identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento errorBlobUri. Use um objeto vazio em 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, certifique-se de adicioná-la na 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 |
Especifica o blob de armazenamento do Azure em que o fluxo de erros de script será carregado. Use um URI SAS com leitura, acréscimo, criação, acesso de gravação ou use a identidade gerenciada para fornecer acesso à VM ao blob. Consulte o parâmetro errorBlobManagedIdentity. |
| instance |
A máquina virtual executa a exibição da instância de comando. |
| output |
Identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento outputBlobUri. Use um objeto vazio em 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, certifique-se de adicioná-la na identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged |
| output |
Especifica o blob de armazenamento do Azure em que o fluxo de saída do script será carregado. Use um URI SAS com leitura, acréscimo, criação, acesso de gravação ou use a identidade gerenciada para fornecer acesso à VM ao blob. Consulte o parâmetro outputBlobManagedIdentity. |
| parameters | Os parâmetros usados pelo script. |
| protected |
Os parâmetros usados pelo script. |
| provisioning |
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á marcado 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, não indicaria se o script falhou em caso de falhas de script. Consulte a exibição de instância do comando de execução em caso de falhas de script para ver executionMessage, saída, erro: https://aka.ms/runcommandmanaged#get-execution-status-and-results |
| run |
Especifica a senha da conta de usuário na VM ao executar o comando de execução. |
| run |
Especifica a conta de usuário na VM ao executar o comando de execução. |
| source | A origem do script de comando de execução. |
| timeout |
O tempo limite em segundos para executar o comando de execução. |
| treat |
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, ele não indicaria se o script falhou em caso de falhas de script. Consulte a exibição de instância do comando de execução em caso de falhas de script para ver executionMessage, saída, erro: https://aka.ms/runcommandmanaged#get-execution-status-and-results |
Propriedades herdadas
| id | ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| location | A localização geográfica onde o recurso reside |
| name | O nome do recurso |
| system |
Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy. |
| tags | Tags de recursos. |
| type | O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
Detalhes da propriedade
asyncExecution
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.
asyncExecution?: boolean
Valor da propriedade
boolean
errorBlobManagedIdentity
Identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento errorBlobUri. Use um objeto vazio em 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, certifique-se de adicioná-la na identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged
errorBlobManagedIdentity?: RunCommandManagedIdentity
Valor da propriedade
errorBlobUri
Especifica o blob de armazenamento do Azure em que o fluxo de erros de script será carregado. Use um URI SAS com leitura, acréscimo, criação, acesso de gravação ou use a identidade gerenciada para fornecer acesso à VM ao blob. Consulte o parâmetro errorBlobManagedIdentity.
errorBlobUri?: string
Valor da propriedade
string
instanceView
A máquina virtual executa a exibição da instância de comando.
instanceView?: VirtualMachineRunCommandInstanceView
Valor da propriedade
outputBlobManagedIdentity
Identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento outputBlobUri. Use um objeto vazio em 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, certifique-se de adicioná-la na identidade da VM. Para obter mais informações sobre identidade gerenciada e Executar Comando, consulte https://aka.ms/ManagedIdentity e https://aka.ms/RunCommandManaged
outputBlobManagedIdentity?: RunCommandManagedIdentity
Valor da propriedade
outputBlobUri
Especifica o blob de armazenamento do Azure em que o fluxo de saída do script será carregado. Use um URI SAS com leitura, acréscimo, criação, acesso de gravação ou use a identidade gerenciada para fornecer acesso à VM ao blob. Consulte o parâmetro outputBlobManagedIdentity.
outputBlobUri?: string
Valor da propriedade
string
parameters
Os parâmetros usados pelo script.
parameters?: RunCommandInputParameter[]
Valor da propriedade
protectedParameters
Os parâmetros usados pelo script.
protectedParameters?: RunCommandInputParameter[]
Valor da propriedade
provisioningState
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á marcado 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, não indicaria se o script falhou em caso de falhas de script. Consulte a exibição de instância do comando de execução em caso de falhas de script para ver executionMessage, saída, erro: https://aka.ms/runcommandmanaged#get-execution-status-and-results
provisioningState?: string
Valor da propriedade
string
runAsPassword
Especifica a senha da conta de usuário na VM ao executar o comando de execução.
runAsPassword?: string
Valor da propriedade
string
runAsUser
Especifica a conta de usuário na VM ao executar o comando de execução.
runAsUser?: string
Valor da propriedade
string
source
A origem do script de comando de execução.
source?: VirtualMachineRunCommandScriptSource
Valor da propriedade
timeoutInSeconds
O tempo limite em segundos para executar o comando de execução.
timeoutInSeconds?: number
Valor da propriedade
number
treatFailureAsDeploymentFailure
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, ele não indicaria se o script falhou em caso de falhas de script. Consulte a exibição de instância do comando de execução em caso de falhas de script para ver executionMessage, saída, erro: https://aka.ms/runcommandmanaged#get-execution-status-and-results
treatFailureAsDeploymentFailure?: boolean
Valor da propriedade
boolean
Detalhes das propriedades herdadas
id
ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
id?: string
Valor da propriedade
string
herdado deTrackedResource.id
location
A localização geográfica onde o recurso reside
location: string
Valor da propriedade
string
Herdado deTrackedResource.location
name
systemData
Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
systemData?: SystemData
Valor da propriedade
herdado detrackedResource.systemData
tags
Tags de recursos.
tags?: Record<string, string>
Valor da propriedade
Record<string, string>
Herdado deTrackedResource.tags
type
O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"
type?: string
Valor da propriedade
string
Herdado deTrackedResource.type