Control Session Host Provisioning - Post

Служба:

Desktop Virtualization

Версия API:

2026-01-01-preview

Управление инициализацией пула узлов.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/controlSessionHostProvisioning?api-version=2026-01-01-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
hostPoolName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	Имя пула узлов в указанной группе ресурсов
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не зависит от регистра.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

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

Имя	Обязательно	Тип	Описание
action	True	HostPoolProvisioningAction	Типы действий для управления обновлением пула узлов сети.
cancelMessage		string maxLength: 260	Сообщение об отмене, отправленное пользователю на узле сеанса.

Ответы

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

Примеры

SessionHostManagements_ControlSessionHostProvisioning_Post

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

HTTP

POST https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/controlSessionHostProvisioning?api-version=2026-01-01-preview

{
  "action": "Cancel",
  "cancelMessage": "Cancel host pool provisioning"
}

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

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

202

Location: https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d
Retry-After: 60

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
HostPoolProvisioningAction	Типы действий для управления инициализацией пула узлов.
HostPoolProvisioningControlParameter	Объект, содержащий управляющее действие для подготовки пула узлов.

ErrorAdditionalInfo

Объект

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

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

ErrorDetail

Объект

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

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

ErrorResponse

Объект

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

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

HostPoolProvisioningAction

Перечисление

Типы действий для управления инициализацией пула узлов.

Значение	Описание
Cancel	Отмените подготовку пула узлов.

HostPoolProvisioningControlParameter

Объект

Объект, содержащий управляющее действие для подготовки пула узлов.

Имя	Тип	Описание
action	HostPoolProvisioningAction	Типы действий для управления обновлением пула узлов сети.
cancelMessage	string maxLength: 260	Сообщение об отмене, отправленное пользователю на узле сеанса.