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

Azure Virtual Desktop application group type for host pools.

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

Represents the type of Azure Virtual Desktop host pool.

Allowed:

loadBalancingAlgorithm

string

enum

Azure Virtual Desktop load balancing algorithm for host pool session distribution.

Allowed:

maxSessionsPerHost

int32 | null

1 to 2147483647

Maximum concurrent sessions allowed per session host for pooled host pools.
Named to match the host pool read paths; ARM calls this property maxSessionLimit.

assignmentType

string

enum

Assignment strategy for personal Azure Virtual Desktop host pools.

Allowed:

initialHostCount

int32

0 to 100

Defaults to 0

Initial session host count to provision after creating the host pool.
Defaults to 0, creating the host pool without session hosts.

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.

402Payment required. No active license for the organization.

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

404Not found. The specified subscription, resource group, or workspace does not exist.

409Conflict. The host pool or application group already exists.

500Internal server error.

503Service unavailable. License status could not be verified. Try again later.