Create host pool deployment

post

https://api.controlup.com/daas-iq/v1/cloud/subscriptions/{subscriptionId}/host-pool-deployments

Starts an asynchronous shell deployment for an Azure Virtual Desktop host pool.
The job creates the host pool ARM resource, application group, workspace registration,
then imports the created control-plane tree into Foundry.

Path Params

subscriptionId

uuid

required

Foundry cloud subscription identifier.

Body Params

Host pool shell deployment request.

Request to create an Azure Virtual Desktop host pool shell deployment.

name

string

required

length between 1 and 64

^[a-zA-Z0-9][a-zA-Z0-9_.-]*[a-zA-Z0-9]$|^[a-zA-Z0-9]$

Host pool name.

resourceGroupName

string

required

length between 1 and 90

Existing Azure resource group name where control-plane resources are created.

region

string

required

length between 1 and 64

Azure region for the host pool and application group metadata.

appGroupType

string

enum

required

Allowed:

appGroupName

string | null

^[a-zA-Z0-9][a-zA-Z0-9_.-]*[a-zA-Z0-9]$|^[a-zA-Z0-9]$

Optional application group name. Defaults to the host pool name when omitted.

hostPoolType

string

enum

required

Allowed:

loadBalancingAlgorithm

string

enum

Allowed:

maxSessionLimit

int32 | null

1 to 2147483647

Maximum number of user sessions per host for pooled host pools.

assignmentType

string

enum

Allowed:

initialHostCount

int32

0 to 100

Initial session host count to provision after creating the host pool.

vmSettings

object

Full request payload for creating or replacing VM settings for a host pool.

workspaceResourceId

string

required

length ≥ 1

Existing AVD workspace ARM resource ID to register the application group with.

201Deployment job accepted.

400Bad request. Invalid payload or precondition failed.

401Unauthorized. User is not authenticated.

403Forbidden. User does not have create host pool permission.

404Subscription, resource group, or workspace was not found.

409Host pool or application group already exists.