Virtual Machine Instances - Stop

Служба:

Azure Arc enabled SCVMM

Версия API:

2024-06-01

Реализует операцию остановки виртуальной машины.
Операция отключения (остановки) экземпляра виртуальной машины.

POST https://management.azure.com/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/stop?api-version=2024-06-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceUri	path	True	string	Полный идентификатор Azure Resource Manager ресурса.
api-version	query	True	string	Версия API, используемая для этой операции.

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

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

Ответы

Имя	Тип	Описание
202 Accepted		Операция ресурса принята. Заголовки Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

VirtualMachineInstances_Stop_MaximumSet

VirtualMachineInstances_Stop_MinimumSet

VirtualMachineInstances_Stop_MaximumSet

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

HTTP

POST https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/stop?api-version=2024-06-01

{
  "skipShutdown": "true"
}

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

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

202

location: https://contoso.com/operationstatus

VirtualMachineInstances_Stop_MinimumSet

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

HTTP

POST https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/stop?api-version=2024-06-01

{}

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

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

202

location: https://contoso.com/operationstatus

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
SkipShutdown	Возвращает или задает значение, указывающее, следует ли запрашивать завершение работы виртуальной машины, отличной от правильной работы. Значение true для этого флага указывает на неграциозное завершение работы, а значение false указывает в противном случае. По умолчанию используется значение false.
StopVirtualMachineOptions	Определяет свойства действия остановки.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

SkipShutdown

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

Имя	Тип	Описание
false	string	Отключите отключение завершения работы.
true	string	Включите пропуск завершения работы.

StopVirtualMachineOptions

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

Имя	Тип	Default value	Описание
skipShutdown	SkipShutdown	false	Возвращает или задает значение, указывающее, следует ли запрашивать завершение работы виртуальной машины, отличной от правильной работы. Значение true для этого флага указывает на неграциозное завершение работы, а значение false указывает в противном случае. По умолчанию используется значение false.