你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

适用于 .NET 的 Azure Synapse Analytics Artifacts 客户端库 - 版本 1.0.0-preview.18

项目
08/02/2023

此目录包含 .NET SDK 的开放源代码子集。有关完整 Azure SDK 的文档，请参阅 Microsoft Azure .NET 开发人员中心。

Azure Synapse Analytics 开发客户端库支持以编程方式管理项目，并提供创建、更新、列出和删除管道、数据集、数据流、笔记本、Spark 作业定义、SQL 脚本、链接服务和触发器的方法。

Azure Synapse 是一种无限制的分析服务，它将企业数据仓库和大数据分析结合在一起。借助它可以使用无服务器的按需资源或预配资源，任意执行自己定义的大规模数据查询。 Azure Synapse 将这两个领域结合在一起，以统一的体验引入、准备、管理和提供数据，以满足即时 BI 和机器学习的需求。

入门

可以从 Microsoft Azure 下载页下载完整的 Microsoft Azure SDK，并随附对生成部署包、与工具集成、丰富的命令行工具等的支持。

为了获得最佳开发体验，开发人员应将官方的 Microsoft NuGet 包用于库。 NuGet 包会定期更新新功能和修补程序。

安装包

使用 NuGet 安装适用于 .NET 的 Azure Synapse Analytics 开发客户端库：

dotnet add package Azure.Analytics.Synapse.Artifacts --prerelease

先决条件

Azure 订阅：若要使用 Azure 服务（包括Azure Synapse），需要订阅。如果没有现有的 Azure 帐户，可以在创建帐户时注册免费试用版或使用 Visual Studio 订阅权益。
现有Azure Synapse工作区。如果需要创建Azure Synapse工作区，可以使用 Azure 门户或 Azure CLI。

如果使用 Azure CLI，则命令如下所示：

az synapse workspace create \
    --name <your-workspace-name> \
    --resource-group <your-resource-group-name> \
    --storage-account <your-storage-account-name> \
    --file-system <your-storage-file-system-name> \
    --sql-admin-login-user <your-sql-admin-user-name> \
    --sql-admin-login-password <your-sql-admin-user-password> \
    --location <your-workspace-location>

验证客户端

若要与部分 Azure Synapse Analytics 服务交互，需要创建相应客户端类的实例：

需要工作区 终结点（可能在门户中显示为“开发终结点”），客户端 密码凭据 (客户端 ID、客户端密码、租户 ID) 来实例化客户端对象。

本入门部分将使用客户端机密凭据身份验证，但你可以找到使用 Azure 标识进行身份验证的更多方法。若要使用如下所示的 DefaultAzureCredential 提供程序或 Azure SDK 提供的其他凭据提供程序，应安装 Azure.Identity 包：

dotnet add package Azure.Identity

示例

Azure.Analytics.Synapse.Artifacts 包支持同步和异步 API。以下部分介绍一些最常见的Azure Synapse Analytics 开发相关任务：

创建笔记本

CreateOrUpdateNotebook 创建笔记本。

NotebookCreateOrUpdateNotebookOperation operation = await client.StartCreateOrUpdateNotebookAsync(notebookName, notebookResource);
await operation.WaitForCompletionAsync();
Console.WriteLine("The notebook is created");

检索笔记本

GetNoteBook 检索笔记本。

NotebookResource retrievedNotebook = client.GetNotebook(notebookName);

列出笔记本

GetNotebooksByWorkspace 枚举 Synapse 工作区中的笔记本。

Pageable<NotebookResource> notebooks = client.GetNotebooksByWorkspace();
foreach (NotebookResource notebook in notebooks)
{
    Console.WriteLine(notebook.Name);
}

删除笔记本

DeleteNotebook 删除笔记本。

NotebookDeleteNotebookOperation deleteNotebookOperation = client.StartDeleteNotebook(notebookName);
await deleteNotebookOperation.WaitForCompletionResponseAsync();

生成

有关生成 Azure Synapse 客户端库的信息，请参阅生成用于 .NET 的 Microsoft Azure SDK

目标框架

有关 Azure Synapse 客户端库的目标框架的信息，请参阅用于 .NET 的 Microsoft Azure SDK的目标框架。

关键概念

NotebookControlClient

使用笔记本客户端，可以创建、更新、列出和删除管道、数据集、数据流、笔记本、Spark 作业定义、SQL 脚本、链接服务和触发器。

线程安全

我们保证所有客户端实例方法都是线程安全的，并且彼此独立 (准则) 。这可确保重用客户端实例的建议始终是安全的，即使在线程之间也是如此。

其他概念

疑难解答

请在 github 中打开问题。

后续步骤

下一步是添加更多示例

供稿

此项目采用了 Microsoft 开放源代码行为准则。有关详细信息，请参阅行为准则常见问题解答，或如果有任何其他问题或意见，请与联系。

通过