Microsoft Azure SDK for Python

This is the Microsoft Azure Synapse Artifacts Client Library. This package has been tested with Python 3.8+. For a more complete view of Azure libraries, see the azure sdk python release.

Disclaimer

Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691

Getting started

Prerequisites

• Python 3.8+ is required to use this package.
• Azure subscription

Install the package

pip install azure-synapse-artifacts
pip install azure-identity

Authentication

By default, Azure Active Directory token authentication depends on correct configure of following environment variables.

• AZURE_CLIENT_ID for Azure client ID.
• AZURE_TENANT_ID for Azure tenant ID.
• AZURE_CLIENT_SECRET for Azure client secret.

With above configuration, client can be authenticated by following code:

import os
from azure.identity import DefaultAzureCredential
from azure.synapse.artifacts import ArtifactsClient

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

Examples

Code samples for this package can be found at:

• Search Synapse Artifacts on docs.microsoft.com

Troubleshooting

Next steps

Provide Feedback

If you encounter any bugs or have suggestions, please file an issue in the Issues section of the project.

Release History

0.21.0 (2025-09-05)

Features Added

• Add a new Model ServiceNowV2LinkedService
• Model ServiceNowV2ObjectDataset has a new parameter table_name
• Model ServiceNowV2ObjectDataset has a new parameter value_type
• linked service add support Presto server linked service
• Model DynamicsSink has a new parameter bypass_business_logic_execution
• Model DynamicsSink has a new parameter bypass_power_automate_flows
• Model AzurePostgreSqlSink has a new parameter write_method
• Model AzurePostgreSqlSink has a new parameter upsert_settings
• Model SnowflakeV2LinkedService has a new parameter role
• Model SnowflakeV2LinkedService has a new parameter schema
• Model AzurePostgreSqlLinkedService has a new parameter service_principal_embedded_cert
• Model AzurePostgreSqlLinkedService has a new parameter service_principal_embedded_cert_password
• Model ODataLinkedService has a new parameter service_principal_embedded_cert
• Model ODataLinkedService has a new parameter service_principal_embedded_cert_password
• Model Office365LinkedService has a new parameter service_principal_embedded_cert
• Model Office365LinkedService has a new parameter service_principal_embedded_cert_password
• Model RestServiceLinkedService has a new parameter service_principal_embedded_cert
• Model RestServiceLinkedService has a new parameter service_principal_embedded_cert_password
• Model SharePointOnlineListLinkedService has a new parameter service_principal_embedded_cert
• Model SharePointOnlineListLinkedService has a new parameter service_principal_embedded_cert_password
• Model AzureDatabricksLinkedService has a new parameter data_security_mode
• Model AmazonRdsForOracleLinkedService has a new parameter server
• Model AmazonRdsForOracleLinkedService has a new parameter authentication_type
• Model AmazonRdsForOracleLinkedService has a new parameter username
• Model AmazonRdsForOracleLinkedService has a new parameter encryption_client
• Model AmazonRdsForOracleLinkedService has a new parameter encryption_types_client
• Model AmazonRdsForOracleLinkedService has a new parameter crypto_checksum_client
• Model AmazonRdsForOracleLinkedService has a new parameter crypto_checksum_types_client
• Model AmazonRdsForOracleLinkedService has a new parameter initial_lob_fetch_size
• Model AmazonRdsForOracleLinkedService has a new parameter fetch_size
• Model AmazonRdsForOracleLinkedService has a new parameter statement_cache_size
• Model AmazonRdsForOracleLinkedService has a new parameter initialization_string
• Model AmazonRdsForOracleLinkedService has a new parameter enable_bulk_load
• Model AmazonRdsForOracleLinkedService has a new parameter fetch_tswtz_as_timestamp
• Model AmazonRdsForOracleLinkedService has a new parameter support_v1_data_types
• Model FtpServerLinkedService has a new parameter enable_server_certificate_validation
• Model HiveLinkedService has a new parameter enable_server_certificate_validation
• Model HttpLinkedService has a new parameter enable_server_certificate_validation
• Model ImpalaLinkedService has a new parameter enable_server_certificate_validation
• Model RestServiceLinkedService has a new parameter enable_server_certificate_validation
• Model SparkLinkedService has a new parameter enable_server_certificate_validation
• Model QuickBooksLinkedService has a new parameter refresh_token
• Model AmazonRdsForOracleSource has a new parameter number_precision
• Model AmazonRdsForOracleSource has a new parameter number_scale
• Model OracleSource has a new parameter number_precision
• Model OracleSource has a new parameter number_scale
• Model LakeHouseLinkedService has a new parameter authentication_type
• Model LakeHouseLinkedService has a new parameter credential
• Model WarehouseLinkedService has a new parameter authentication_type
• Model WarehouseLinkedService has a new parameter credential
• Model HDInsightLinkedService has a new parameter cluster_auth_type
• Model HDInsightLinkedService has a new parameter credential

Breaking Changes

• Model LinkedService parameter OracleLinkedService parameter connection_string now is not required
• Model GreenplumLinkedService remove parameter password
• Model ExpressionV2 parameter value change its type from string to object

0.20.0 (2025-03-07)

Features Added

• Add a new Model IcebergDataset
• Add a new Model IcebergSink
• Add a new Model TeradataSink
• Model AzureFileStorageLinkedService has a new parameter service_endpoint
• Model AzureFileStorageLinkedService has a new parameter credential
• Model AzureTableStorageLinkedService has a new parameter service_endpoint
• Model AzureTableStorageLinkedService has a new parameter credential
• Model DynamicsCrmLinkedService has a new properties credential
• Model DynamicsLinkedService has a new properties domain
• Model GreenplumLinkedService has a new parameter authentication_type
• Model GreenplumLinkedService has a new parameter host
• Model GreenplumLinkedService has a new parameter port
• Model GreenplumLinkedService has a new parameter username
• Model GreenplumLinkedService has a new parameter database
• Model GreenplumLinkedService has a new parameter ssl_mode
• Model GreenplumLinkedService has a new parameter connection_timeout
• Model GreenplumLinkedService has a new parameter command_timeout
• Model GreenplumLinkedService has a new parameter password
• Model MySqlLinkedService has a new parameter allow_zero_date_time
• Model MySqlLinkedService has a new parameter connection_timeout
• Model MySqlLinkedService has a new parameter convert_zero_date_time
• Model MySqlLinkedService has a new parameter guid_format
• Model MySqlLinkedService has a new parameter ssl_cert
• Model MySqlLinkedService has a new parameter ssl_key
• Model MySqlLinkedService has a new parameter treat_tiny_as_boolean
• Model OracleLinkedService has a new parameter server
• Model OracleLinkedService has a new parameter authentication_type
• Model OracleLinkedService has a new parameter username
• Model OracleLinkedService has a new parameter encryption_client
• Model OracleLinkedService has a new parameter encryption_types_client
• Model OracleLinkedService has a new parameter crypto_checksum_client
• Model OracleLinkedService has a new parameter crypto_checksum_types_client
• Model OracleLinkedService has a new parameter initial_lob_fetch_size
• Model OracleLinkedService has a new parameter fetch_size
• Model OracleLinkedService has a new parameter statement_cache_size
• Model OracleLinkedService has a new parameter initialization_string
• Model OracleLinkedService has a new parameter enable_bulk_load
• Model OracleLinkedService has a new parameter support_v1_data_types
• Model OracleLinkedService has a new parameter fetch_tswtz_as_timestamp
• Model RestServiceLinkedService has a new parameter service_principal_credential_type
• Model RestServiceLinkedService has a new parameter service_principal_embedded_cert
• Model RestServiceLinkedService has a new parameter service_principal_embedded_cert_password
• Model SharePointOnlineListLinkedService has a new parameter service_principal_credential_type
• Model SharePointOnlineListLinkedService has a new parameter service_principal_embedded_cert
• Model SharePointOnlineListLinkedService has a new parameter service_principal_embedded_cert_password
• Model SapTableLinkedService update parameter snc_mode
• Model SnowflakeV2LinkedService has a new properties host
• Model SqlServerLinkedService has a new parameter server
• Model SqlServerLinkedService has a new parameter database
• Model SqlServerLinkedService has a new parameter encrypt
• Model SqlServerLinkedService has a new parameter trust_server_certificate
• Model SqlServerLinkedService has a new parameter host_name_in_certificate
• Model SqlServerLinkedService has a new parameter application_intent
• Model SqlServerLinkedService has a new parameter connect_timeout
• Model SqlServerLinkedService has a new parameter connect_retry_count
• Model SqlServerLinkedService has a new parameter connect_retry_interval
• Model SqlServerLinkedServic