Azure Management Advisor

Warnings

• breaking The credential system was completely revamped in `9.0.0b1`. Legacy authentication methods like `azure.common.credentials` or `msrestazure.azure_active_directory` are no longer supported. You must use classes from `azure-identity` (e.g., `DefaultAzureCredential`).
  Fix: Migrate your authentication code to use `azure-identity`. Install it with `pip install azure-identity` and replace old credential types with `DefaultAzureCredential` or other appropriate `azure-identity` classes.
• breaking Client initialization parameters changed in `9.0.0b1`. The `credentials` parameter was renamed to `credential`, and the `config` attribute no longer exists on client objects. Configuration should now be passed as keyword arguments to the client constructor.
  Fix: Update client instantiation from `Client(credentials, subscription_id, config=...)` to `Client(credential, subscription_id, enable_logging=...)` or similar keyword arguments supported by `azure-core`.
• breaking Long-running operations (LROs) now return an `azure.core.polling.LROPoller` object (instead of `msrest.polling.LROPoller`) and are typically prefixed with `begin_`.
  Fix: Review calls to LRO-initiating methods. Ensure they are prefixed with `begin_` (e.g., `client.resource.begin_create_or_update()`) and handle the new `LROPoller` return type from `azure.core.polling`.
• breaking The exception hierarchy has been simplified. Most exceptions now inherit from `azure.core.exceptions.HttpResponseError`. The `CloudError` class has been removed.
  Fix: Update exception handling blocks to catch `azure.core.exceptions.HttpResponseError` instead of `CloudError` or other specific HTTP-related exceptions.
• gotcha HTTP connection pooling is enabled by default. To ensure proper resource management and avoid potential issues, client objects should ideally be used as context managers or have their `close()` method explicitly called when they are no longer needed.
  Fix: Wrap client usage in a `with` statement (e.g., `with AdvisorManagementClient(...) as client:`) or explicitly call `client.close()` when done.
• gotcha If you are not seeing expected Advisor recommendations for certain categories (e.g., 'Security'), ensure that there are actual recommendations in that category for your resources. You might need to explicitly filter the list operation if only specific categories are desired.
  Fix: Verify in the Azure Portal if recommendations exist for the specific category. When listing recommendations via SDK, you can apply a filter (e.g., `client.recommendations.list(filter="Category eq 'Security'")`) to narrow down results.

Install

• pip install azure-mgmt-advisor azure-identity Install library and identity client

Imports

• AdvisorManagementClient

  from azure.mgmt.advisor import AdvisorManagementClient

  For versions prior to 3.0.0, the client was imported from a sub-module. Version 3.0.0 and later require direct import from `azure.mgmt.advisor`.
• DefaultAzureCredential

  from azure.identity import DefaultAzureCredential

  As of v9.0.0b1 and later, `azure.common.credentials` and `msrestazure.azure_active_directory` are no longer supported for authentication. Use classes from `azure-identity` like `DefaultAzureCredential` instead.

Quickstart

This quickstart demonstrates how to authenticate with Azure using `DefaultAzureCredential` and list Azure Advisor recommendations for a given subscription. Ensure your Azure credentials and `AZURE_SUBSCRIPTION_ID` are set in your environment variables or via `az login`.

import os
from azure.identity import DefaultAzureCredential
from azure.mgmt.advisor import AdvisorManagementClient

# --- Authentication ---
# For more info, see https://learn.microsoft.com/en-us/azure/developer/python/sdk/authentication-overview
# Set AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET, and AZURE_SUBSCRIPTION_ID environment variables,
# or authenticate via Azure CLI (az login).

try:
    credential = DefaultAzureCredential()
    subscription_id = os.environ.get("AZURE_SUBSCRIPTION_ID", "")
    if not subscription_id:
        raise ValueError("AZURE_SUBSCRIPTION_ID environment variable not set.")
except Exception as e:
    print(f"Authentication setup failed: {e}")
    print("Please ensure you have authenticated to Azure (e.g., via `az login`) and set AZURE_SUBSCRIPTION_ID.")
    exit(1)

# --- Client Initialization ---
print(f"Initializing AdvisorManagementClient for subscription: {subscription_id}")
client = AdvisorManagementClient(credential, subscription_id)

# --- Fetching Recommendations ---
print("Listing Advisor recommendations:")
try:
    # The list() method returns an iterator over recommendations.
    for recommendation in client.recommendations.list():
        print(f"  Category: {recommendation.category}")
        print(f"  Impact: {recommendation.impact}")
        # Accessing nested properties like short_description.problem
        if recommendation.short_description:
            print(f"  Problem: {recommendation.short_description.problem}")
            print(f"  Solution: {recommendation.short_description.solution}")
        print("-" * 20)
except Exception as e:
    print(f"Failed to list recommendations: {e}")