Registry / azure / azure-mgmt-synapse

azure-mgmt-synapse

JSON →
library2.0.0pypypi✓ verified 25d ago

The Microsoft Azure Synapse Management Client Library for Python (azure-mgmt-synapse) provides the necessary tools to manage Azure Synapse Analytics workspaces, SQL pools, Apache Spark pools, and integration runtimes. It enables programmatic control over Synapse resources within an Azure subscription. The library is currently at version 2.0.0 (released April 2021) and adheres to the standard Azure SDK guidelines, offering a stable interface for managing Synapse services.

pip install azure-mgmt-synapse
INSTALL
IMPORT
SIG · AZURE-MGMT-SYNAPSE
A
azure-mgmt-synapse
azurepythonv2.0.0
Install
3.2s avg
Import
Disk
30MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.93.13
musl
3.93.13
Install & Compatibility
Where this runs
tested against v2.0.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.103.95 runs
installs and imports cleanly · install 0.0s · import 0.000s · 30.7MB
glibc
py 3.103.95 runs
installs and imports cleanly · install 3.2s · import 0.000s · 31MB
30MB installed
● package 30MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

SynapseManagementClient
from azure.mgmt.synapse import SynapseManagementClient
from azure.mgmt.synapse import SynapseManagementClient

This quickstart demonstrates how to authenticate with Azure using `DefaultAzureCredential` and then list all Azure Synapse workspaces within a specified subscription using `SynapseManagementClient`.

import os from azure.identity import DefaultAzureCredential from azure.mgmt.synapse import SynapseManagementClient # Set the AZURE_SUBSCRIPTION_ID environment variable or replace with your actual 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 provide your subscription ID.") # Authenticate using DefaultAzureCredential, which handles various Azure authentication methods. # For local development, ensure you are logged in via Azure CLI (`az login`) # or have appropriate environment variables set. credential = DefaultAzureCredential() # Create a SynapseManagementClient client = SynapseManagementClient(credential, subscription_id) print("Listing Synapse Workspaces:") # Iterate over the workspaces in your subscription for workspace in client.workspaces.list(): print(f"- {workspace.name} (Location: {workspace.location})")
Debug
Known issues
breakingBreaking changes were introduced in version 2.0.0, significantly revamping the authentication and client interaction model. The legacy `azure.common.credentials` or `msrestazure.azure_active_directory` instances are no longer supported. The `credentials` parameter was renamed to `credential`.
fix
Migrate to `azure-identity` classes (e.g., `DefaultAzureCredential`) for authentication. Update client instantiation to pass a `credential` object and pass configuration as keyword arguments instead of a `config` attribute.
affects: <2.0.0
breakingLong-running operations (LROs) that previously returned `msrest.polling.LROPoller` now return `azure.core.polling.LROPoller` and are typically prefixed with `begin_`.
fix
Adjust code to use the `begin_` prefix for LRO methods and expect `azure.core.polling.LROPoller` for polling results.
affects: <2.0.0
breakingThe exception hierarchy has been simplified. Most exceptions now derive from `azure.core.exceptions.HttpResponseError`, and `CloudError` has been removed.
fix
Update exception handling to catch `azure.core.exceptions.HttpResponseError` instead of `CloudError` or other specific legacy exceptions.
affects: <2.0.0
breakingModel changes: `WorkspacePatchInfo` and `Workspace` models no longer have the `network_settings` parameter in version 2.0.0. Instead, `public_network_access` was added.
fix
Review model usage when updating or creating Synapse workspaces; adjust parameters for `WorkspacePatchInfo` and `Workspace` accordingly, using `public_network_access` if needed.
affects: <2.0.0
gotchaConfusion between Python and .NET SDK status: The .NET NuGet package `Microsoft.Azure.Management.Synapse` is deprecated and no longer maintained. However, this Python library (`azure-mgmt-synapse`) remains active and supported. Users should ensure they are referencing the correct SDK for their language.
fix
Always verify the status and documentation for the specific language SDK being used. For Python, `azure-mgmt-synapse` is the current management library.
affects: All versions
Upgrade
Version history
2.0.0latest on PyPI · released Apr 8, 2021
Audit
Dependencies
azure-identityrequiredRequired for authenticating with Azure services using modern credential flows.
azure-corerequiredProvides shared core functionality, including transport pipelines, exceptions, and helpers.
Agent activity
47 hits · last 30 days
node
42
OpenAI (training)
1
Resources
azure-mgmt-synapse — pip install azure-mgmt-synapse · libregistry