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


Virtual Machines - Run Command

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

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommand?api-version=2024-03-01

Параметры URI

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

string

Имя группы ресурсов.

subscriptionId
path True

string

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

vmName
path True

string

Имя виртуальной машины.

api-version
query True

string

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

Текст запроса

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

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

string

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

parameters

RunCommandInputParameter[]

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

script

string[]

Необязательный элемент. Выполняемый скрипт. Если это значение задано, заданный скрипт переопределит скрипт по умолчанию для команды .

Ответы

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

RunCommandResult

ОК

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

202 Accepted

Принято

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 олицетворения учетной записи пользователя

Примеры

VirtualMachineRunCommand

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

POST https://management.azure.com/subscriptions/24fb23e3-6ba3-41f0-9b6e-e41131d5d61e/resourceGroups/crptestar98131/providers/Microsoft.Compute/virtualMachines/vm3036/runCommand?api-version=2024-03-01

{
  "commandId": "RunPowerShellScript"
}

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

{
  "value": [
    {
      "code": "ComponentStatus/StdOut/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "message": "This is a sample script with parameters value1 value2"
    },
    {
      "code": "ComponentStatus/StdErr/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "message": ""
    }
  ]
}
Location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2024-03-01

Определения

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

Состояние представления экземпляра.

RunCommandInput

Запись параметров виртуальной машины.

RunCommandInputParameter

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

RunCommandResult
StatusLevelTypes

Код уровня.

InstanceViewStatus

Состояние представления экземпляра.

Имя Тип Описание
code

string

Код состояния.

displayStatus

string

Короткая локализуемая метка состояния.

level

StatusLevelTypes

Код уровня.

message

string

Подробное сообщение о состоянии, в том числе для оповещений и сообщений об ошибках.

time

string

Время состояния.

RunCommandInput

Запись параметров виртуальной машины.

Имя Тип Описание
commandId

string

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

parameters

RunCommandInputParameter[]

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

script

string[]

Необязательный элемент. Выполняемый скрипт. Если это значение задано, заданный скрипт переопределит скрипт по умолчанию для команды .

RunCommandInputParameter

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

Имя Тип Описание
name

string

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

value

string

Значение параметра команды выполнения.

RunCommandResult

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

InstanceViewStatus[]

Выполните ответ командной операции.

StatusLevelTypes

Код уровня.

Имя Тип Описание
Error

string

Info

string

Warning

string