# Azure Desktop Virtualization API management API

> Azure Desktop Virtualization API management API on Apizie: 80 endpoints (List the operations for the provider, Get a workspace., Create or update a workspace., Update a workspace., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:azure-arm-desktopvirtualization`
- Category: Cloud
- Status: byok
- Source: https://learn.microsoft.com/rest/api/azure/
- Page: https://zieapi.vercel.app/api/cloud/azure-arm-desktopvirtualization
- OpenAPI: https://zieapi.vercel.app/api/cloud/azure-arm-desktopvirtualization/openapi.json

Azure Resource Manager API for Desktop Virtualization API: manage these Azure resources in your subscription with a Microsoft Entra access token.

## Endpoints

### List the operations for the provider
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/operations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |

### Get a workspace.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/workspaces-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| workspaceName | string | yes | The name of the workspace |

### Create or update a workspace.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/workspaces-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| workspaceName | string | yes | The name of the workspace |
| body | object | yes | JSON request body |

### Update a workspace.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/workspaces-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| workspaceName | string | yes | The name of the workspace |
| body | object | no | JSON request body |

### Remove a workspace.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/workspaces-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| workspaceName | string | yes | The name of the workspace |

### List private endpoint connections.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/private-endpoint-connections-list-by-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| workspaceName | string | yes | The name of the workspace |

### Get a private endpoint connection.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/private-endpoint-connections-get-by-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| workspaceName | string | yes | The name of the workspace |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection associated with the Azure resource. |

### Approve or reject a private endpoint connection.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/private-endpoint-connections-update-by-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| workspaceName | string | yes | The name of the workspace |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection associated with the Azure resource. |
| body | object | yes | JSON request body |

### Remove a connection.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/private-endpoint-connections-delete-by-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| workspaceName | string | yes | The name of the workspace |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection associated with the Azure resource. |

### List the private link resources available for this workspace.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/private-link-resources-list-by-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| workspaceName | string | yes | The name of the workspace |
| pageSize | integer | no | Number of items per page. |
| isDescending | boolean | no | Indicates whether the collection is descending. |
| initialSkip | integer | no | Initial number of items to skip. |

### List workspaces.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/workspaces-list-by-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| pageSize | integer | no | Number of items per page. |
| isDescending | boolean | no | Indicates whether the collection is descending. |
| initialSkip | integer | no | Initial number of items to skip. |

### List workspaces in subscription.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/workspaces-list-by-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |

### Get a scaling plan.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/scaling-plans-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| scalingPlanName | string | yes | The name of the scaling plan. |

### Create or update a scaling plan.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/scaling-plans-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| scalingPlanName | string | yes | The name of the scaling plan. |
| body | object | yes | JSON request body |

### Update a scaling plan.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/scaling-plans-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| scalingPlanName | string | yes | The name of the scaling plan. |
| body | object | no | JSON request body |

### Remove a scaling plan.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/scaling-plans-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| scalingPlanName | string | yes | The name of the scaling plan. |

### List scaling plans.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/scaling-plans-list-by-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| pageSize | integer | no | Number of items per page. |
| isDescending | boolean | no | Indicates whether the collection is descending. |
| initialSkip | integer | no | Initial number of items to skip. |

### Get a ScalingPlanPooledSchedule.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/scaling-plan-pooled-schedules-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| scalingPlanName | string | yes | The name of the scaling plan. |
| scalingPlanScheduleName | string | yes | The name of the ScalingPlanSchedule |

### Create or update a ScalingPlanPooledSchedule.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/scaling-plan-pooled-schedules-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| scalingPlanName | string | yes | The name of the scaling plan. |
| scalingPlanScheduleName | string | yes | The name of the ScalingPlanSchedule |
| body | object | yes | JSON request body |

### Update a ScalingPlanPooledSchedule.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/scaling-plan-pooled-schedules-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| scalingPlanName | string | yes | The name of the scaling plan. |
| scalingPlanScheduleName | string | yes | The name of the ScalingPlanSchedule |
| body | object | no | JSON request body |

### Remove a ScalingPlanPooledSchedule.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/scaling-plan-pooled-schedules-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| scalingPlanName | string | yes | The name of the scaling plan. |
| scalingPlanScheduleName | string | yes | The name of the ScalingPlanSchedule |

### List ScalingPlanPooledSchedules.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/scaling-plan-pooled-schedules-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| scalingPlanName | string | yes | The name of the scaling plan. |
| pageSize | integer | no | Number of items per page. |
| isDescending | boolean | no | Indicates whether the collection is descending. |
| initialSkip | integer | no | Initial number of items to skip. |

### Get a ScalingPlanPersonalSchedule.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/scaling-plan-personal-schedules-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| scalingPlanName | string | yes | The name of the scaling plan. |
| scalingPlanScheduleName | string | yes | The name of the ScalingPlanSchedule |

### Create or update a ScalingPlanPersonalSchedule.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/scaling-plan-personal-schedules-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| scalingPlanName | string | yes | The name of the scaling plan. |
| scalingPlanScheduleName | string | yes | The name of the ScalingPlanSchedule |
| body | object | yes | JSON request body |

### Update a ScalingPlanPersonalSchedule.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/scaling-plan-personal-schedules-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| scalingPlanName | string | yes | The name of the scaling plan. |
| scalingPlanScheduleName | string | yes | The name of the ScalingPlanSchedule |
| body | object | no | JSON request body |

### Remove a ScalingPlanPersonalSchedule.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/scaling-plan-personal-schedules-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| scalingPlanName | string | yes | The name of the scaling plan. |
| scalingPlanScheduleName | string | yes | The name of the ScalingPlanSchedule |

### List ScalingPlanPersonalSchedules.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/scaling-plan-personal-schedules-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| scalingPlanName | string | yes | The name of the scaling plan. |
| pageSize | integer | no | Number of items per page. |
| isDescending | boolean | no | Indicates whether the collection is descending. |
| initialSkip | integer | no | Initial number of items to skip. |

### List scaling plans in subscription.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/scaling-plans-list-by-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| pageSize | integer | no | Number of items per page. |
| isDescending | boolean | no | Indicates whether the collection is descending. |
| initialSkip | integer | no | Initial number of items to skip. |

### Get an application group.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/application-groups-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| applicationGroupName | string | yes | The name of the application group |

### Create or update an applicationGroup.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/application-groups-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| applicationGroupName | string | yes | The name of the application group |
| body | object | yes | JSON request body |

### Update an applicationGroup.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/application-groups-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| applicationGroupName | string | yes | The name of the application group |
| body | object | no | JSON request body |

### Remove an applicationGroup.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/application-groups-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| applicationGroupName | string | yes | The name of the application group |

### List applicationGroups.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/application-groups-list-by-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| $filter | string | no | OData filter expression. Valid properties for filtering are applicationGroupType. |
| pageSize | integer | no | Number of items per page. |
| isDescending | boolean | no | Indicates whether the collection is descending. |
| initialSkip | integer | no | Initial number of items to skip. |

### List applicationGroups in subscription.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/application-groups-list-by-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| $filter | string | no | OData filter expression. Valid properties for filtering are applicationGroupType. |

### List start menu items in the given application group.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/start-menu-items-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| applicationGroupName | string | yes | The name of the application group |
| pageSize | integer | no | Number of items per page. |
| isDescending | boolean | no | Indicates whether the collection is descending. |
| initialSkip | integer | no | Initial number of items to skip. |

### Get an application.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/applications-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| applicationGroupName | string | yes | The name of the application group |
| applicationName | string | yes | The name of the application within the specified application group |

### Create or update an application.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/applications-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| applicationGroupName | string | yes | The name of the application group |
| applicationName | string | yes | The name of the application within the specified application group |
| body | object | yes | JSON request body |

### Update an application.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/applications-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| applicationGroupName | string | yes | The name of the application group |
| applicationName | string | yes | The name of the application within the specified application group |
| body | object | no | JSON request body |

### Remove an application.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/applications-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| applicationGroupName | string | yes | The name of the application group |
| applicationName | string | yes | The name of the application within the specified application group |

### List applications.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/applications-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| applicationGroupName | string | yes | The name of the application group |
| pageSize | integer | no | Number of items per page. |
| isDescending | boolean | no | Indicates whether the collection is descending. |
| initialSkip | integer | no | Initial number of items to skip. |

### Get a desktop.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/desktops-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| applicationGroupName | string | yes | The name of the application group |
| desktopName | string | yes | The name of the desktop within the specified desktop group |

### Update a desktop.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/desktops-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| applicationGroupName | string | yes | The name of the application group |
| desktopName | string | yes | The name of the desktop within the specified desktop group |
| body | object | no | JSON request body |

### List desktops.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/desktops-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| applicationGroupName | string | yes | The name of the application group |
| pageSize | integer | no | Number of items per page. |
| isDescending | boolean | no | Indicates whether the collection is descending. |
| initialSkip | integer | no | Initial number of items to skip. |

### Get a host pool.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/host-pools-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |

### Create or update a host pool.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/host-pools-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| body | object | yes | JSON request body |

### Update a host pool.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/host-pools-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| body | object | no | JSON request body |

### Remove a host pool.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/host-pools-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| force | boolean | no | Force flag to delete sessionHost. |

### List hostPools.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/host-pools-list-by-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| pageSize | integer | no | Number of items per page. |
| isDescending | boolean | no | Indicates whether the collection is descending. |
| initialSkip | integer | no | Initial number of items to skip. |

### List hostPools in subscription.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/host-pools-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| pageSize | integer | no | Number of items per page. |
| isDescending | boolean | no | Indicates whether the collection is descending. |
| initialSkip | integer | no | Initial number of items to skip. |

### List the private link resources available for this hostpool.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/private-link-resources-list-by-host-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| pageSize | integer | no | Number of items per page. |
| isDescending | boolean | no | Indicates whether the collection is descending. |
| initialSkip | integer | no | Initial number of items to skip. |

### Registration token of the host pool.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/host-pools-retrieve-registration-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |

### Operation to list the RegistrationTokens associated with the HostPool
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/host-pools-list-registration-tokens` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |

### List userSessions.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/user-sessions-list-by-host-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| $filter | string | no | OData filter expression. Valid properties for filtering are userprincipalname and sessionstate. |
| pageSize | integer | no | Number of items per page. |
| isDescending | boolean | no | Indicates whether the collection is descending. |
| initialSkip | integer | no | Initial number of items to skip. |

### Get a session host.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/session-hosts-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| sessionHostName | string | yes | The name of the session host within the specified host pool |

### Update a session host.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/session-hosts-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| sessionHostName | string | yes | The name of the session host within the specified host pool |
| force | boolean | no | Force flag to update assign, unassign or reassign personal desktop. |
| body | object | no | JSON request body |

### Remove a SessionHost.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/session-hosts-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| sessionHostName | string | yes | The name of the session host within the specified host pool |
| force | boolean | no | Force flag to force sessionHost deletion even when userSession exists. |

### List sessionHosts.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/session-hosts-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| pageSize | integer | no | Number of items per page. |
| isDescending | boolean | no | Indicates whether the collection is descending. |
| initialSkip | integer | no | Initial number of items to skip. |

### Get a msixpackage.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/msixpackages-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| msixPackageFullName | string | yes | The version specific package full name of the MSIX package within specified hostpool |

### Create or update a MSIX package.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/msixpackages-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| msixPackageFullName | string | yes | The version specific package full name of the MSIX package within specified hostpool |
| body | object | yes | JSON request body |

### Update an MSIX Package.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/msixpackages-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| msixPackageFullName | string | yes | The version specific package full name of the MSIX package within specified hostpool |
| body | object | no | JSON request body |

### Remove an MSIX Package.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/msixpackages-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| msixPackageFullName | string | yes | The version specific package full name of the MSIX package within specified hostpool |

### List MSIX packages in hostpool.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/msixpackages-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| pageSize | integer | no | Number of items per page. |
| isDescending | boolean | no | Indicates whether the collection is descending. |
| initialSkip | integer | no | Initial number of items to skip. |

### Gets information from a package given the path to the package.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/app-attach-package-info-import` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| body | object | yes | JSON request body |

### Expands and Lists MSIX packages in an Image, given the Image Path.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/msix-images-expand` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| body | object | yes | JSON request body |

### Get an app attach package.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/app-attach-package-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| appAttachPackageName | string | yes | The name of the App Attach package |

### Create or update an App Attach package.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/app-attach-package-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| appAttachPackageName | string | yes | The name of the App Attach package |
| body | object | yes | JSON request body |

### Update an App Attach Package
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/app-attach-package-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| appAttachPackageName | string | yes | The name of the App Attach package |
| body | object | no | JSON request body |

### Remove an App Attach Package.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/app-attach-package-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| appAttachPackageName | string | yes | The name of the App Attach package |

### List App Attach packages in resource group.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/app-attach-package-list-by-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| $filter | string | no | OData filter expression. Valid properties for filtering are package name and host pool. |

### List App Attach packages in subscription.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/app-attach-package-list-by-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| $filter | string | no | OData filter expression. Valid properties for filtering are package name, host pool, and resource group. |

### Get a userSession.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/user-sessions-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| sessionHostName | string | yes | The name of the session host within the specified host pool |
| userSessionId | string | yes | The name of the user session within the specified session host |

### Remove a userSession.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/user-sessions-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| sessionHostName | string | yes | The name of the session host within the specified host pool |
| userSessionId | string | yes | The name of the user session within the specified session host |
| force | boolean | no | Force flag to login off userSession. |

### List userSessions.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/user-sessions-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| sessionHostName | string | yes | The name of the session host within the specified host pool |
| pageSize | integer | no | Number of items per page. |
| isDescending | boolean | no | Indicates whether the collection is descending. |
| initialSkip | integer | no | Initial number of items to skip. |

### Disconnect a userSession.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/user-sessions-disconnect` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| sessionHostName | string | yes | The name of the session host within the specified host pool |
| userSessionId | string | yes | The name of the user session within the specified session host |

### Send a message to a user.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/user-sessions-send-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| sessionHostName | string | yes | The name of the session host within the specified host pool |
| userSessionId | string | yes | The name of the user session within the specified session host |
| body | object | no | JSON request body |

### List scaling plan associated with hostpool.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/scaling-plans-list-by-host-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| pageSize | integer | no | Number of items per page. |
| isDescending | boolean | no | Indicates whether the collection is descending. |
| initialSkip | integer | no | Initial number of items to skip. |

### List private endpoint connections associated with hostpool.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/private-endpoint-connections-list-by-host-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| pageSize | integer | no | Number of items per page. |
| isDescending | boolean | no | Indicates whether the collection is descending. |
| initialSkip | integer | no | Initial number of items to skip. |

### Get a private endpoint connection.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/private-endpoint-connections-get-by-host-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection associated with the Azure resource. |

### Approve or reject a private endpoint connection.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/private-endpoint-connections-update-by-host-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection associated with the Azure resource. |
| body | object | yes | JSON request body |

### Remove a connection.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/private-endpoint-connections-delete-by-host-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hostPoolName | string | yes | The name of the host pool within the specified resource group |
| privateEndpointConnectionName | string | yes | The name of the private endpoint connection associated with the Azure resource. |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/operations-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Azure Desktop Virtualization API management API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/cloud:azure-arm-desktopvirtualization/operations-list with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Azure Desktop Virtualization API management API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Azure Desktop Virtualization API management itself also needs your own key from azure.com.

### Can AI agents use the Azure Desktop Virtualization API management API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:azure-arm-desktopvirtualization.

### What is the status of the Azure Desktop Virtualization API management API?
Needs your own provider key (bring your own key)