Share via

Update to DesktopVirtualization API v. 2024-04-03 or the Latest Preview API Version by 11 March 2025

Tim McDermid 0 Reputation points
2025-03-05T13:54:21.7266667+00:00

Our company has received the following email (bottom of the page). I'm new to Azure/AVD and I'm trying to grasp how this impacts my environment before this weekend so that we can avoid downtime. I've reviewed a few Microsoft documents already, but I'm still unsure if this change will apply or affect our current environment. I'm not very familiar with our API use, so I'm not even sure where to determine what applications or workflows are using an API and what version it is using. We do leverage Nerdio for our AVD deployment and I've already confirmed with them that this deprecation does not impact them. Mainly the only other item I'm aware that interacts with our Virtual Desktops in a 3rd party capacity is Citrix - but I've yet to find anything indicating if this will impact our Citrix configuration.

If anyone has any insight in to this change and could help explain in layman terms how I can look through our infrastructure to find if this deprecation impacts us, that would be much appreciated.

I've already looked through this document: https://learn.microsoft.com/en-us/answers/questions/2134665/how-to-update-to-desktopvirtualization-api-v-2024

Update to DesktopVirtualization API v. 2024-04-03 or the Latest Preview API Version by 11 March 2025

You’re receiving this notification because you are associated with one or more Azure subscriptions that use Windows Virtual Desktop. 

This announcement does not apply to customers who have deployed ARM resources for Azure Virtual Desktop using the Azure Portal. However, If you have used client-side tools such as Az CLI, Az PowerShell, SDK, ARM templates, or any other 3rd party tools relying on Microsoft.DesktopVirtualization API, this notification is applicable to you. 

On  11 March 2025*,  *the following DesktopVirtualization APIs will no longer be supported, and you'll need to update to either the latest preview API version or API v. 2024-04-03: 

  • 2021-08-04-preview 
  • 2021-09-03-preview 
  • 2022-01-12-privatepreview 
  • 2022-02-10-preview 
  • 2022-04-01-preview 
  • 2022-08-09-privatepreview 
  • 2023-01-28-privatepreview 
  • 2023-01-30-preview 
  • 2023-03-03-privatepreview 
  • 2023-04-06-preview 
  • 2023-11-01-preview 
  • 2023-11-29-privatepreview 
  • 2023-12-25-privatepreview 

If you update to API v. 2024-04-03, we recommend testing it first to see if it fits your needs, as API v. 2024-04-03 doesn't contain all the functionality as the APIs listed above. To retain all functionality, you'll need to update to latest preview. 

Additionally, the following APIs will also no longer be supported, and you'll need to update to API v. 2024-04-03 to retain all functionality: 

  • 2022-07-05-preview 
  • 2022-09-01-privatepreview 
  • 2022-10-14-preview 
  • 2023-03-21-privatepreview 
  • 2023-10-04-preview 

If you're using Microsoft PowerShell, you'll need to update to either the latest preview version or 5.4.0. If you don't update to a newer API version by 11 March 2025, you'll receive an error. 

Required action 

To avoid service disruptions, update your DesktopVirtualization APIs to the latest preview or API v. 2024-04-03 before 11 March 2025. Learn more about DesktopVirtualization  resource types. 

If you're using Microsoft PowerShell, update to either the latest preview version or 5.4.0 before 11 March 2025. 

Update to DesktopVirtualization API v. 2024-04-03 or the Latest Preview API Version by 11 March 2025

You’re receiving this notification because you are associated with one or more Azure subscriptions that use Windows Virtual Desktop. 

This announcement does not apply to customers who have deployed ARM resources for Azure Virtual Desktop using the Azure Portal. However, If you have used client-side tools such as Az CLI, Az PowerShell, SDK, ARM templates, or any other 3rd party tools relying on Microsoft.DesktopVirtualization API, this notification is applicable to you. 

On  11 March 2025*,*  the following DesktopVirtualization APIs will no longer be supported, and you'll need to update to either the latest preview API version or API v. 2024-04-03: 

  • 2021-08-04-preview 
  • 2021-09-03-preview 
  • 2022-01-12-privatepreview 
  • 2022-02-10-preview 
  • 2022-04-01-preview 
  • 2022-08-09-privatepreview 
  • 2023-01-28-privatepreview 
  • 2023-01-30-preview 
  • 2023-03-03-privatepreview 
  • 2023-04-06-preview 
  • 2023-11-01-preview 
  • 2023-11-29-privatepreview 
  • 2023-12-25-privatepreview 

If you update to API v. 2024-04-03, we recommend testing it first to see if it fits your needs, as API v. 2024-04-03 doesn't contain all the functionality as the APIs listed above. To retain all functionality, you'll need to update to latest preview. 

Additionally, the following APIs will also no longer be supported, and you'll need to update to API v. 2024-04-03 to retain all functionality: 

  • 2022-07-05-preview 
  • 2022-09-01-privatepreview 
  • 2022-10-14-preview 
  • 2023-03-21-privatepreview 
  • 2023-10-04-preview 

If you're using Microsoft PowerShell, you'll need to update to either the latest preview version or 5.4.0. If you don't update to a newer API version by 11 March 2025, you'll receive an error. 

Required action 

To avoid service disruptions, update your DesktopVirtualization APIs to the latest preview or API v. 2024-04-03 before 11 March 2025. Learn more about DesktopVirtualization  resource types. 

If you're using Microsoft PowerShell, update to either the latest preview version or 5.4.0 before 11 March 2025. 

Azure Virtual Desktop
Azure Virtual Desktop
A Microsoft desktop and app virtualization service that runs on Azure. Previously known as Windows Virtual Desktop.
1,708 questions

1 answer

Sort by: Most helpful
Most helpful Newest Oldest
  1. Mahesh Goud Juvvadi 1,955 Reputation points Microsoft External Staff
    2025-03-05T19:34:02.74+00:00

    Hi Tim McDermid,

    Thank you for reaching out to the Microsoft Q&A platform.

    The email error indicates that the older versions of the DesktopVirtualization API will no longer be supported after March 11, 2025.

    To update to the required API version Update to DesktopVirtualization API v. 2024-04-03 or the Latest Preview API Version for Azure Virtual Desktop, follow these steps:

    Automatic Update via Deployment Scripts

    Review Current API Usage check your ARM templates, Bicep files, or scripts for references to older API versions.

    Update API Version replace the apiVersion field in your scripts with the new version.

    {
  "type": "Microsoft.DesktopVirtualization/hostPools",
  "apiVersion": "2024-04-03",
  // Resource properties
}
    • Redeploy Resources use updated scripts to redeploy your resources.

    Manual Update via Azure Portal

    • In the Azure portal, go to Resource Providers under your subscription.
    • Locate Microsoft.DesktopVirtualization and check the default API version for hostpools.
    • Navigate to your AVD resources (e.g., host pools).
    • Under Properties, check the API version used. If it’s older (e.g., 2022-01-12-privatepreview), you'll need to update.
    • Delete the resource (e.g., Host Pool) if necessary, ensuring no critical data is lost.
    • Recreate the resource using the updated API version by configuring it in the Create Host Pool workflow in the portal.
    • After updating, verify that the resource reflects the new API version under Properties.

    For more details, please refer to the below documentations:

    Microsoft.DesktopVirtualization hostPools 2024-04-03

    Azure resource providers and types

    Azure DesktopVirtualization API Documentation.

    https://github.com/hashicorp/pandora/pull/4589/commits/44831c5627e692b220ec5b7084362f2e60721085

    If it was helpful, please click "Upvote" on this post to let us know.

    Thank You.

Your answer

Answers can be marked as Accepted Answers by the question author, which helps users to know the answer solved the author's problem.