Registry / devops / azure-mgmt-desktopvirtualization

azure-mgmt-desktopvirtualization

library2.0.0pypypi✓ verified 85d ago

Official Microsoft Azure Python SDK for managing Desktop Virtualization (formerly Windows Virtual Desktop) resources such as host pools, application groups, workspaces, and scaling plans. Current stable version is 2.0.0, released in 2024. Follows Azure SDK monthly release cadence.

devops

pip install azure-mgmt-desktopvirtualization

github ↗homepage ↗

INSTALL

IMPORT

SIG · AZURE-MGMT-DESKTOP

azure-mgmt-desktopvirtualization

devopspythonv2.0.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

DesktopVirtualizationMgmtClient

✓ from azure.mgmt.desktopvirtualization import DesktopVirtualizationMgmtClient

✗ from azure_mgmt_desktopvirtualization import DesktopVirtualizationMgmtClient

Wrong: uses underscore instead of dotted path. Azure SDK uses flat namespace under azure.mgmt.<service>.

models

✓ from azure.mgmt.desktopvirtualization import models

✗ from azure.mgmt.desktopvirtualization.models import HostPool

This is actually correct; HostPool is in models. But many users incorrectly try to import directly from azure.mgmt.desktopvirtualization.

Authenticate with DefaultAzureCredential and list host pools in a resource group.

from azure.identity import DefaultAzureCredential from azure.mgmt.desktopvirtualization import DesktopVirtualizationMgmtClient subscription_id = os.environ.get('AZURE_SUBSCRIPTION_ID', '') credential = DefaultAzureCredential() client = DesktopVirtualizationMgmtClient(credential, subscription_id) # List host pools for pool in client.host_pools.list_by_resource_group('myResourceGroup'): print(pool.name)

Debug

Known issues

breakingVersion 2.0.0 introduced breaking changes in model schemas and operation names. HostPools, Applications groups, and Workspaces now use different property names (e.g., *Properties class removed). Existing code using v1.x may need updates.

fix

Review migration guide at https://learn.microsoft.com/en-us/azure/developer/python/sdk/azure-sdk-library-usage-patterns. Re-run code and adjust model attribute accesses.

affects: 1.x -> 2.0.0

deprecatedThe 'windows_virtual_desktop' name was replaced by 'desktopvirtualization' in the SDK. The old import path 'azure.mgmt.windowsvirtualdesktop' no longer exists.

fix

Use 'from azure.mgmt.desktopvirtualization import DesktopVirtualizationMgmtClient' and update all references.

affects: All

gotchaModel objects (e.g., HostPool) have properties that differ from the API JSON response. Some nullable fields may raise AttributeError if not checked for None.

fix

Always check for None before accessing nested properties: if pool.tags and 'environment' in pool.tags: ...

affects: All

Errors

Common errors & fixes

AttributeError: 'DesktopVirtualizationMgmtClient' object has no attribute 'host_pools'

Incorrect client attribute name. In version 2.0.0, the operations are accessed via 'host_pools' (all lowercase with underscore), not 'host_pool' (singular) or 'HostPools'.

fix

Use client.host_pools (plural, snake_case) for all host pool operations.

ImportError: cannot import name 'HostPool' from 'azure.mgmt.desktopvirtualization'

Attempting to import the model class directly from the top-level package. Models reside in the 'models' submodule.

fix

Use 'from azure.mgmt.desktopvirtualization import models' then 'models.HostPool'.

Upgrade

Version history

2.0.0latest on PyPI · released Sep 24, 2024

Audit

Dependencies

azure-identityrequiredRequired for authentication (DefaultAzureCredential)

azure-mgmt-resourceoptionalOptional for resource management dependency, but not strictly required for desktop virtualization operations

Agent activity

5 hits · last 30 days

node

Resources

githubhttps://github.com/Azure/azure-sdk-for-python ↗

homepagehttps://github.com/Azure/azure-sdk-for-python ↗