Package: azure-synapse-artifacts
Microsoft Azure SDK for PythonThis is the Microsoft Azure Synapse Artifacts Client Library.
This package has been tested with Python 3.7+.
For a more complete view of Azure libraries, see theazure sdk python release.DisclaimerAzure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer tohttps://github.com/Azure/azure-sdk-for-python/issues/20691Getting startedPrerequisitesPython 3.7+ is required to use this package.Azure subscriptionInstall the packagepipinstallazure-synapse-artifacts
pipinstallazure-identityAuthenticationBy default,Azure Active Directorytoken authentication depends on correct configure of following environment variables.AZURE_CLIENT_IDfor Azure client ID.AZURE_TENANT_IDfor Azure tenant ID.AZURE_CLIENT_SECRETfor Azure client secret.With above configuration, client can be authenticated by following code:importosfromazure.identityimportDefaultAzureCredentialfromazure.synapse.artifactsimportArtifactsClientendpoint=os.environ["SYNAPSE_ARTIFACTS_ENDPOINT"]client=ArtifactsClient(endpoint=endpoint,credential=DefaultAzureCredential())ExamplesCode samples for this package can be found at:Search Synapse Artifactson docs.microsoft.comTroubleshootingNext stepsProvide FeedbackIf you encounter any bugs or have suggestions, please file an issue in theIssuessection of the project.Release History0.18.0 (2023-10-30)Bugs FixedFix runNotebook sessionId from int to string #25210Fix placeholder links causing 404s #26143Other ChangesSync expression Support From DataFactory To Synapse #250540.17.0 (2023-07-28)Features AddedAdded operation group RunNotebookOperationsModel Activity has a new parameter on_inactive_mark_asModel Activity has a new parameter stateModel AmazonRdsForSqlServerLinkedService has a new parameter always_encrypted_settingsModel AmazonRdsForSqlServerSource has a new parameter isolation_levelModel AppendVariableActivity has a new parameter on_inactive_mark_asModel AppendVariableActivity has a new parameter stateModel AzureBatchLinkedService has a new parameter credentialModel AzureBlobFSLinkedService has a new parameter credentialModel AzureBlobStorageLinkedService has a new parameter credentialModel AzureDataExplorerCommandActivity has a new parameter on_inactive_mark_asModel AzureDataExplorerCommandActivity has a new parameter stateModel AzureDataExplorerLinkedService has a new parameter credentialModel AzureDataLakeStoreLinkedService has a new parameter credentialModel AzureDatabricksDeltaLakeLinkedService has a new parameter credentialModel AzureDatabricksLinkedService has a new parameter credentialModel AzureFunctionActivity has a new parameter on_inactive_mark_asModel AzureFunctionActivity has a new parameter stateModel AzureFunctionLinkedService has a new parameter authenticationModel AzureFunctionLinkedService has a new parameter credentialModel AzureFunctionLinkedService has a new parameter resource_idModel AzureKeyVaultLinkedService has a new parameter credentialModel AzureMLBatchExecutionActivity has a new parameter on_inactive_mark_asModel AzureMLBatchExecutionActivity has a new parameter stateModel AzureMLExecutePipelineActivity has a new parameter on_inactive_mark_asModel AzureMLExecutePipelineActivity has a new parameter stateModel AzureMLLinkedService has a new parameter authenticationModel AzureMLServiceLinkedService has a new parameter authenticationModel AzureMLUpdateResourceActivity has a new parameter on_inactive_mark_asModel AzureMLUpdateResourceActivity has a new parameter stateModel AzureSqlDWLinkedService has a new parameter credentialModel AzureSqlDatabaseLinkedService has a new parameter always_encrypted_settingsModel AzureSqlDatabaseLinkedService has a new parameter credentialModel AzureSqlMILinkedService has a new parameter always_encrypted_settingsModel AzureSqlMILinkedService has a new parameter credentialModel AzureSqlSource has a new parameter isolation_levelModel ControlActivity has a new parameter on_inactive_mark_asModel ControlActivity has a new parameter stateModel CopyActivity has a new parameter on_inactive_mark_asModel CopyActivity has a new parameter stateModel CosmosDbLinkedService has a new parameter credentialModel CustomActivity has a new parameter on_inactive_mark_asModel CustomActivity has a new parameter stateModel DataLakeAnalyticsUSQLActivity has a new parameter on_inactive_mark_asModel DataLakeAnalyticsUSQLActivity has a new parameter stateModel DatabricksNotebookActivity has a new parameter on_inactive_mark_asModel DatabricksNotebookActivity has a new parameter stateModel DatabricksSparkJarActivity has a new parameter on_inactive_mark_asModel DatabricksSparkJarActivity has a new parameter stateModel DatabricksSparkPythonActivity has a new parameter on_inactive_mark_asModel DatabricksSparkPythonActivity has a new parameter stateModel DeleteActivity has a new parameter on_inactive_mark_asModel DeleteActivity has a new parameter stateModel DynamicsLinkedService has a new parameter credentialModel ExecuteDataFlowActivity has a new parameter on_inactive_mark_asModel ExecuteDataFlowActivity has a new parameter stateModel ExecutePipelineActivity has a new parameter on_inactive_mark_asModel ExecutePipelineActivity has a new parameter stateModel ExecuteSSISPackageActivity has a new parameter on_inactive_mark_asModel ExecuteSSISPackageActivity has a new parameter stateModel ExecutionActivity has a new parameter on_inactive_mark_asModel ExecutionActivity has a new parameter stateModel FailActivity has a new parameter on_inactive_mark_asModel FailActivity has a new parameter stateModel FilterActivity has a new parameter on_inactive_mark_asModel FilterActivity has a new parameter stateModel ForEachActivity has a new parameter on_inactive_mark_asModel ForEachActivity has a new parameter stateModel GetMetadataActivity has a new parameter on_inactive_mark_asModel GetMetadataActivity has a new parameter stateModel HDInsightHiveActivity has a new parameter on_inactive_mark_asModel HDInsightHiveActivity has a new parameter stateModel HDInsightMapReduceActivity has a new parameter on_inactive_mark_asModel HDInsightMapReduceActivity has a new parameter stateModel HDInsightOnDemandLinkedService has a new parameter credentialModel HDInsightPigActivity has a new parameter on_inactive_mark_asModel HDInsightPigActivity has a new parameter stateModel HDInsightSparkActivity has a new parameter on_inactive_mark_asModel HDInsightSparkActivity has a new parameter stateModel HDInsightStreamingActivity has a new parameter on_inactive_mark_asModel HDInsightStreamingActivity has a new parameter stateModel IfConditionActivity has a new parameter on_inactive_mark_asModel IfConditionActivity has a new parameter stateModel LinkConnectionTargetDatabaseTypeProperties has a new parameter action_on_existing_target_tableModel LookupActivity has a new parameter on_inactive_mark_asModel LookupActivity has a new parameter stateModel MongoDbAtlasLinkedService has a new parameter driver_versionModel RestServiceLinkedService has a new parameter credentialModel ScriptActivity has a new parameter on_inactive_mark_asModel ScriptActivity has a new parameter stateModel SetVariableActivity has a new parameter on_inactive_mark_asModel SetVariableActivity has a new parameter policyModel SetVariableActivity has a new parameter stateModel SqlDWSource has a new parameter isolation_levelModel SqlMISource has a new parameter isolation_levelModel SqlPoolStoredProcedureActivity has a new parameter on_inactive_mark_asModel SqlPoolStoredProcedureActivity has a new parameter stateModel SqlServerLinkedService has a new parameter always_encrypted_settingsModel SqlServerSource has a new parameter isolation_levelModel SqlServerStoredProcedureActivity has a new parameter on_inactive_mark_asModel SqlServerStoredProcedureActivity has a new parameter stateModel SwitchActivity has a new parameter on_inactive_mark_asModel SwitchActivity has a new parameter stateModel SynapseNotebookActivity has a new parameter configuration_typeModel SynapseNotebookActivity has a new parameter on_inactive_mark_asModel SynapseNotebookActivity has a new parameter spark_configModel SynapseNotebookActivity has a new parameter stateModel SynapseNotebookActivity has a new parameter target_spark_configurationModel SynapseSparkJobDefinitionActivity has a new parameter on_inactive_mark_asModel SynapseSparkJobDefinitionActivity has a new parameter stateModel UntilActivity has a new parameter on_inactive_mark_asModel UntilActivity has a new parameter stateModel ValidationActivity has a new parameter on_inactive_mark_asModel ValidationActivity has a new parameter stateModel WaitActivity has a new parameter on_inactive_mark_asModel WaitActivity has a new parameter stateModel WebActivity has a new parameter on_inactive_mark_asModel WebActivity has a new parameter stateModel WebActivityAuthentication has a new parameter credentialModel WebActivityAuthentication has a new parameter user_tenantModel WebHookActivity has a new parameter on_inactive_mark_asModel WebHookActivity has a new parameter state0.16.0 (2023-05-12)Bugs FixedFix to support IO input  #296150.15.0 (2023-01-09)Features AddedModel AzureSynapseArtifactsLinkedService has a new parameter workspace_resource_idModel RestServiceLinkedService has a new parameter auth_headersModel SynapseSparkJobDefinitionActivity has a new parameter configuration_typeModel SynapseSparkJobDefinitionActivity has a new parameter files_v2Model SynapseSparkJobDefinitionActivity has a new parameter python_code_referenceModel SynapseSparkJobDefinitionActivity has a new parameter scan_folderModel SynapseSparkJobDefinitionActivity has a new parameter spark_configModel SynapseSparkJobDefinitionActivity has a new parameter target_spark_configurationBreaking ChangesParameter export_settings of model SnowflakeSource is now requiredRenamed operation LinkConnectionOperations.create_or_update_link_connection to LinkConnectionOperations.create_or_updateRenamed operation LinkConnectionOperations.delete_link_connection to LinkConnectionOperations.deleteRenamed operation LinkConnectionOperations.get_link_connection to LinkConnectionOperations.getRenamed operation LinkConnectionOperations.list_link_connections_by_workspace to LinkConnectionOperations.list_by_workspace0.14.0 (2022-09-19)Features AddedUpgraded api-version for some operation groupOther ChangesDrop support for python3.60.13.0 (2022-04-21)FeaturesAdded operation group LinkConnectionOperations0.12.0 (2022-03-07)Features Addedre-generated based on tag package-artifacts-composite-v30.11.0 (2022-01-11)Features AddedAddedMetastoreOperationsOther ChangesPython 2.7 and 3.6 are no longer supported. Please use Python version 3.7 or later.0.10.0 (2021-11-09)Other ChangesInternal bugfixes (re-generated with latest generator)0.9.0 (2021-10-05)Features Addedre-generated based on tag package-artifacts-composite-v10.8.0 (2021-08-10)Updated API version to "2020-12-01" which is the default API versionAddedNotebookOperationResultOperations,OperationResultOperations,OperationStatusOperationsAdded API version "2021-06-01-preview" support0.7.0 (2021-05-11)Bug fixesEnable poller when starting a long running operation    #181840.6.0 (2021-04-06)New FeaturesAdd ADF support0.5.0 (2021-03-09)New FeaturesAdd library operationsChange create_or_update_sql_script, delete_sql_script, rename_sql_script to long running operationsBreaking changesStop Python 3.5 support0.4.0 (2020-12-08)New FeaturesAdd Workspace git repo management operationsAdd rename method for data flow, dataset, linked service, notebook, pipeline, spark job definition, sql script operations0.3.0 (2020-09-15)New FeaturesAdd Workspace operationsAdd SqlPools operationsAdd BigDataPools operationsAdd IntegrationRuntimes operationsBreaking changesMigrated most long running operation to polling mechanism (operation now starts withbegin)0.2.0 (2020-07-01)Initial Release