How to update to DesktopVirtualization API v. 2024-04-08-preview or API v. 2024-04-03?

Question

I received the notification "Action required: Update to DesktopVirtualization API v. 2024-04-08-preview or API v. 2024-04-03." Could you please guide me on how to update to the required API version? Are there any specific steps or considerations to follow?

Answer 1

Hi a s,

Welcome to the Microsoft Q&A Platform! Thank you for asking your question here.

To update to the required API version (2024-04-08-preview or 2024-04-03) 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. Example:

{
  "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 documentation:
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 an answer has been helpful, please consider accept the "Answer" and "Upvote" to help increase visibility of this question for other members of the Microsoft Q&A community. 

Answer 2

• Does the API change impact somehow existing resources ? ... "Delete the resource (e.g., Host Pool) if necessary, ..."
• What to do if in Automation Account powershell workflow is available only in version 5.1 - Do i need rewrite workflow to powershell to use correct API ?

Thank you.

Answer 3

I am under the same boat.

Under Properties, check the API version used. If it’s older (e.g., 2022-01-12-privatepreview), you'll need to update

This property field is not visible on the properties page of my host pool. Am I missing anything?

Also, we are only deploying host pools and VMs through the portal.

We are not using any ARM template to do the operation, are we in need to upgrade our APIs?