Azure SQL Management Client Library

Warnings

• breaking Migration from older Azure SDK (Track 1) clients to current (Track 2) clients involves significant breaking changes in client construction, authentication, and method signatures.
  Fix: Adopt `azure-identity` for authentication (e.g., `DefaultAzureCredential`). Client constructors now typically require a credential object and `subscription_id`. Method parameters and return types have been updated to be more consistent with the Azure REST API and Pythonic conventions. Consult the official Azure SDK documentation for the specific version.
• gotcha Many Azure SQL management operations are resource group-scoped. Operations like creating a server or database, or getting specific properties, require the resource group name in addition to the resource name.
  Fix: Always be mindful of the required scope for an operation. If an operation fails with a 'resource not found' or 'bad request' error, double-check if the resource group name is correctly provided and if the resource actually exists within that resource group.
• gotcha Azure SDK for Python offers both synchronous and asynchronous clients (e.g., `SqlManagementClient` vs `AsyncSqlManagementClient`). Mixing these can lead to runtime errors.
  Fix: Decide whether you need synchronous or asynchronous operations for your application. If using `asyncio`, import and instantiate the `AsyncSqlManagementClient` and `await` its methods. For synchronous operations, use `SqlManagementClient` and do not use `await`.
• gotcha List operations (e.g., `servers.list()`, `databases.list_by_server()`) return an iterable object (a 'pager') which needs to be iterated over to fetch all results, rather than a simple Python list.
  Fix: Always iterate over the result of a list operation. For example, `for server in sql_client.servers.list():` or convert to a list explicitly if all results are needed upfront: `all_servers = list(sql_client.servers.list())`.

Install

• pip install azure-mgmt-sql azure-identity Install core and authentication

Imports

• SqlManagementClient

  from azure.mgmt.sql import SqlManagementClient

  The client class is directly available under the top-level package.
• DefaultAzureCredential

  from azure.identity import DefaultAzureCredential

  Standard authentication credential for Azure SDK (Track 2).

Quickstart

This quickstart demonstrates how to authenticate with Azure using `DefaultAzureCredential`, instantiate the `SqlManagementClient`, and then list all Azure SQL Servers within a specified subscription. Ensure `AZURE_SUBSCRIPTION_ID` is set in your environment variables for authentication.

import os
from azure.identity import DefaultAzureCredential
from azure.mgmt.sql import SqlManagementClient

# Set your Azure Subscription ID in environment variables or replace directly
# e.g., AZURE_SUBSCRIPTION_ID = 'your-subscription-id'
subscription_id = os.environ.get('AZURE_SUBSCRIPTION_ID', 'YOUR_SUBSCRIPTION_ID')

if subscription_id == 'YOUR_SUBSCRIPTION_ID':
    raise ValueError("Please set the AZURE_SUBSCRIPTION_ID environment variable or replace 'YOUR_SUBSCRIPTION_ID'")

# Authenticate using DefaultAzureCredential
# This tries a series of authentication methods (environment variables, managed identity, VS Code, Azure CLI, etc.)
credential = DefaultAzureCredential()

# Create a SQL Management Client
sql_client = SqlManagementClient(credential, subscription_id)

print(f"Listing SQL Servers in subscription '{subscription_id}':")
# List all SQL Servers in the subscription
try:
    sql_servers = sql_client.servers.list()
    for server in sql_servers:
        print(f"  - Server Name: {server.name}, Location: {server.location}")
except Exception as e:
    print(f"An error occurred: {e}")