Microsoft Azure Maps Client Library for Python

Warnings

• breaking In `azure-mgmt-maps` version 2.0.0, the credential system was completely revamped. Old authentication methods (e.g., `azure.common.credentials` or `msrestazure.azure_active_directory`) are no longer supported. Users must migrate to `azure-identity` classes (e.g., `DefaultAzureCredential`). Additionally, the `credentials` parameter in client constructors was renamed to `credential`.
  Fix: Update your authentication logic to use classes from `azure.identity` (e.g., `DefaultAzureCredential`) and pass the credential object to the `credential` parameter of the `MapsManagementClient` constructor.
• breaking Version 2.0.0 introduced several parameter renames for Maps account operations. Specifically, `maps_account_id` was renamed to `account_id` in methods like `accounts.delete`, `accounts.get`, `accounts.list_by_resource_group`, and `accounts.list_keys`. Similarly, `maps_account` was renamed to `account` in `accounts.create_or_update`.
  Fix: Review your code for method calls involving Maps accounts and update parameter names from `maps_account_id` to `account_id` and `maps_account` to `account` as appropriate.
• breaking As of `azure-mgmt-maps` version 2.0.0, long-running operations (LROs) that previously returned `msrest.polling.LROPoller` now return `azure.core.polling.LROPoller` and are consistently prefixed with `begin_`. The `CloudError` exception has also been removed; most exceptions are now `azure.core.exceptions.HttpResponseError`.
  Fix: Adjust LRO calls to use the `begin_` prefix and handle `azure.core.exceptions.HttpResponseError` for general API errors. Update any custom error handling logic.
• breaking A beta version `3.0.0b1` introduces significant breaking changes related to 'hybrid models'. Many instance variables (e.g., `provisioning_state`, `storage_units`, `linked_resources`, `cors`, `encryption`) have moved under a `properties` object within models like `CreatorUpdateParameters` and `MapsAccountUpdateParameters`. Enum values like `Kind.GEN1` and `Name.S0`, `Name.S1` were also deleted or renamed.
  Fix: If upgrading to `3.0.0b1` or later, consult the migration guide for hybrid models and adjust property access accordingly. It's recommended to stick to stable versions unless actively testing beta features.
• gotcha To manage Azure Maps resources, the authenticated identity (e.g., via `DefaultAzureCredential`) must have appropriate Azure RBAC permissions. Roles like 'Maps Contributor' or 'Owner' are typically required to create, update, or delete Maps accounts.
  Fix: Ensure the service principal or user identity being used has the necessary RBAC roles assigned on the subscription, resource group, or Maps account scope.
• gotcha When creating or updating an Azure Maps account, the `sku` parameter is mandatory. It defines the pricing tier and capabilities (e.g., 'G2' for Gen2, 'S1' for Gen1). Omitting or providing an invalid SKU will result in a deployment error.
  Fix: Always include a valid `sku` object (e.g., `{"name": "G2"}`) in your account creation or update payload.

Install

• pip install azure-mgmt-maps Install core library
• pip install azure-identity Install for Azure AD authentication

Imports

• MapsManagementClient

  from azure.mgmt.maps import MapsManagementClient

  The client class was renamed from `AzureMapsManagementClient` (pre-2.x) to `MapsManagementClient` in 2.x. While some older documentation or PyPI snippets might still show the old name, `MapsManagementClient` is the current and correct class to import for versions 2.x and later.
• DefaultAzureCredential

  from azure.identity import DefaultAzureCredential

  Used for Azure Active Directory authentication in the Azure SDK for Python.

Quickstart

This quickstart demonstrates how to authenticate with Azure, list existing Maps accounts, and create or update an Azure Maps account using the `azure-mgmt-maps` library. It uses `DefaultAzureCredential` for authentication, which is suitable for local development and production environments. Ensure you have an Azure subscription ID and an existing resource group.

import os
from azure.identity import DefaultAzureCredential
from azure.mgmt.maps import MapsManagementClient

# Set your Azure Subscription ID as an environment variable (AZURE_SUBSCRIPTION_ID)
subscription_id = os.environ.get("AZURE_SUBSCRIPTION_ID", "")
resource_group_name = "myMapsResourceGroup" # Replace with your resource group name
maps_account_name = "myUniqueMapsAccount" # Replace with your desired Maps account name
location = "eastus" # Replace with your desired Azure region

if not subscription_id:
    print("Please set the AZURE_SUBSCRIPTION_ID environment variable.")
else:
    # Authenticate using DefaultAzureCredential
    # This credential will attempt to authenticate via several mechanisms,
    # including environment variables, managed identity, and Azure CLI/PowerShell.
    credential = DefaultAzureCredential()

    # Create a MapsManagementClient
    maps_client = MapsManagementClient(credential, subscription_id)

    print(f"Listing existing Maps accounts in subscription '{subscription_id}'...")
    for account in maps_client.accounts.list_by_subscription():
        print(f"  - {account.name} (Location: {account.location}, SKU: {account.sku.name})")

    print(f"\nCreating or updating Maps account '{maps_account_name}' in resource group '{resource_group_name}'...")
    try:
        # Ensure the resource group exists before creating a Maps account.
        # This example assumes the resource group already exists.
        maps_account = maps_client.accounts.begin_create_or_update(
            resource_group_name=resource_group_name,
            account_name=maps_account_name,
            account={
                "location": location,
                "sku": {"name": "G2"}, # 'S1' (Gen1) or 'G2' (Gen2) are common SKUs
                "tags": {"environment": "development", "project": "maps-demo"}
            }
        ).result()
        print(f"Successfully created/updated Maps account: {maps_account.name} (SKU: {maps_account.sku.name})")

        print(f"\nGetting keys for Maps account '{maps_account_name}'...")
        keys = maps_client.accounts.list_keys(resource_group_name, maps_account_name)
        print(f"  - Primary Key: {keys.primary_key}")

        # Optional: Delete the Maps account
        # print(f"\nDeleting Maps account '{maps_account_name}'...")
        # maps_client.accounts.begin_delete(resource_group_name, maps_account_name).result()
        # print(f"Maps account '{maps_account_name}' deleted successfully.")

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