Skip to content

microsoft/PowerPlatform-DataverseServiceClient

Repository files navigation

NOTICE Project renamed to Microsoft.PowerPlatform.Dataverse.Client.*

Please see project rename for more information

Change Log

Current release notes and change log:

Microsoft.PowerPlatform.Dataverse.Client

Microsoft.PowerPlatform.Dataverse.Client.Dynamics

This nuget package has been deprecated (for now) Microsoft.Dynamics.Sdk.Messages

Overview

This repository contains the code for the Microsoft.PowerPlatform.Dataverse.Client and its supporting assemblies and classes.

IMPORTANT NOTES

The Dataverse ServiceClient cannot be built outside of Microsoft This is due to a set of dependencies on nuget packages that are internally available only. At some point in the future, we will expose the supporting nuget packages when we have updated our server infrastructure to support plugin development on .net core.

This encompasses the contents of the following nuget packages:

Microsoft.PowerPlatform.Dataverse.Client

Microsoft.PowerPlatform.Dataverse.Client.Dynamics

This nuget package has been deprecated (for now) Microsoft.Dynamics.Sdk.Messages

This library is and its supporting assemblies are a revision and update of the Microsoft.Xrm.Tooling.Connector.CrmServiceClient and the underlying Microsoft.Xrm.Sdk.Client libraries.

We encourage you to read the release notes we provide with each nuget packages. As with most of our Nuget packages that are intended as tools or for developer consumption, we extensively comment in release notes.

At this time: (06/13/2022) The Client SDK libs supports the following and has the following notices:

  • VS 2022 + .net 6 is required to build this project currently. see: global.json for current requirements.
  • .net full framework 4.6.2, 4.7.2, 4.8 and .net core 3.0, 3.1, 5.0, 6.0
  • We now support all authentication types from CrmServiceClient for .net framework, ( Client\Secret, Client\Cert, UID\PW Noninteractive, UID\PW interactive.)
  • We support the following authentication types from CrmServiceClient for .net core: Client\Secret, Client\Cert, UID\PW interactive.
  • Plugin Development using this Client is NOT supported at this time.

From a scenario point of view, we are particularity interested in any issues or challenges when using these library in either Asp.net Core, Azure Functions, and Linux based scenarios.

Note: We provide support for these nuget packages primarily via GitHub and Microsoft Support.
Github Issues is the preferred venue at this time as the development team is actively working on this library. A number of our dev's and PM's do monitor this channel and can respond to questions and feedback.

While we are monitoring the community forums, you are encouraged to open issue here

Samples / Docs

If you are transitioning from Microsoft.XrmTooling.CrmServiceClient to Microsoft.PowerPlatform.Dataverse.Client.ServiceClient Please start here: Transition apps to Dataverse ServiceClient.

Samples and such will be continually updated overtime on the PowerApps Samples GitHub Site. Dataverse ServiceClient Samples can be found here: Samples

For connections strings, docs on supported patterns are here: Connection String Docs. This link will be updated as Dataverse Specific connection string documentation comes online.

Microsoft Documentation root for Dataverse ServiceClient can be found here: Dataverse ServiceClient Docs

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

License

MIT