Registry / azure / azure-synapse-artifacts

azure-synapse-artifacts

library0.22.0pypypi✓ verified 25d ago

The Microsoft Azure Synapse Artifacts Client Library for Python allows interaction with Azure Synapse Analytics workspaces to manage data factory artifacts like pipelines, datasets, linked services, and data flows. As of its current version 0.22.0, it provides a programmatic interface for creating, reading, updating, and deleting these resources. The library follows the Azure SDK guidelines for Python, utilizing `azure-core` and `azure-identity` for consistent interaction and authentication. New versions are released as part of the broader Azure SDK for Python release train, typically on a monthly or bi-monthly cadence, with `0.x.x` versions indicating a preview status.

azure devops data http-networking

pip install azure-synapse-artifacts

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · AZURE-SYNAPSE-ARTI

azure-synapse-artifacts

azurepythonv0.22.0

Install

3.0s avg

Import

—

Disk

31MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v0.22.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.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 32.4MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 3.0s · import 0.000s · 33MB

31MB installed

● package 31MB

Code

Verified usage

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

SynapseArtifactsClient

✓ from azure.synapse.artifacts import SynapseArtifactsClient

✗ from azure.synapse.artifacts.aio import SynapseArtifactsClient

This quickstart demonstrates how to initialize the `SynapseArtifactsClient` using `DefaultAzureCredential` and list the pipelines within your Azure Synapse Analytics workspace. Ensure your `AZURE_SYNAPSE_WORKSPACE_URL` environment variable is set to your workspace's development endpoint (e.g., `https://{workspace_name}.dev.azuresynapse.net`) and your Azure credentials are configured for `DefaultAzureCredential` to function, typically via environment variables like `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET` for service principals.

import os from azure.identity import DefaultAzureCredential from azure.synapse.artifacts import SynapseArtifactsClient # Set your Synapse workspace endpoint. It should look like: https://{workspace_name}.dev.azuresynapse.net synapse_workspace_url = os.environ.get('AZURE_SYNAPSE_WORKSPACE_URL', 'https://your-synapse-workspace.dev.azuresynapse.net') if not synapse_workspace_url: raise ValueError("Please set the 'AZURE_SYNAPSE_WORKSPACE_URL' environment variable.") try: # Authenticate with DefaultAzureCredential credential = DefaultAzureCredential() # Create a SynapseArtifactsClient client = SynapseArtifactsClient(endpoint=synapse_workspace_url, credential=credential) print(f"Connected to Synapse workspace: {synapse_workspace_url}") # List pipelines in the workspace print("Listing pipelines:") pipelines = client.pipeline.get_pipelines_by_workspace() for pipeline in pipelines: print(f" - {pipeline.name}") except Exception as e: print(f"An error occurred: {e}") print("Please ensure 'AZURE_SYNAPSE_WORKSPACE_URL' is set and your Azure credentials are configured.") print("For DefaultAzureCredential, ensure AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET (or other auth methods) are set.")

Debug

Known issues

breakingThe library is currently in a preview (0.x.x) version. APIs are subject to change without notice before a 1.0.0 stable release, which may introduce breaking changes in future minor versions.

fix

Be prepared for potential API changes when upgrading. Monitor release notes closely for updates and consider pinning to specific preview versions in production environments until 1.0.0 is released.

affects: <1.0.0

gotchaThe Synapse workspace endpoint URL must be in the correct format, typically `https://{workspace_name}.dev.azuresynapse.net`. Incorrect URLs (e.g., missing `.dev` or `.net`) will lead to connection errors.

fix

Always verify the endpoint format from your Synapse workspace overview in the Azure portal or by inspecting the workspace properties. Set the `endpoint` parameter of `SynapseArtifactsClient` accordingly.

affects: *

gotchaUsing `DefaultAzureCredential` for authentication requires proper configuration of Azure environment variables (e.g., `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET` for a service principal, or local login via `az login`).

fix

Refer to the `azure-identity` documentation for setting up `DefaultAzureCredential`. Ensure the identity used has sufficient permissions (e.g., 'Synapse Contributor' or 'Synapse Artifact User') on the Synapse workspace.

affects: *

gotchaThe `azure-identity` package, which provides `DefaultAzureCredential`, is a separate dependency and must be installed. Not installing it will result in a `ModuleNotFoundError` when attempting to import or use it.

fix

Ensure `azure-identity` is included in your project dependencies. Install it using `pip install azure-identity`.

affects: *

gotchaThe 'azure-identity' package is a required dependency for authentication using DefaultAzureCredential. It must be installed separately.

fix

Install the 'azure-identity' package using pip: 'pip install azure-identity'.

affects: *

Upgrade

Version history

0.22.0latest on PyPI · released Mar 23, 2026

Audit

Dependencies

azure-identityrequiredRequired for authentication using Azure Active Directory, typically via DefaultAzureCredential.

Agent activity

43 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/Azure/azure-sdk-for-python ↗

packagehttps://pypi.org/project/azure-synapse-artifacts/ ↗

homepagehttps://azure.microsoft.com/products/synapse-analytics/ ↗