Partilhar via


Virtual Machine Run Commands - Get

Obtém o comando run específico para uma assinatura em um local.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands/{commandId}?api-version=2024-07-01

Parâmetros do URI

Name Em Necessário Tipo Description
commandId
path True

string

A id do comando.

location
path True

string

O local no qual os comandos de execução são consultados.

Padrão Regex: ^[-\w\._]+$

subscriptionId
path True

string

Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.

api-version
query True

string

Versão da API do cliente.

Respostas

Name Tipo Description
200 OK

RunCommandDocument

OK

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

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

VirtualMachineRunCommandGet

Pedido de amostra

GET https://management.azure.com/subscriptions/24fb23e3-6ba3-41f0-9b6e-e41131d5d61e/providers/Microsoft.Compute/locations/SoutheastAsia/runCommands/RunPowerShellScript?api-version=2024-07-01

Resposta da amostra

{
  "script": [
    "param(",
    "    [string]$arg1,",
    "    [string]$arg2",
    ")",
    "Write-Host This is a sample script with parameters $arg1 $arg2"
  ],
  "parameters": [
    {
      "name": "arg1",
      "type": "string",
      "defaultValue": "value1"
    },
    {
      "name": "arg2",
      "type": "string",
      "defaultValue": "value2"
    }
  ],
  "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json",
  "id": "RunPowerShellScript",
  "osType": "Windows",
  "label": "Executes a PowerShell script",
  "description": "Custom multiline PowerShell script should be defined in script property. Optional parameters can be set in parameters property."
}

Definições

Name Description
OperatingSystemTypes

O tipo de sistema operacional.

RunCommandDocument

Descreve as propriedades de um comando Executar.

RunCommandParameterDefinition

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

OperatingSystemTypes

O tipo de sistema operacional.

Name Tipo Description
Linux

string

Windows

string

RunCommandDocument

Descreve as propriedades de um comando Executar.

Name Tipo Description
$schema

string

O esquema de comando de execução da VM.

description

string

A descrição do comando VM run.

id

string

A ID do comando de execução da VM.

label

string

O rótulo do comando VM run.

osType

OperatingSystemTypes

O tipo de sistema operacional.

parameters

RunCommandParameterDefinition[]

Os parâmetros usados pelo script.

script

string[]

O script a ser executado.

RunCommandParameterDefinition

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

Name Tipo Default value Description
defaultValue

string

O valor padrão do parâmetro run command.

name

string

O nome do parâmetro do comando run.

required

boolean

False

O parâmetro run command necessário.

type

string

O tipo de parâmetro run command.