azure-synapse-artifacts

What it is and what it does

Azure Synapse Artifacts is the official Microsoft Python client for managing Synapse workspace artifacts—pipelines, datasets, linked services, and related metadata objects. It wraps the Azure Synapse REST API, allowing developers to programmatically define, deploy, and orchestrate data integration workflows within Azure Synapse Analytics.

The library depends on isodate for date parsing, azure-common and azure-mgmt-core for shared Azure SDK infrastructure, and typing-extensions for backward-compatible type hints. It is tested on Python 3.9 and later, actively maintained with recent feature additions across multiple linked service and dataset models, and carries no known security vulnerabilities.

Use it for:

• Automate creation and deployment of Synapse pipelines and datasets as part of infrastructure-as-code workflows.
• Build CI/CD pipelines that programmatically update linked service configurations or dataset schemas in response to environment changes.
• Query and manage artifact metadata (pipelines, triggers, datasets) from custom monitoring or governance applications.
• Migrate or replicate Synapse workspace artifacts between development, staging, and production environments.
• Integrate Synapse artifact management into Python-based data orchestration frameworks or workflow engines.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides Python client library for Azure Synapse Artifacts, enabling programmatic access to create, manage, and interact with Synapse workspace artifacts including pipelines, datasets, and linked services.

Yes. This is the official, actively maintained client for Azure Synapse Artifacts with no security vulnerabilities, permissive MIT licensing, low install friction, and broad Python version support (3.9–3.13). Install it if you need programmatic control over Synapse workspace artifacts; skip it if you only use the Azure Portal or CLI for artifact management.

Install

azure-synapse-artifacts on PyPI

pip install azure-synapse-artifacts

uv add azure-synapse-artifacts

poetry add azure-synapse-artifacts

Installing azure-synapse-artifacts

Before you install

Low install friction with a pure-Python wheel distribution. Maintained actively with recent releases; last commit 2026-08-14 and version 0.22.0 released 2026-03-23. Supports Python 3.9–3.13 and carries Production/Stable status.

License in practice

MIT License (permissive) allows unrestricted use, modification, and distribution in both open-source and commercial projects with minimal obligations.

Quickstart

pip install azure-synapse-artifacts

from azure.synapse.artifacts import ArtifactsClient
from azure.common import AzureHttpError

import os
endpoint = os.environ["SYNAPSE_ARTIFACTS_ENDPOINT"]
client = ArtifactsClient(endpoint=endpoint, credential=credential)

Requires Python 3.9 or later, Azure subscription, and valid Azure credentials configured via environment variables (AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET).

Verify before relying

• Whether the package supports offline or local-only artifact management without live Azure connectivity.
• Performance characteristics and rate limits when managing large numbers of artifacts or complex pipelines.
• Compatibility with non-Microsoft data sources or custom linked service types beyond those documented in release notes.

Package facts

Evidence: azure_synapse_artifacts-0.22.0-py3-none-any.whl

Keywords: azure, azure sdk

Tags

More Database packages