Поделиться через


Virtual Machine Run Commands - Get

Возвращает определенную команду запуска для подписки в расположении.

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

Параметры URI

Имя В Обязательно Тип Описание
commandId
path True

string

Идентификатор команды.

location
path True

string

pattern: ^[-\w\._]+$

Расположение, в котором запрашиваются команды выполнения.

subscriptionId
path True

string

Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.

api-version
query True

string

Версия клиентского API.

Ответы

Имя Тип Описание
200 OK

RunCommandDocument

ХОРОШО

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

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

VirtualMachineRunCommandGet

Образец запроса

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

Пример ответа

{
  "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."
}

Определения

Имя Описание
OperatingSystemTypes

Тип операционной системы.

RunCommandDocument

Описывает свойства команды выполнения.

RunCommandParameterDefinition

Описывает свойства параметра команды run.

OperatingSystemTypes

Тип операционной системы.

Значение Описание
Linux
Windows

RunCommandDocument

Описывает свойства команды выполнения.

Имя Тип Описание
$schema

string

Схема выполнения команды виртуальной машины.

description

string

Описание команды запуска виртуальной машины.

id

string

Идентификатор команды запуска виртуальной машины.

label

string

Метка команды запуска виртуальной машины.

osType

OperatingSystemTypes

Тип операционной системы.

parameters

RunCommandParameterDefinition[]

Параметры, используемые скриптом.

script

string[]

Выполняемый скрипт.

RunCommandParameterDefinition

Описывает свойства параметра команды run.

Имя Тип Default value Описание
defaultValue

string

Значение параметра команды run по умолчанию.

name

string

Имя параметра команды запуска.

required

boolean

False

Обязательный параметр команды run.

type

string

Тип параметра команды run.