使用适用于 .NET 的 SDK

sdk for .NET提供对 Dataverse 平台支持的业务数据、数据表定义(元数据)和数据操作的访问权限。

某些开发场景需要使用适用于 .NET 的 Dataverse SDK。 编写自定义代码以扩展 Dataverse 的功能(例如,创建插件和自定义工作流活动时),必须使用 .NET Framework 和 Dataverse SDK 生成代码。

获取SDK程序集

对于 .NET Framework 或基于 .NET Core 的应用程序,请使用适用于 .NET 程序集的 SDK。 对于仅限 .NET Framework 的开发,请获取 Microsoft.CrmSdk.CoreAssemblies NuGet 包中的 SDK 程序集。 对于 .NET Framework 或 .NET Core 开发,可在 Microsoft.PowerPlatform.Dataverse.Client NuGet 包中获取 SDK 程序集。

将 NuGet 包添加到Visual Studio项目后,可以访问命名空间和类,使应用程序能够与组织和发现 Web 服务进行交互。

与组织服务进行交互

本部分介绍有关使用提供的 SDK 类连接到 Web 服务和执行操作的一些关键概念。

建立 Web 服务连接

IOrganizationService 接口提供与组织服务的连接,使应用程序能够处理业务数据和表和列定义。 SDK 包括此接口的两个实现: CrmServiceClientServiceClient。 对于新的应用程序开发,请使用支持较新身份验证技术 (MSAL) 的 ServiceClient 类,它还具有一些 CrmServiceClient 不具备的功能。 但是,从 API 的角度来看,这两个客户端类大多相同。 你会在本文档中看到使用这两个类中任意一个的代码示例,并且将使用 CrmServiceClient 的代码转换为使用 ServiceClient 的代码也相当容易。

详细信息: 将应用转换为 Dataverse ServiceClientIOrganizationService 接口

Web 服务操作

在用于.NET的 Dataverse SDK 中,通过向服务发送消息消息请求来启动 Web 服务操作。 每个消息都有一个名称,指示消息的用途,相应的请求类名称基于该消息名称。 例如,若要在表中创建一行数据,请使用数据填充创建请求,并使服务客户端向组织服务发送此请求(执行)。 该操作为“create”,消息请求命名 CreateRequest。 执行请求时,服务将返回一个响应类对象(例如), CreateResponse该对象包含执行状态和结果数据。 对于服务支持的其他操作,此模式是相同的。

查看可用消息请求和命名空间中的Microsoft.Xrm.Sdk.MessagesMicrosoft.Crm.Sdk.Messages响应类。

关于旧 SOAP 端点

Microsoft在 2011 年引入了组织服务终结点(称为 SOAP 终结点)。 此终结点已弃用。 这意味着它将继续工作,并得到支持,直到Microsoft将其删除。 Microsoft还宣布,他们将更新用于.NET程序集的 SDK,以便在删除终结点后继续工作。 这意味着在删除终结点之前,将为.NET程序集更新的 SDK 可用。 开发人员需要更新其代码,以便在将来的某个时间点使用这些新程序集。 关键点在于,开发人员通过使用 .NET SDK 访问组织服务,而无需关心终结点及其协议。 有关详细信息,请参阅 将应用转换为 Dataverse ServiceClient

由于 Web API 使用不同的终结点,因此不受此 2011 SOAP 终结点弃用的影响。

后续步骤

让我们编写一些代码! 快速入门:sdk for .NET 示例 (C#)

另见

发现用户组织
使用插件扩展业务流程
工作流扩展