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)	目标订阅的 ID。 该值必须是 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

Azure Active Directory OAuth2 流。

类型: oauth2
流向: 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	发送给会话主机上用户的取消消息。