Control Session Host Provisioning - Post

Service:

Desktop Virtualization

API Version:

2026-01-01-preview

Control provisioning of a hostpool.

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

URI Parameters

Name	In	Required	Type	Description
hostPoolName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	The name of the host pool within the specified resource group
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
action	True	HostPoolProvisioningAction	Action types for controlling hostpool update.
cancelMessage		string maxLength: 260	The cancel message sent to the user on the session host.

Responses

Name	Type	Description
202 Accepted		Resource operation accepted. Headers Location: string Retry-After: integer
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

SessionHostManagements_ControlSessionHostProvisioning_Post

Sample request

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"
}

Sample response

Status code:

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

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
HostPoolProvisioningAction	Action types for controlling hostpool provisioning.
HostPoolProvisioningControlParameter	Object containing control action for hostpool provisioning.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

HostPoolProvisioningAction

Enumeration

Action types for controlling hostpool provisioning.

Value	Description
Cancel	Cancel the hostpool provisioning.

HostPoolProvisioningControlParameter

Object

Object containing control action for hostpool provisioning.

Name	Type	Description
action	HostPoolProvisioningAction	Action types for controlling hostpool update.
cancelMessage	string maxLength: 260	The cancel message sent to the user on the session host.