About DesktopVirtualization API

Question

Dear All,

Thank you for your notification.

We are currently using Azure Monitor for Virtual Desktop v.4.4.0. Could you confirm whether this version complies with the required DesktopVirtualization API v. 2024-04-03 0r the latest Preview API version? If an update is necessary , please provide futher details on the required changes.

Looking forward to your confirmation

Best regards,

Burak Türkpencesi

Answer 1

Hi Tuerkpencesi, Burak Alper,

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

Azure Monitor for Virtual Desktop v.4.4.0 may not fully comply with the latest DesktopVirtualization API v. 2024-04-03 or the Preview API version (v. 2024-04-08-preview). Microsoft has recently announced updates requiring users to transition to these newer API versions for compatibility and continued functionality.

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:

• 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:

https://learn.microsoft.com/en-us/azure/templates/microsoft.desktopvirtualization/2024-04-03/hostpools?pivots=deployment-language-bicep

https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-providers-and-types

https://learn.microsoft.com/en-us/azure/templates/microsoft.desktopvirtualization/change-log/summary

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

If the information is helpful, please consider by clicking the "Upvote" on the post.

If you have any further queries, please let us know in the comment.

Thank you.