Virtual Machine Scale Set VM Run Commands - Get

  • Referência
Service:
Compute
API Version:
2024-03-01

A operação para obter o comando de execução da VM VMSS.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}?api-version=2024-03-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}?$expand={$expand}&api-version=2024-03-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
instanceId
 path True

string

A ID da instância da máquina virtual.
resourceGroupName
 path True

string

O nome do grupo de recursos.
runCommandName
 path True

string

O nome do comando de execução da máquina virtual.
subscriptionId
 path True

string

Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
vmScaleSetName
 path True

string

O nome do conjunto de dimensionamento da VM.
api-version
 query True

string

Versão da API do cliente.
$expand
 query

string

A expressão de expansão a ser aplicada na operação.

Respostas

Nome Tipo Description
200 OK

VirtualMachineRunCommand

OK

Media Types: "application/json", "text/json"
Other Status Codes

CloudError

Resposta de erro que descreve por que a operação falhou.

Media Types: "application/json", "text/json"

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

Get VirtualMachineScaleSet VM run commands.

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand?api-version=2024-03-01

Sample Response

Status code:
200 
{
  "name": "myRunCommand",
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand",
  "location": "westus",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "source": {
      "scriptUri": "https://gist.githubusercontent.com/myusername/75fd3634w7511116063c60bcc50bee0/raw/04a4c68ac9e1d36asfasdc64bd1d889b104c7abdb8/HelloWorld.ps1"
    },
    "parameters": [
      {
        "name": "param1",
        "value": "value1"
      },
      {
        "name": "param2",
        "value": "value2"
      }
    ],
    "asyncExecution": false,
    "treatFailureAsDeploymentFailure": false,
    "runAsUser": "user1",
    "timeoutInSeconds": 3600,
    "provisioningState": "Succeeded",
    "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
    "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"
  }
}

Definições

Nome Description
ApiError

Erro de API.
ApiErrorBase

Base de erros de API.
CloudError

Uma resposta de erro do serviço de computação.
ExecutionState

Status de execução de script.
InnerError

Detalhes do erro interno.
InstanceViewStatus

Exibição de instância status.
RunCommandInputParameter

Descreve as propriedades de um parâmetro de comando de execução.
RunCommandManagedIdentity

Contém clientId ou objectId (use apenas um, não ambos) de uma identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento usado em Executar Comando. Use um objeto RunCommandManagedIdentity vazio no caso de identidade atribuída pelo sistema. Verifique se o blob de armazenamento do Azure existe no caso de scriptUri e se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Leitor de Dados de Blob de Armazenamento' com o blob scriptUri e o 'Colaborador de Dados do Blob de Armazenamento' para Blobs de acréscimo (outputBlobUri, errorBlobUri). No caso da identidade atribuída pelo usuário, adicione-a 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.
StatusLevelTypes

O código de nível.
VirtualMachineRunCommand

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

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

Descreve as fontes de script para o comando executar. Use apenas um script, scriptUri, commandId.

ApiError

Erro de API.

Nome Tipo Description
code

string

O código de erro.
details

ApiErrorBase[]

Os detalhes do erro da API
innererror

InnerError

O erro interno da API
message

string

A mensagem de erro.
target

string

O destino do erro específico.

ApiErrorBase

Base de erros de API.

Nome Tipo Description
code

string

O código de erro.
message

string

A mensagem de erro.
target

string

O destino do erro específico.

CloudError

Uma resposta de erro do serviço de computação.

Nome Tipo Description
error

ApiError

Erro de API.

ExecutionState

Status de execução de script.

Nome Tipo Description
Canceled

string

Failed

string

Pending

string

Running

string

Succeeded

string

TimedOut

string

Unknown

string

InnerError

Detalhes do erro interno.

Nome Tipo Description
errordetail

string

A mensagem de erro interna ou despejo de exceção.
exceptiontype

string

O tipo de exceção.

InstanceViewStatus

Exibição de instância status.

Nome Tipo Description
code

string

O código do status.
displayStatus

string

O rótulo localizável curto para o status.
level

StatusLevelTypes

O código de nível.
message

string

A mensagem de status detalhada, inclusive para alertas e mensagens de erro.
time

string

A hora do status.

RunCommandInputParameter

Descreve as propriedades de um parâmetro de comando de execução.

Nome Tipo Description
name

string

O nome do parâmetro de comando de execução.
value

string

O valor do parâmetro de comando de execução.

RunCommandManagedIdentity

Contém clientId ou objectId (use apenas um, não ambos) de uma identidade gerenciada atribuída pelo usuário que tem acesso ao blob de armazenamento usado em Executar Comando. Use um objeto RunCommandManagedIdentity vazio no caso de identidade atribuída pelo sistema. Verifique se o blob de armazenamento do Azure existe no caso de scriptUri e se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função 'Leitor de Dados de Blob de Armazenamento' com o blob scriptUri e o 'Colaborador de Dados do Blob de Armazenamento' para Blobs de acréscimo (outputBlobUri, errorBlobUri). No caso da identidade atribuída pelo usuário, adicione-a 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.

Nome Tipo Description
clientId

string

ID do cliente (valor GUID) da identidade gerenciada atribuída pelo usuário. ObjectId não deverá ser usado se isso for fornecido.
objectId

string

ID do objeto (valor GUID) da identidade gerenciada atribuída pelo usuário. ClientId não deve ser usado se isso for fornecido.

StatusLevelTypes

O código de nível.

Nome Tipo Description
Error

string

Info

string

Warning

string

VirtualMachineRunCommand

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

Nome Tipo Valor padrão Description
id

string

ID do recurso
location

string

Localização do recurso
name

string

Nome do recurso
properties.asyncExecution

boolean

False

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.
properties.errorBlobManagedIdentity

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
properties.errorBlobUri

string

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.
properties.instanceView

VirtualMachineRunCommandInstanceView

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

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
properties.outputBlobUri

string

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.
properties.parameters

RunCommandInputParameter[]

Os parâmetros usados pelo script.
properties.protectedParameters

RunCommandInputParameter[]

Os parâmetros usados pelo script.
properties.provisioningState

string

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
properties.runAsPassword

string

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

string

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

VirtualMachineRunCommandScriptSource

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

integer

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

boolean

False

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
tags

object

Marcações de recursos
type

string

Tipo de recurso

VirtualMachineRunCommandInstanceView

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

Nome Tipo Description
endTime

string

Hora de término do script.
error

string

Fluxo de erros de script.
executionMessage

string

Comunique erros de configuração de script ou mensagens de execução.
executionState

ExecutionState

Status de execução de script.
exitCode

integer

Código de saída retornado da execução do script.
output

string

Fluxo de saída de script.
startTime

string

Hora de início do script.
statuses

InstanceViewStatus[]

O recurso status informações.

VirtualMachineRunCommandScriptSource

Descreve as fontes de script para o comando executar. Use apenas um script, scriptUri, commandId.

Nome Tipo Description
commandId

string

Especifica um commandId de script interno predefinido.
script

string

Especifica o conteúdo do script a ser executado na VM.
scriptUri

string

Especifica o local de download do script. Ele pode ser o URI sas de um blob de armazenamento do Azure com acesso de leitura ou URI público.
scriptUriManagedIdentity

RunCommandManagedIdentity

Identidade gerenciada atribuída pelo usuário que tem acesso ao scriptUri no caso do blob de armazenamento do Azure. Use um objeto vazio no caso de identidade atribuída pelo sistema. Verifique se o blob de armazenamento do Azure existe e se a identidade gerenciada recebeu acesso ao contêiner do blob com a atribuição de função "Leitor 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.