Microsoft Azure

Azure Desktopvirtualization

This Typespec represents the Desktop Virtualization API interfaces.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This Typespec represents the Desktop Virtualization API interfaces.

Endpoints 80

Operations

  • GETOperations_List/providers/Microsoft.DesktopVirtualization/operationsList the operations for the provider

AppAttachPackages

  • GETAppAttachPackage_ListBySubscription/subscriptions/:subscriptionId/providers/Microsoft.DesktopVirtualization/appAttachPackages?$filter=stringList App Attach packages in subscription.
  • GETAppAttachPackage_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/appAttachPackages?$filter=stringList App Attach packages in resource group.
  • GETAppAttachPackage_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/appAttachPackages/:appAttachPackageNameGet an app attach package.
  • PUTAppAttachPackage_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/appAttachPackages/:appAttachPackageNameCreate or update an App Attach package.
  • DELETEAppAttachPackage_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/appAttachPackages/:appAttachPackageNameRemove an App Attach Package.
  • PATCHAppAttachPackage_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/appAttachPackages/:appAttachPackageNameUpdate an App Attach Package

StartMenuItems

  • GETStartMenuItems_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/applicationGroups/:applicationGroupName/startMenuItems?pageSize=0&isDescending=true&initialSkip=0List start menu items in the given application group.

ApplicationGroups

  • GETApplicationGroups_ListBySubscription/subscriptions/:subscriptionId/providers/Microsoft.DesktopVirtualization/applicationGroups?$filter=stringList applicationGroups in subscription.
  • GETApplicationGroups_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/applicationGroups?$filter=string&pageSize=0&isDescending=true&initialSkip=0List applicationGroups.
  • GETApplicationGroups_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/applicationGroups/:applicationGroupNameGet an application group.
  • PUTApplicationGroups_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/applicationGroups/:applicationGroupNameCreate or update an applicationGroup.
  • DELETEApplicationGroups_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/applicationGroups/:applicationGroupNameRemove an applicationGroup.
  • PATCHApplicationGroups_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/applicationGroups/:applicationGroupNameUpdate an applicationGroup.

AppAttachPackageInfo

  • POSTAppAttachPackageInfo_Import/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/importAppAttachPackageInfoGets information from a package given the path to the package.

MSIXImages

  • POSTMsixImages_Expand/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/expandMsixImageExpands and Lists MSIX packages in an Image, given the Image Path. This action uses incorrect Msix casing intentionally to match the previous APIs.

PrivateLinkResources

  • GETPrivateLinkResources_ListByHostPool/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/privateLinkResources?pageSize=0&isDescending=true&initialSkip=0List the private link resources available for this hostpool.
  • GETPrivateLinkResources_ListByWorkspace/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/workspaces/:workspaceName/privateLinkResources?pageSize=0&isDescending=true&initialSkip=0List the private link resources available for this workspace.

HostPools

  • GETHostPools_List/subscriptions/:subscriptionId/providers/Microsoft.DesktopVirtualization/hostPools?pageSize=0&isDescending=true&initialSkip=0List hostPools in subscription.
  • GETHostPools_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools?pageSize=0&isDescending=true&initialSkip=0List hostPools.
  • GETHostPools_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolNameGet a host pool.
  • PUTHostPools_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolNameCreate or update a host pool.
  • DELETEHostPools_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName?force=trueRemove a host pool.
  • PATCHHostPools_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolNameUpdate a host pool.
  • POSTHostPools_ListRegistrationTokens/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/listRegistrationTokensOperation to list the RegistrationTokens associated with the HostPool.
  • POSTHostPools_RetrieveRegistrationToken/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/retrieveRegistrationTokenRegistration token of the host pool.

ScalingPlans

  • GETScalingPlans_ListBySubscription/subscriptions/:subscriptionId/providers/Microsoft.DesktopVirtualization/scalingPlans?pageSize=0&isDescending=true&initialSkip=0List scaling plans in subscription.
  • GETScalingPlans_ListByHostPool/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/scalingPlans?pageSize=0&isDescending=true&initialSkip=0List scaling plan associated with hostpool.
  • GETScalingPlans_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/scalingPlans?pageSize=0&isDescending=true&initialSkip=0List scaling plans.
  • GETScalingPlans_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/scalingPlans/:scalingPlanNameGet a scaling plan.
  • PUTScalingPlans_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/scalingPlans/:scalingPlanNameCreate or update a scaling plan.
  • DELETEScalingPlans_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/scalingPlans/:scalingPlanNameRemove a scaling plan.
  • PATCHScalingPlans_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/scalingPlans/:scalingPlanNameUpdate a scaling plan.

Workspaces

  • GETWorkspaces_ListBySubscription/subscriptions/:subscriptionId/providers/Microsoft.DesktopVirtualization/workspacesList workspaces in subscription.
  • GETWorkspaces_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/workspaces?pageSize=0&isDescending=true&initialSkip=0List workspaces.
  • GETWorkspaces_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/workspaces/:workspaceNameGet a workspace.
  • PUTWorkspaces_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/workspaces/:workspaceNameCreate or update a workspace.
  • DELETEWorkspaces_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/workspaces/:workspaceNameRemove a workspace.
  • PATCHWorkspaces_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/workspaces/:workspaceNameUpdate a workspace.

Applications

  • GETApplications_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/applicationGroups/:applicationGroupName/applications?pageSize=0&isDescending=true&initialSkip=0List applications.
  • GETApplications_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/applicationGroups/:applicationGroupName/applications/:applicationNameGet an application.
  • PUTApplications_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/applicationGroups/:applicationGroupName/applications/:applicationNameCreate or update an application.
  • DELETEApplications_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/applicationGroups/:applicationGroupName/applications/:applicationNameRemove an application.
  • PATCHApplications_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/applicationGroups/:applicationGroupName/applications/:applicationNameUpdate an application.

Desktops

  • GETDesktops_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/applicationGroups/:applicationGroupName/desktops?pageSize=0&isDescending=true&initialSkip=0List desktops.
  • GETDesktops_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/applicationGroups/:applicationGroupName/desktops/:desktopNameGet a desktop.
  • PATCHDesktops_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/applicationGroups/:applicationGroupName/desktops/:desktopNameUpdate a desktop.

CustomPrivateEndpointConnection

  • GETPrivateEndpointConnections_ListByHostPool/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/privateEndpointConnections?pageSize=0&isDescending=true&initialSkip=0List private endpoint connections associated with hostpool.
  • GETPrivateEndpointConnections_GetByHostPool/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/privateEndpointConnections/:privateEndpointConnectionNameGet a PrivateEndpointConnectionWithSystemData
  • PUTPrivateEndpointConnections_UpdateByHostPool/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/privateEndpointConnections/:privateEndpointConnectionNameApprove or reject a private endpoint connection.
  • DELETEPrivateEndpointConnections_DeleteByHostPool/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/privateEndpointConnections/:privateEndpointConnectionNameDelete a PrivateEndpointConnectionWithSystemData
  • GETPrivateEndpointConnections_ListByWorkspace/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/workspaces/:workspaceName/privateEndpointConnectionsList private endpoint connections associated with Workspace.
  • GETPrivateEndpointConnections_GetByWorkspace/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/workspaces/:workspaceName/privateEndpointConnections/:privateEndpointConnectionNameGet a PrivateEndpointConnectionWithSystemData
  • PUTPrivateEndpointConnections_UpdateByWorkspace/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/workspaces/:workspaceName/privateEndpointConnections/:privateEndpointConnectionNameApprove or reject a private endpoint connection.
  • DELETEPrivateEndpointConnections_DeleteByWorkspace/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/workspaces/:workspaceName/privateEndpointConnections/:privateEndpointConnectionNameDelete a PrivateEndpointConnectionWithSystemData

SessionHosts

  • GETSessionHosts_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/sessionHosts?pageSize=0&isDescending=true&initialSkip=0List sessionHosts.
  • GETSessionHosts_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/sessionHosts/:sessionHostNameGet a session host.
  • DELETESessionHosts_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/sessionHosts/:sessionHostName?force=trueRemove a SessionHost.
  • PATCHSessionHosts_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/sessionHosts/:sessionHostName?force=trueUpdate a session host.

UserSessions

  • GETUserSessions_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/sessionHosts/:sessionHostName/userSessions?pageSize=0&isDescending=true&initialSkip=0List userSessions.
  • GETUserSessions_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/sessionHosts/:sessionHostName/userSessions/:userSessionIdGet a userSession.
  • DELETEUserSessions_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/sessionHosts/:sessionHostName/userSessions/:userSessionId?force=trueRemove a userSession.
  • POSTUserSessions_Disconnect/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/sessionHosts/:sessionHostName/userSessions/:userSessionId/disconnectDisconnect a userSession.
  • POSTUserSessions_SendMessage/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/sessionHosts/:sessionHostName/userSessions/:userSessionId/sendMessageSend a message to a user.
  • GETUserSessions_ListByHostPool/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/userSessions?$filter=string&pageSize=0&isDescending=true&initialSkip=0A synchronous resource action.

ScalingPlanPersonalSchedules

  • GETScalingPlanPersonalSchedules_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/scalingPlans/:scalingPlanName/personalSchedules?pageSize=0&isDescending=true&initialSkip=0List ScalingPlanPersonalSchedules.
  • GETScalingPlanPersonalSchedules_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/scalingPlans/:scalingPlanName/personalSchedules/:scalingPlanScheduleNameGet a ScalingPlanPersonalSchedule.
  • PUTScalingPlanPersonalSchedules_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/scalingPlans/:scalingPlanName/personalSchedules/:scalingPlanScheduleNameCreate or update a ScalingPlanPersonalSchedule.
  • DELETEScalingPlanPersonalSchedules_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/scalingPlans/:scalingPlanName/personalSchedules/:scalingPlanScheduleNameRemove a ScalingPlanPersonalSchedule.
  • PATCHScalingPlanPersonalSchedules_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/scalingPlans/:scalingPlanName/personalSchedules/:scalingPlanScheduleNameUpdate a ScalingPlanPersonalSchedule.

ScalingPlanPooledSchedules

  • GETScalingPlanPooledSchedules_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/scalingPlans/:scalingPlanName/pooledSchedules?pageSize=0&isDescending=true&initialSkip=0List ScalingPlanPooledSchedules.
  • GETScalingPlanPooledSchedules_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/scalingPlans/:scalingPlanName/pooledSchedules/:scalingPlanScheduleNameGet a ScalingPlanPooledSchedule.
  • PUTScalingPlanPooledSchedules_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/scalingPlans/:scalingPlanName/pooledSchedules/:scalingPlanScheduleNameCreate or update a ScalingPlanPooledSchedule.
  • DELETEScalingPlanPooledSchedules_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/scalingPlans/:scalingPlanName/pooledSchedules/:scalingPlanScheduleNameRemove a ScalingPlanPooledSchedule.
  • PATCHScalingPlanPooledSchedules_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/scalingPlans/:scalingPlanName/pooledSchedules/:scalingPlanScheduleNameUpdate a ScalingPlanPooledSchedule.

MSIXPackages

  • GETMSIXPackages_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/msixPackages?pageSize=0&isDescending=true&initialSkip=0List MSIX packages in hostpool.
  • GETMSIXPackages_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/msixPackages/:msixPackageFullNameGet a msixpackage.
  • PUTMSIXPackages_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/msixPackages/:msixPackageFullNameCreate or update a MSIX package.
  • DELETEMSIXPackages_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/msixPackages/:msixPackageFullNameRemove an MSIX Package.
  • PATCHMSIXPackages_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/:hostPoolName/msixPackages/:msixPackageFullNameUpdate an MSIX Package.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
80 operations on 45 pathsGET 39DELETE 13PUT 11PATCH 11POST 6
Main resources
CustomPrivateEndpointConnection 8HostPools 8ScalingPlans 7AppAttachPackages 6ApplicationGroups 6UserSessions 6Workspaces 6Applications 5MSIXPackages 5ScalingPlanPersonalSchedules 5
Response formats
application/json
Description format
Swagger 2.0, API version 2026-04-16

How to test the Azure Desktopvirtualization in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Desktopvirtualization collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Operations_List” (GET /providers/Microsoft.DesktopVirtualization/operations), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Desktopvirtualization?

This Typespec represents the Desktop Virtualization API interfaces. It is listed under Developer tools and has 80 endpoints.

Who publishes the Azure Desktopvirtualization?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Desktopvirtualization?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Desktopvirtualization?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Desktopvirtualization have?

80 operations on 45 paths (39 GET, 13 DELETE, 11 PUT, 11 PATCH, 6 POST). The largest groups are CustomPrivateEndpointConnection, HostPools, ScalingPlans, AppAttachPackages.

Is forking the Azure Desktopvirtualization free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.