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

Virtual Machine Scale Sets - Power Off

Служба:
Compute
Версия API:
2025-04-01

Выключите (остановите) одну или несколько виртуальных машин в масштабируемом наборе виртуальных машин. Обратите внимание, что ресурсы по-прежнему подключены, и вы получаете плату за ресурсы. Вместо этого используйте delon, чтобы освободить ресурсы и избежать расходов.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/poweroff?api-version=2025-04-01
С использованием необязательных параметров: 
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/poweroff?api-version=2025-04-01&skipShutdown={skipShutdown}

Параметры URI

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

string

minLength: 1
maxLength: 90

Имя группы ресурсов. Имя не зависит от регистра.
subscriptionId
 path True

string

minLength: 1

Идентификатор целевой подписки.
vmScaleSetName
 path True

string

Имя масштабируемого набора виртуальных машин.
api-version
 query True

string

minLength: 1

Версия API, используемая для данной операции.
skipShutdown
 query

boolean

Параметр для запроса некорректного завершения работы виртуальной машины. Значение true для этого флага указывает на неграциозное завершение работы, а значение false указывает в противном случае. Значение по умолчанию для этого флага false, если не указано

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

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

string[]

Идентификаторы экземпляра масштабируемого набора виртуальных машин. Пропуск идентификаторов экземпляра масштабируемого набора виртуальных машин приведет к выполнению операции на всех виртуальных машинах в масштабируемом наборе виртуальных машин.

Ответы

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

Запрос выполнен успешно.
202 Accepted

Операция ресурса принята.

Заголовки

  • Location: string
  • Retry-After: integer
Other Status Codes

CloudError

Непредвиденное сообщение об ошибке.

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

azure_auth

Azure Active Directory OAuth2 Flow.

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

Области

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

Примеры

VirtualMachineScaleSet_PowerOff_MaximumSet_Gen
VirtualMachineScaleSet_PowerOff_MinimumSet_Gen

VirtualMachineScaleSet_PowerOff_MaximumSet_Gen

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

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaa/poweroff?api-version=2025-04-01&skipShutdown=True

{
  "instanceIds": [
    "aaaaaaaaaaaaaaaaa"
  ]
}

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

Код состояния:
200
Код состояния:
202 
location: https://foo.com/operationstatus

VirtualMachineScaleSet_PowerOff_MinimumSet_Gen

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

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/a/poweroff?api-version=2025-04-01

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

Код состояния:
200
Код состояния:
202 
location: https://foo.com/operationstatus

Определения

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

Ошибка API.
ApiErrorBase

База ошибок API.
CloudError

Ответ об ошибке от службы вычислений.
InnerError

Сведения о внутренней ошибке.
VirtualMachineScaleSetVMInstanceIDs

Указывает список идентификаторов экземпляров виртуальных машин из масштабируемого набора виртуальных машин.

ApiError

Объект

Ошибка API.

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

string

Код ошибки.
details

ApiErrorBase[]

Сведения об ошибке Api
innererror

InnerError

Внутренняя ошибка Api
message

string

Сообщение об ошибке.
target

string

Целевой объект конкретной ошибки.

ApiErrorBase

Объект

База ошибок API.

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

string

Код ошибки.
message

string

Сообщение об ошибке.
target

string

Целевой объект конкретной ошибки.

CloudError

Объект

Ответ об ошибке от службы вычислений.

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

ApiError

Ошибка API.

InnerError

Объект

Сведения о внутренней ошибке.

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

string

Внутреннее сообщение об ошибке или дамп исключений.
exceptiontype

string

Тип исключения.

VirtualMachineScaleSetVMInstanceIDs

Объект

Указывает список идентификаторов экземпляров виртуальных машин из масштабируемого набора виртуальных машин.

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

string[]

Идентификаторы экземпляра масштабируемого набора виртуальных машин. Пропуск идентификаторов экземпляра масштабируемого набора виртуальных машин приведет к выполнению операции на всех виртуальных машинах в масштабируемом наборе виртуальных машин.