Microsoft Azure SDK for Python

这是Microsoft Azure Synapse Artifacts客户端库。此包已在Python 3.7+上进行测试。要查看Azure库的更完整视图，请参阅azure sdk python release。

免责声明

Azure SDK Python包对Python 2.7的支持已于2022年1月1日结束。有关更多信息及问题，请参阅https://github.com/Azure/azure-sdk-for-python/issues/20691

入门

先决条件

• 使用此包需要Python 3.7+。
• Azure订阅

安装包

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

身份验证

默认情况下，Azure Active Directory令牌身份验证依赖于正确配置以下环境变量。

• AZURE_CLIENT_ID用于Azure客户端ID。
• AZURE_TENANT_ID用于Azure租户ID。
• AZURE_CLIENT_SECRET用于Azure客户端密钥。

以上配置完成后，客户端可以通过以下代码进行身份验证

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())

示例

本包的代码示例可在以下位置找到

• 在 docs.microsoft.com 上搜索 Synapse Artifacts

故障排除

下一步操作

提供反馈

如果您遇到任何错误或建议，请在项目的 问题 部分提交问题。

发行历史

0.19.0 (2024-06-04)

新增功能

• 模型数据集新增参数 LakeHouseLocation
• 模型数据集新增参数 GoogleBigQueryV2ObjectDataset
• 模型数据集新增参数 PostgreSqlV2TableDataset
• 模型数据集新增参数 SalesforceServiceCloudV2ObjectDataset
• 模型数据集新增参数 SalesforceV2ObjectDataset
• 模型数据集新增参数 ServiceNowV2ObjectDataset
• 模型数据集新增参数 SnowflakeV2Dataset
• 模型数据集新增参数 WarehouseTableDataset
• 模型管道新增参数 ExpressionV2
• 模型管道新增参数 GoogleBigQueryV2Source
• 模型管道新增参数 LakeHouseTableSink
• 模型管道新增参数 LakeHouseTableSource
• 模型管道新增参数 LakeHouseWriteSettings
• 模型管道新增参数 LakeHouseReadSettings
• 模型管道新增参数 Metadata
• 模型管道新增参数 MetadataItem
• 模型管道新增参数 ParquetReadSettingsstate
• 模型管道新增参数 PostgreSqlV2Source
• 模型管道新增参数 SalesforceServiceCloudV2Sink
• 模型管道新增参数 SalesforceServiceCloudV2Source
• 模型管道新增参数 SalesforceV2Sink
• 模型管道新增参数 SalesforceV2SourceReadBehavior
• 模型管道新增参数 SalesforceV2Source
• 模型管道新增参数 ServiceNowV2Source
• 模型管道新增参数 SnowflakeV2Sink
• 模型管道新增参数 SnowflakeV2Source
• 模型管道新增参数 WarehouseSink
• 模型管道新增参数 WarehouseSource
• 模型链接服务支持 GoogleAds
• 模型链接服务新增参数 GoogleBigQueryV2LinkedService
• 模型链接服务新增参数 LakeHouseLinkedService
• 模型链接服务新增参数 PostgreSqlV2LinkedService
• 模型链接服务新增参数 SalesforceServiceCloudV2LinkedService
• 模型链接服务新增参数 SalesforceV2LinkedService
• 模型链接服务新增参数 SalesforceV2LinkedService
• 模型链接服务新增参数 SnowflakeV2LinkedService
• 模型链接服务新增参数 WarehouseLinkedService
• 模型链接服务新增参数 WarehouseLinkedService

重大变更

• 模型链接服务参数 MariaDBLinkedService 更新新属性
• 模型链接服务参数 MySqlLinkedService 更新新属性
• 模型链接服务参数 ServiceNowV2LinkedService 更新属性
• 模型管道参数 ExecuteDataFlowActivity 更新新属性 computeType
• 模型管道参数 ScriptActivityScriptBlock 更新属性 type

0.18.0 (2023-10-30)

已修复的错误

• 修复 runNotebook sessionId 从 int 到 string #25210
• 修复导致 404 的占位符链接 #26143

其他变更

• 同步表达式从 DataFactory 到 Synapse 支持 #25054

0.17.0 (2023-07-28)

新增功能

• 添加操作组 RunNotebookOperations
• 模型活动新增参数 on_inactive_mark_as
• 模型活动新增参数 state
• 模型 AmazonRdsForSqlServerLinkedService 新增参数 always_encrypted_settings
• 模型 AmazonRdsForSqlServerSource 新增参数 isolation_level
• 模型 AppendVariableActivity 新增参数 on_inactive_mark_as
• 模型 AppendVariableActivity 新增参数 state
• 模型 AzureBatchLinkedService 新增参数 credential
• 模型 AzureBlobFSLinkedService 新增参数 credential
• 模型 AzureBlobStorageLinkedService 新增参数 credential
• 模型 AzureDataExplorerCommandActivity 新增参数 on_inactive_mark_as
• 模型 AzureDataExplorerCommandActivity 新增参数 state
• 模型 AzureDataExplorerLinkedService 新增参数 credential
• 模型 AzureDataLakeStoreLinkedService 新增参数 credential
• 模型 AzureDatabricksDeltaLakeLinkedService 新增参数 credential
• 模型 AzureDatabricksLinkedService 新增参数 credential
• 模型 AzureFunctionActivity 新增参数 on_inactive_mark_as
• 模型 AzureFunctionActivity 新增参数 state
• 模型 AzureFunctionLinkedService 新增参数 authentication
• 模型 AzureFunctionLinkedService 新增参数 credential
• 模型 AzureFunctionLinkedService 新增参数 resource_id
• 模型 AzureKeyVaultLinkedService 新增参数 credential
• 模型 AzureMLBatchExecutionActivity 新增参数 on_inactive_mark_as
• 模型 AzureMLBatchExecutionActivity 新增参数 state
• 模型 AzureMLExecutePipelineActivity 新增参数 on_inactive_mark_as
• 模型 AzureMLExecutePipelineActivity 新增参数 state
• 模型 AzureMLLinkedService 新增参数 authentication
• 模型 AzureMLServiceLinkedService 新增参数 authentication
• 模型 AzureMLUpdateResourceActivity 新增参数 on_inactive_mark_as
• 模型 AzureMLUpdateResourceActivity 新增参数 state
• 模型 AzureSqlDWLinkedService 新增参数 credential
• 模型 AzureSqlDatabaseLinkedService 新增参数 always_encrypted_settings
• 模型 AzureSqlDatabaseLinkedService 新增参数 credential
• 模型 AzureSqlMILinkedService 新增参数 always_encrypted_settings
• 模型 AzureSqlMILinkedService 新增参数 credential
• 模型 AzureSqlSource 新增参数 isolation_level
• 模型 ControlActivity 新增参数 on_inactive_mark_as
• 模型 ControlActivity 新增参数 state
• 模型 CopyActivity 新增参数 on_inactive_mark_as
• 模型 CopyActivity 新增参数 state
• 模型 CosmosDbLinkedService 新增参数 credential
• 模型 CustomActivity 新增参数 on_inactive_mark_as
• 模型 CustomActivity 新增参数 state
• 模型 DataLakeAnalyticsUSQLActivity 新增参数 on_inactive_mark_as
• 模型 DataLakeAnalyticsUSQLActivity 新增参数 state
• 模型 DatabricksNotebookActivity 新增参数 on_inactive_mark_as
• 模型 DatabricksNotebookActivity 新增参数 state
• 模型 DatabricksSparkJarActivity 新增参数 on_inactive_mark_as
• 模型 DatabricksSparkJarActivity 新增参数 state
• 模型 DatabricksSparkPythonActivity 新增参数 on_inactive_mark_as
• 模型 DatabricksSparkPythonActivity 新增参数 state
• 模型 DeleteActivity 新增参数 on_inactive_mark_as
• 模型 DeleteActivity 新增参数 state
• 模型 DynamicsLinkedService 新增参数 credential
• 模型 ExecuteDataFlowActivity 新增参数 on_inactive_mark_as
• 模型 ExecuteDataFlowActivity 新增参数 state
• 模型 ExecutePipelineActivity 新增参数 on_inactive_mark_as
• 模型 ExecutePipelineActivity 新增参数 state
• 模型 ExecuteSSISPackageActivity 新增参数 on_inactive_mark_as
• 模型 ExecuteSSISPackageActivity 新增参数 state
• 模型 ExecutionActivity 新增参数 on_inactive_mark_as
• 模型 ExecutionActivity 新增参数 state
• 模型 FailActivity 新增参数 on_inactive_mark_as
• 模型 FailActivity 新增参数 state
• 模型 FilterActivity 新增参数 on_inactive_mark_as
• 模型 FilterActivity 新增参数 state
• 模型 ForEachActivity 新增参数 on_inactive_mark_as
• 模型 ForEachActivity 新增参数 state
• 模型 GetMetadataActivity 新增参数 on_inactive_mark_as
• 模型 GetMetadataActivity 新增参数 state
• 模型 HDInsightHiveActivity 新增参数 on_inactive_mark_as
• 模型 HDInsightHiveActivity 新增参数 state
• 模型 HDInsightMapReduceActivity 新增参数 on_inactive_mark_as
• 模型 HDInsightMapReduceActivity 新增参数 state
• 模型 HDInsightOnDemandLinkedService 新增参数 credential
• 模型 HDInsightPigActivity 新增参数 on_inactive_mark_as
• 模型 HDInsightPigActivity 新增参数 state
• 模型 HDInsightSparkActivity 新增参数 on_inactive_mark_as
• 模型 HDInsightSparkActivity 新增参数 state
• 模型 HDInsightStreamingActivity 新增参数 on_inactive_mark_as
• 模型 HDInsightStreamingActivity 新增参数 state
• 模型 IfConditionActivity 新增参数 on_inactive_mark_as
• 模型 IfConditionActivity 新增参数 state
• 模型 LinkConnectionTargetDatabaseTypeProperties 新增参数 action_on_existing_target_table
• 模型 LookupActivity 新增参数 on_inactive_mark_as
• 模型 LookupActivity 新增参数 state
• 模型 MongoDbAtlasLinkedService 新增参数 driver_version
• 模型 RestServiceLinkedService 新增参数 credential
• 模型 ScriptActivity 新增参数 on_inactive_mark_as
• 模型 ScriptActivity 新增参数 state
• 模型 SetVariableActivity 新增参数 on_inactive_mark_as
• 模型 SetVariableActivity 新增参数 policy
• 模型 SetVariableActivity 新增参数 state
• 模型 SqlDWSource 新增参数 isolation_level
• 模型 SqlMISource 新增参数 isolation_level
• 模型 SqlPoolStoredProcedureActivity 新增参数 on_inactive_mark_as
• 模型 SqlPoolStoredProcedureActivity 新增参数 state
• 模型 SqlServerLinkedService 新增参数 always_encrypted_settings
• 模型 SqlServerSource 新增参数 isolation_level
• 模型 SqlServerStoredProcedureActivity 新增参数 on_inactive_mark_as
• 模型 SqlServerStoredProcedureActivity 新增参数 state
• 模型 SwitchActivity 新增参数 on_inactive_mark_as
• 模型 SwitchActivity 新增参数 state
• 模型 SynapseNotebookActivity 新增参数 configuration_type
• 模型 SynapseNotebookActivity 新增参数 on_inactive_mark_as
• 模型 SynapseNotebookActivity 新增参数 spark_config
• 模型 SynapseNotebookActivity 新增参数 state
• 模型 SynapseNotebookActivity 新增参数 target_spark_configuration
• 模型 SynapseSparkJobDefinitionActivity 新增参数 on_inactive_mark_as
• 模型 SynapseSparkJobDefinitionActivity 新增参数 state
• 模型 UntilActivity 新增参数 on_inactive_mark_as
• 模型 UntilActivity 新增参数 state
• 模型 ValidationActivity 新增参数 on_inactive_mark_as
• 模型 ValidationActivity 新增参数 state
• 模型 WaitActivity 新增参数 on_inactive_mark_as
• 模型 WaitActivity 新增参数 state
• 模型 WebActivity 新增参数 on_inactive_mark_as
• 模型 WebActivity 新增参数 state
• 模型 WebActivityAuthentication 新增参数 credential
• 模型 WebActivityAuthentication 新增参数 user_tenant
• 模型 WebHookActivity 新增参数 on_inactive_mark_as
• 模型 WebHookActivity 新增参数 state

0.16.0 (2023-05-12)

已修复的错误

• 修复支持 IO 输入 #29615

0.15.0 (2023-01-09)

新增功能

• 模型 AzureSynapseArtifactsLinkedService 新增参数 workspace_resource_id
• 模型 RestServiceLinkedService 新增参数 auth_headers
• 模型 SynapseSparkJobDefinitionActivity 新增参数 configuration_type
• 模型 SynapseSparkJobDefinitionActivity 新增参数 files_v2
• 模型 SynapseSparkJobDefinitionActivity 新增参数 python_code_reference
• 模型 SynapseSparkJobDefinitionActivity 新增参数 scan_folder
• 模型 SynapseSparkJobDefinitionActivity 新增参数 spark_config
• 模型 SynapseSparkJobDefinitionActivity 新增参数 target_spark_configuration

重大变更

• 模型 SnowflakeSource 的参数 export_settings 现在是必需的
• 将操作 LinkConnectionOperations.create_or_update_link_connection 重命名为 LinkConnectionOperations.create_or_update
• 将操作 LinkConnectionOperations.delete_link_connection 重命名为 LinkConnectionOperations.delete
• 将操作 LinkConnectionOperations.get_link_connection 重命名为 LinkConnectionOperations.get
• 将操作 LinkConnectionOperations.list_link_connections_by_workspace 重命名为 LinkConnectionOperations.list_by_workspace

0.14.0 (2022-09-19)

新增功能

• 某些操作组的 api-version 已升级

其他变更

• 停止支持 python3.6

0.13.0 (2022-04-21)

功能

• 添加了操作组 LinkConnectionOperations

0.12.0 (2022-03-07)

新增功能

• 根据 tag package-artifacts-composite-v3 重新生成

0.11.0 (2022-01-11)

新增功能

• 添加 MetastoreOperations

其他变更

• Python 2.7 和 3.6 不再受支持。请使用 Python 版本 3.7 或更高版本。

0.10.0 (2021-11-09)

其他变更

• 内部错误修复（使用最新生成器重新生成）

0.9.0 (2021-10-05)

新增功能

• 根据 tag package-artifacts-composite-v1 重新生成

0.8.0 (2021-08-10)

• 已更新 API 版本为 "2020-12-01"，这是默认 API 版本
• 添加了 NotebookOperationResultOperations、OperationResultOperations、OperationStatusOperations
• 添加了对 API 版本 "2021-06-01-preview" 的支持

0.7.0 (2021-05-11)

错误修复

• 在启动长时间运行的操作时启用轮询器 #18184

0.6.0 (2021-04-06)

新功能

• 添加 ADF 支持

0.5.0 (2021-03-09)

新功能

• 添加库操作
• 将 create_or_update_sql_script、delete_sql_script、rename_sql_script 改为长时间运行的操作

破坏性变更

• 停止支持 Python 3.5

0.4.0 (2020-12-08)

新功能

• 添加工作区 Git 仓库管理操作
• 为数据流、数据集、链接服务、笔记本、管道、Spark 作业定义、SQL 脚本操作添加重命名方法

0.3.0 (2020-09-15)

新功能

• 添加工作区操作
• 添加 SqlPools 操作
• 添加 BigDataPools 操作
• 添加 IntegrationRuntimes 操作

破坏性变更

• 将大多数长时间运行操作迁移到轮询机制（操作现在以 begin 开始）

0.2.0 (2020-07-01)

• 初始发布