Azure DevTest Labs Management

Warnings

• breaking The primary client class name changed from `DevTestLabsManagementClient` to `DevTestLabsClient` in the V2 SDK. Code written for older versions will need to update the import and instantiation.
  Fix: Update your import statement to `from azure.mgmt.devtestlabs import DevTestLabsClient` and instantiate the client as `DevTestLabsClient(credential, subscription_id)`.
• breaking Resource models and API methods may have changed significantly between major versions (e.g., V1 to V2 SDK). Property names, argument order, and response structures might differ, leading to `AttributeError` or `TypeError`.
  Fix: Consult the official V2 SDK documentation and API reference for the `azure-mgmt-devtestlabs` library to understand the updated resource models and method signatures. Update your code to reflect the new structure.
• gotcha The library provides both synchronous (`DevTestLabsClient`) and asynchronous (`DevTestLabsClientAsync`) clients. Ensure you are using the correct client type for your application's concurrency model (e.g., `async/await` for asynchronous operations).
  Fix: For synchronous code, use `DevTestLabsClient`. For asynchronous code, import and use `DevTestLabsClientAsync` and ensure your calls are awaited within an `async` function.
• gotcha Many list operations (e.g., `client.labs.list_by_subscription()`) return an iterable object that performs pagination under the hood. Not all items might be immediately available, and the iterator must be fully consumed to retrieve all results.
  Fix: Always iterate over the returned collection directly (e.g., `for lab in client.labs.list_by_subscription():`) rather than assuming it's a simple list or accessing elements by index directly, to ensure all pages are fetched.

Install

• pip install azure-mgmt-devtestlabs Install stable version

Imports

• DevTestLabsClient

  from azure.mgmt.devtestlabs import DevTestLabsClient

  In V2 of the Azure SDK for Python, the main management client class name was simplified from `DevTestLabsManagementClient` to `DevTestLabsClient`.
• DefaultAzureCredential

  from azure.identity import DefaultAzureCredential

  This is the recommended credential type for most applications, attempting to authenticate via various common methods.

Quickstart

This quickstart demonstrates how to instantiate the DevTestLabsClient using DefaultAzureCredential and then list all DevTest Labs available within your Azure subscription. Ensure `AZURE_SUBSCRIPTION_ID` is set in your environment variables for this to run.

import os
from azure.identity import DefaultAzureCredential
from azure.mgmt.devtestlabs import DevTestLabsClient

# Set your Azure Subscription ID as an environment variable
# E.g., export AZURE_SUBSCRIPTION_ID="<your-subscription-id>"
subscription_id = os.environ.get("AZURE_SUBSCRIPTION_ID", "")
if not subscription_id:
    raise ValueError("AZURE_SUBSCRIPTION_ID environment variable not set.")

# Authenticate using DefaultAzureCredential
# This will try various authentication methods, like environment variables,
# managed identity, Azure CLI, VS Code, etc.
credential = DefaultAzureCredential()

# Create a DevTestLabsClient
client = DevTestLabsClient(credential, subscription_id)

# Example: List all DevTest Labs in the subscription
print("Listing DevTest Labs:")
for lab in client.labs.list_by_subscription():
    print(f"  Lab Name: {lab.name}, Location: {lab.location}")