Azure Search Management Client Library

9.2.0 · active · verified Thu Apr 09

The `azure-mgmt-search` library provides a client for managing Azure AI Search (formerly Azure Cognitive Search) resources, including search services, private endpoint connections, and shared private link resources. It is part of the Azure SDK for Python, currently at version 9.2.0, and follows the Azure SDK's regular release cadence with updates typically released monthly or bi-monthly.

Warnings

breaking The `api_version` parameter is no longer directly passed to the `SearchManagementClient` constructor in version 9.x. The SDK now internally manages the API version corresponding to the client library version. Attempting to pass `api_version` will result in a `TypeError` or unexpected behavior.
Fix: Remove the `api_version` argument from the `SearchManagementClient` constructor. The SDK will use the appropriate API version.
gotcha List operations (e.g., `client.services.list_by_subscription()`) return a paged iterator (`ItemPaged`), not a Python list. You must iterate over the returned object to access all items. Directly indexing or assuming it's a complete list will lead to errors or only partial results.
Fix: Always iterate directly over the returned paged object (e.g., `for service in client.services.list_by_subscription():`) or explicitly convert it to a list if all results are needed in memory (e.g., `list(client.services.list_by_subscription())`).
gotcha Using `DefaultAzureCredential` requires proper environment variable configuration (e.g., `AZURE_TENANT_ID`, `AZURE_CLIENT_ID`, `AZURE_CLIENT_SECRET` for service principal) or active login via Azure CLI (`az login`) or Visual Studio Code with the Azure Account extension. Failing to set this up correctly will result in authentication errors.
Fix: Refer to the `azure-identity` documentation for setting up `DefaultAzureCredential`. Ensure required environment variables are present or you are logged in through one of the supported development tools.
breaking Between versions 8.x and 9.x, some model property names or structures within the management objects (e.g., for `SearchService`, `Sku`, `AdminKey`, `QueryKey`) have been updated or renamed to align with newer API versions or Azure naming conventions (e.g., Azure AI Search).
Fix: Consult the API reference for version 9.x to ensure correct property access and object construction. You may need to update your code to use the new property names or model structures.

Install

pip install azure-mgmt-search azure-identity Install with authentication dependency

Imports

SearchManagementClient

from azure.mgmt.search import SearchManagementClient

DefaultAzureCredential
```
from azure.identity import DefaultAzureCredential
```
Incorrectly importing from the data plane SDK (`azure-search-documents`) for management operations.

Quickstart

This quickstart demonstrates how to authenticate with Azure using `DefaultAzureCredential` and list Azure AI Search services within your subscription and a specific resource group using `SearchManagementClient`. It assumes you have the necessary environment variables set for authentication or are logged in via Azure CLI/VS Code.

import os
from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient

# Ensure these environment variables are set for DefaultAzureCredential
# AZURE_CLIENT_ID, AZURE_CLIENT_SECRET, AZURE_TENANT_ID for service principal
# Or AZURE_SUBSCRIPTION_ID and logged in via Azure CLI/VS Code

subscription_id = os.environ.get("AZURE_SUBSCRIPTION_ID", "<your-subscription-id>")
resource_group_name = os.environ.get("AZURE_RESOURCE_GROUP_NAME", "<your-resource-group-name>")
search_service_name = os.environ.get("AZURE_SEARCH_SERVICE_NAME", "<your-search-service-name>")

if subscription_id == "<your-subscription-id>":
    print("Please set the AZURE_SUBSCRIPTION_ID environment variable.")
    exit(1)

# Authenticate using DefaultAzureCredential
credential = DefaultAzureCredential()

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

try:
    # Example 1: List all search services in the subscription
    print("\nListing all search services in subscription:")
    for service in client.services.list_by_subscription():
        print(f"  - {service.name} (Location: {service.location}, SKU: {service.sku.name})")

    # Example 2: List search services in a specific resource group
    if resource_group_name != "<your-resource-group-name>":
        print(f"\nListing search services in resource group '{resource_group_name}':")
        for service in client.services.list_by_resource_group(resource_group_name):
            print(f"  - {service.name} (Location: {service.location}, SKU: {service.sku.name})")
    else:
        print("\nTo list services by resource group, set AZURE_RESOURCE_GROUP_NAME.")

except Exception as e:
    print(f"An error occurred: {e}")

view raw JSON →