Virtual Machine Scale Set VM Run Commands - Get

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=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}?$expand={$expand}&api-version=2022-08-01

Parâmetros de URI

Name In Required Type 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 Microsoft Azure assinatura. 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

Name Type Description
200 OK

OK

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

Other Status Codes

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

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

Segurança

azure_auth

Flow Azure Active Directory OAuth2

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

Scopes

Name 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=2022-08-01

Sample Response

{
  "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": {
      "script": "Write-Host Hello World!"
    },
    "parameters": [
      {
        "name": "param1",
        "value": "value1"
      },
      {
        "name": "param2",
        "value": "value2"
      }
    ],
    "asyncExecution": false,
    "runAsUser": "user1",
    "timeoutInSeconds": 3600,
    "provisioningState": "Succeeded"
  }
}

Definições

ApiError

Erro de API.

ApiErrorBase

Base de erros da API.

CloudError

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

ExecutionState

Status de execução do script.

InnerError

Detalhes do erro interno.

InstanceViewStatus

Status da exibição de instância.

RunCommandInputParameter

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

StatusLevelTypes

O código de nível.

VirtualMachineRunCommand

Descreve um comando de execução da 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.

ApiError

Erro de API.

Name Type Description
code
  • string

O código de erro.

details

Os detalhes do erro da API

innererror

O erro interno da API

message
  • string

A mensagem de erro.

target
  • string

O destino do erro específico.

ApiErrorBase

Base de erros da API.

Name Type 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.

Name Type Description
error

Erro de API.

ExecutionState

Status de execução do script.

Name Type Description
Canceled
  • string
Failed
  • string
Pending
  • string
Running
  • string
Succeeded
  • string
TimedOut
  • string
Unknown
  • string

InnerError

Detalhes do erro interno.

Name Type Description
errordetail
  • string

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

exceptiontype
  • string

O tipo de exceção.

InstanceViewStatus

Status da exibição de instância.

Name Type Description
code
  • string

O código do status.

displayStatus
  • string

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

level

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.

Name Type Description
name
  • string

O nome do parâmetro de comando executar.

value
  • string

O valor do parâmetro de comando executar.

StatusLevelTypes

O código de nível.

Name Type Description
Error
  • string
Info
  • string
Warning
  • string

VirtualMachineRunCommand

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

Name Type Default Value 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.errorBlobUri
  • string

Especifica o blob de armazenamento do Azure em que o fluxo de erros de script será carregado.

properties.instanceView

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

properties.outputBlobUri
  • string

Especifica o blob de armazenamento do Azure em que o fluxo de saída do script será carregado.

properties.parameters

Os parâmetros usados pelo script.

properties.protectedParameters

Os parâmetros usados pelo script.

properties.provisioningState
  • string

O estado de provisionamento, que aparece apenas na resposta.

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

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

properties.timeoutInSeconds
  • integer

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

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.

Name Type Description
endTime
  • string

Hora de término do script.

error
  • string

Fluxo de erro de script.

executionMessage
  • string

Comunicar erros de configuração de script ou mensagens de execução.

executionState

Status de execução do script.

exitCode
  • integer

Sair do código retornado da execução do script.

output
  • string

Fluxo de saída do script.

startTime
  • string

Hora de início do script.

statuses

As informações de status do recurso.

VirtualMachineRunCommandScriptSource

Descreve as fontes de script para o comando executar.

Name Type Description
commandId
  • string

Especifica um commandId do 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.