topaz-sdk

Python SDK for Topaz — the single-binary Azure emulator.

What is Topaz?

Topaz is a single-binary local Azure emulator. Instead of running Azurite for Storage, a separate emulator for Service Bus, and another for Key Vault — you run one tool that covers the control and data planes of many Azure services, emulates ARM deployments, and implements Azure RBAC, all with no Azure subscription required.

Installation

pip install topaz-sdk

Requires Python 3.10 or later.

Quick start

from topaz_sdk import AzureLocalCredential, TopazArmClient, GLOBAL_ADMIN_ID

# Authenticate as the built-in admin user
credential = AzureLocalCredential(GLOBAL_ADMIN_ID)
client = TopazArmClient(credential)

# Create a subscription and resource group
client.create_subscription("my-subscription", "00000000-0000-0000-0000-000000000001")
client.create_resource_group(
    "00000000-0000-0000-0000-000000000001",
    "my-resource-group",
    "westeurope",
)

Using standard Azure SDK clients

topaz-sdk provides credentials and helpers that work directly with the standard azure-mgmt-* packages:

from azure.mgmt.keyvault import KeyVaultManagementClient
from topaz_sdk import AzureLocalCredential, GLOBAL_ADMIN_ID, DEFAULT_RESOURCE_MANAGER_PORT

credential = AzureLocalCredential(GLOBAL_ADMIN_ID)

client = KeyVaultManagementClient(
    credential=credential,
    subscription_id="00000000-0000-0000-0000-000000000001",
    base_url=f"https://topaz.local.dev:{DEFAULT_RESOURCE_MANAGER_PORT}",
    credential_scopes=["https://topaz.local.dev/.default"],
)

Point any azure-mgmt-* client at Topaz by overriding base_url and credential_scopes. No application code changes are required.

Provided classes

Requirements

The SDK expects a running Topaz host. See the Topaz quickstart for installation instructions.

SSL verification uses the REQUESTS_CA_BUNDLE environment variable. When running inside the Topaz test fixture container this is set automatically.

Links

• Docs: topaz.thecloudtheory.com
• Source: github.com/TheCloudTheory/Topaz
• Issues: github.com/TheCloudTheory/Topaz/issues
• Discord: discord.gg/eGTkS76w