Virtual Machine Run Commands - Get
Obtém um comando de execução 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 de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
command
|
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: |
subscription
|
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. |
api-version
|
query | True |
string |
Versão da API do cliente. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
OKEY Media Types: "application/json", "text/json" |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
Nome | Description |
---|---|
user_impersonation | representar sua conta de usuário |
Exemplos
VirtualMachineRunCommandGet
Solicitação de exemplo
Resposta de exemplo
{
"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
Nome | Description |
---|---|
Operating |
O tipo de sistema operacional. |
Run |
Descreve as propriedades de um comando Executar. |
Run |
Descreve as propriedades de um parâmetro de comando de execução. |
OperatingSystemTypes
O tipo de sistema operacional.
Nome | Tipo | Description |
---|---|---|
Linux |
string |
|
Windows |
string |
RunCommandDocument
Descreve as propriedades de um comando Executar.
Nome | Tipo | Description |
---|---|---|
$schema |
string |
O esquema de comando de execução da VM. |
description |
string |
A descrição do comando de execução da VM. |
id |
string |
A ID de comando de execução da VM. |
label |
string |
O rótulo de comando de execução da VM. |
osType |
O tipo de sistema operacional. |
|
parameters |
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.
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
defaultValue |
string |
O valor padrão do parâmetro de comando de execução. |
|
name |
string |
O nome do parâmetro de comando de execução. |
|
required |
boolean |
False |
O parâmetro de comando de execução necessário. |
type |
string |
O tipo de parâmetro de comando de execução. |