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-synapseVerified import paths — ran on the pinned version, not inferred.
This quickstart demonstrates how to authenticate with Azure using `DefaultAzureCredential` and then list all Azure Synapse workspaces within a specified subscription using `SynapseManagementClient`.
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.
Adjust code to use the `begin_` prefix for LRO methods and expect `azure.core.polling.LROPoller` for polling results.
Update exception handling to catch `azure.core.exceptions.HttpResponseError` instead of `CloudError` or other specific legacy exceptions.
Review model usage when updating or creating Synapse workspaces; adjust parameters for `WorkspacePatchInfo` and `Workspace` accordingly, using `public_network_access` if needed.
Always verify the status and documentation for the specific language SDK being used. For Python, `azure-mgmt-synapse` is the current management library.