Virtual Machines - Run Command
Выполните команду на виртуальной машине.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommand?api-version=2025-11-01
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Имя группы ресурсов. Имя регистронезависимо. |
|
subscription
|
path | True |
string minLength: 1 |
Идентификатор целевой подписки. |
|
vm
|
path | True |
string |
Имя виртуальной машины. |
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для данной операции. |
Текст запроса
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| commandId | True |
string |
Задает идентификатор командной строки предопределенного встроенного скрипта. Идентификаторы команд, доступные для Linux, перечислены по адресу https://aka.ms/RunCommandManagedLinux#available-commands, Windows по адресу https://aka.ms/RunCommandManagedWindows#available-commands. |
| parameters |
Параметры команды выполнения. |
||
| script |
string[] |
Необязательно. Скрипт, который должен быть выполнен. Если это значение задано, данный скрипт переопределит скрипт по умолчанию команды. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Операция Azure успешно завершена. |
|
| 202 Accepted |
Операция ресурса принята. Заголовки
|
|
| Other Status Codes |
Непредвиденное сообщение об ошибке. |
Безопасность
azure_auth
Azure Active Directory OAuth2 Flow.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| user_impersonation | олицетворения учетной записи пользователя |
Примеры
VirtualMachineRunCommand
Образец запроса
Пример ответа
{
"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=2025-04-01
Определения
| Имя | Описание |
|---|---|
|
Api |
Ошибка API. |
|
Api |
База ошибок API. |
|
Cloud |
Ответ на ошибку из службы вычислений. |
|
Inner |
Сведения о внутренней ошибке. |
|
Instance |
Состояние представления экземпляра. |
|
Run |
Запись параметров виртуальной машины. |
|
Run |
Описывает свойства параметра команды run. |
|
Run |
|
|
Status |
Код уровня. |
ApiError
Ошибка API.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Код ошибки. |
| details |
Сведения об ошибке API |
|
| innererror |
Внутренняя ошибка API |
|
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект конкретной ошибки. |
ApiErrorBase
База ошибок API.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Код ошибки. |
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект конкретной ошибки. |
CloudError
Ответ на ошибку из службы вычислений.
| Имя | Тип | Описание |
|---|---|---|
| error |
Ошибка API. |
InnerError
Сведения о внутренней ошибке.
| Имя | Тип | Описание |
|---|---|---|
| errordetail |
string |
Внутреннее сообщение об ошибке или дамп исключений. |
| exceptiontype |
string |
Тип исключения. |
InstanceViewStatus
Состояние представления экземпляра.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Код состояния. |
| displayStatus |
string |
Короткая локализуемая метка для состояния. |
| level |
Код уровня. |
|
| message |
string |
Подробное сообщение о состоянии, в том числе для оповещений и сообщений об ошибках. |
| time |
string (date-time) |
Время состояния. |
RunCommandInput
Запись параметров виртуальной машины.
| Имя | Тип | Описание |
|---|---|---|
| commandId |
string |
Задает идентификатор командной строки предопределенного встроенного скрипта. Идентификаторы команд, доступные для Linux, перечислены по адресу https://aka.ms/RunCommandManagedLinux#available-commands, Windows по адресу https://aka.ms/RunCommandManagedWindows#available-commands. |
| parameters |
Параметры команды выполнения. |
|
| script |
string[] |
Необязательно. Скрипт, который должен быть выполнен. Если это значение задано, данный скрипт переопределит скрипт по умолчанию команды. |
RunCommandInputParameter
Описывает свойства параметра команды run.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Имя параметра команды запуска. |
| value |
string |
Значение параметра команды run. |
RunCommandResult
| Имя | Тип | Описание |
|---|---|---|
| value |
Запустите ответ операции команды. |
StatusLevelTypes
Код уровня.
| Значение | Описание |
|---|---|
| Info | |
| Warning | |
| Error |