Microsoft.PowerPlatform.Dataverse.Client
1.2.26
Prefix Reserved
dotnet add package Microsoft.PowerPlatform.Dataverse.Client --version 1.2.26
NuGet\Install-Package Microsoft.PowerPlatform.Dataverse.Client -Version 1.2.26
<PackageReference Include="Microsoft.PowerPlatform.Dataverse.Client" Version="1.2.26" />
<PackageVersion Include="Microsoft.PowerPlatform.Dataverse.Client" Version="1.2.26" />
<PackageReference Include="Microsoft.PowerPlatform.Dataverse.Client" />
paket add Microsoft.PowerPlatform.Dataverse.Client --version 1.2.26
#r "nuget: Microsoft.PowerPlatform.Dataverse.Client, 1.2.26"
#:package Microsoft.PowerPlatform.Dataverse.Client@1.2.26
#addin nuget:?package=Microsoft.PowerPlatform.Dataverse.Client&version=1.2.26
#tool nuget:?package=Microsoft.PowerPlatform.Dataverse.Client&version=1.2.26
This package contains the .net core Dataverse ServiceClient. Used to connect to Microsoft Dataverse. This Package has been authored by the Microsoft Dataverse SDK team.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Framework | net462 is compatible. net463 was computed. net47 was computed. net471 was computed. net472 is compatible. net48 is compatible. net481 was computed. |
-
.NETFramework 4.6.2
- Microsoft.Extensions.Caching.Memory (>= 3.1.9)
- Microsoft.Extensions.DependencyInjection (>= 3.1.9)
- Microsoft.Extensions.Http (>= 3.1.9)
- Microsoft.Extensions.Logging (>= 3.1.9)
- Microsoft.Identity.Client (>= 4.84.2)
- Microsoft.Identity.Client.Extensions.Msal (>= 4.84.2)
- Newtonsoft.Json (>= 13.0.1)
- System.ServiceModel.Http (>= 4.10.3)
- System.ServiceModel.Primitives (>= 4.10.3)
- System.Text.Json (>= 8.0.5)
-
.NETFramework 4.7.2
- Microsoft.Extensions.Caching.Memory (>= 3.1.9)
- Microsoft.Extensions.DependencyInjection (>= 3.1.9)
- Microsoft.Extensions.Http (>= 3.1.9)
- Microsoft.Extensions.Logging (>= 3.1.9)
- Microsoft.Identity.Client (>= 4.84.2)
- Microsoft.Identity.Client.Extensions.Msal (>= 4.84.2)
- Newtonsoft.Json (>= 13.0.1)
- System.ServiceModel.Http (>= 4.10.3)
- System.ServiceModel.Primitives (>= 4.10.3)
- System.Text.Json (>= 8.0.5)
-
.NETFramework 4.8
- Microsoft.Extensions.Caching.Memory (>= 3.1.9)
- Microsoft.Extensions.DependencyInjection (>= 3.1.9)
- Microsoft.Extensions.Http (>= 3.1.9)
- Microsoft.Extensions.Logging (>= 3.1.9)
- Microsoft.Identity.Client (>= 4.84.2)
- Microsoft.Identity.Client.Extensions.Msal (>= 4.84.2)
- Newtonsoft.Json (>= 13.0.1)
- System.ServiceModel.Http (>= 4.10.3)
- System.ServiceModel.Primitives (>= 4.10.3)
- System.Text.Json (>= 8.0.5)
-
net8.0
- Microsoft.Extensions.Caching.Memory (>= 3.1.9)
- Microsoft.Extensions.DependencyInjection (>= 3.1.9)
- Microsoft.Extensions.Http (>= 3.1.9)
- Microsoft.Extensions.Logging (>= 3.1.9)
- Microsoft.Identity.Client (>= 4.84.2)
- Microsoft.Identity.Client.Extensions.Msal (>= 4.84.2)
- Microsoft.VisualBasic (>= 10.3.0)
- Newtonsoft.Json (>= 13.0.1)
- System.Collections (>= 4.3.0)
- System.Configuration.ConfigurationManager (>= 6.0.0)
- System.Globalization (>= 4.3.0)
- System.Linq (>= 4.3.0)
- System.Linq.Expressions (>= 4.3.0)
- System.Private.DataContractSerialization (>= 4.3.0)
- System.Reflection (>= 4.3.0)
- System.Reflection.Extensions (>= 4.3.0)
- System.Reflection.TypeExtensions (>= 4.7.0)
- System.Runtime.Caching (>= 4.7.0)
- System.Runtime.Serialization.Primitives (>= 4.3.0)
- System.Runtime.Serialization.Xml (>= 4.3.0)
- System.Security.Permissions (>= 6.0.0)
- System.ServiceModel.Http (>= 8.1.2)
- System.ServiceModel.Primitives (>= 8.1.2)
- System.Text.Json (>= 8.0.5)
NuGet packages (152)
Showing the top 5 NuGet packages that depend on Microsoft.PowerPlatform.Dataverse.Client:
| Package | Downloads |
|---|---|
|
Microsoft.PowerPlatform.Dataverse.Client.Dynamics
This package contains a set of Dynamics 365 specific extensions, used with the Dataverse ServiceClient. This Package has been authored by the Microsoft Dataverse SDK team. |
|
|
Rystem.RepositoryFramework.Infrastructure.Dynamics.Dataverse
Rystem.RepositoryFramework allows you to use correctly concepts like repository pattern, CQRS and DDD. You have interfaces for your domains, auto-generated api, auto-generated HttpClient to simplify connection "api to front-end", a functionality for auto-population in memory of your models, a functionality to simulate exceptions and waiting time from external sources to improve your implementation/business test and load test. |
|
|
FakeXrmEasy.Abstractions.v9
FakeXrmEasy is the open source test automation framework for .net core and the Power Platform / Dataverse. This is an abstractions package containing only interfaces. |
|
|
FakeXrmEasy.Core.v9
FakeXrmEasy is the open source test automation framework for .net core and the Power Platform. This is the core package containing a configurable middleware, crud operators, and query translation between FetchXml, QueryExpression, CRM LINQ, and QueryByAttribute. |
|
|
FakeXrmEasy.Messages.v9
This package contains implemented default fake messages. |
GitHub repositories (6)
Showing the top 6 popular GitHub repositories that depend on Microsoft.PowerPlatform.Dataverse.Client:
| Repository | Stars |
|---|---|
|
ErikEJ/EFCorePowerTools
Entity Framework Core Power Tools - reverse engineering, migrations and model visualization in Visual Studio & CLI
|
|
|
microsoft/PowerApps-Samples
Sample code for Power Apps, including Dataverse, model-driven apps, canvas apps, Power Apps component framework, portals, and AI Builder.
|
|
|
drasi-project/drasi-platform
The Data Change Processing platform
|
|
|
Avanade/Liquid-Application-Framework
Liquid Application Framework documentation, useful links and sample project
|
|
|
microsoft/PowerApps-TestEngine
|
|
|
neronotte/Greg.Xrm.Command
Command Line utility for Dataverse
|
| Version | Downloads | Last Updated |
|---|---|---|
| 1.2.26 | 89,574 | 7/2/2026 |
| 1.2.10 | 2,413,840 | 8/13/2025 |
| 1.2.9 | 418,871 | 6/11/2025 |
| 1.2.7 | 992,038 | 5/7/2025 |
| 1.2.6 | 23,547 | 5/2/2025 |
| 1.2.5 | 524,399 | 4/4/2025 |
| 1.2.3 | 1,367,033 | 2/6/2025 |
| 1.2.2 | 1,364,466 | 11/7/2024 |
| 1.1.32 | 1,191,519 | 8/10/2024 |
| 1.1.27 | 313,696 | 7/10/2024 |
| 1.1.22 | 588,476 | 4/25/2024 |
| 1.1.17 | 681,400 | 1/8/2024 |
| 1.1.16 | 529,975 | 11/8/2023 |
| 1.1.14 | 556,944 | 8/24/2023 |
| 1.1.12 | 248,457 | 7/14/2023 |
| 1.1.9 | 395,306 | 6/8/2023 |
| 1.0.39 | 1,009,900 | 3/13/2023 |
Notice:
This package is intended to work with .net full framework 4.6.2, 4.7.2 and 4.8, and 6.0
General Documentation can be found here:
https://docs.microsoft.com/en-us/dotnet/api/microsoft.powerplatform.dataverse.client?view=dataverse-sdk-latest
Connection String Docs can be found here:
https://docs.microsoft.com/en-us/powerapps/developer/common-data-service/xrm-tooling/use-connection-strings-xrm-tooling-connect
Note: Only AD on FullFramework, OAuth, Certificate, ClientSecret Authentication types are supported at this time.
1.2.26:
Dependency changes:
Microsoft.Identity.Client updated to 4.84.2
1.2.10:
Add Support SolutionComponetOptions during import to support auto sharing of Cavas, PowerAutomate, and Copilot Agents during import
Updated additional retry flags for some dataverse operations. GIT: https://github.com/microsoft/PowerPlatform-DataverseServiceClient/issues/490
Speculative fix for Object Not found errors when errors occur when communicating with dataverse.
1.2.9:
Add a new configuration option UseExponentialRetryDelayForConcurrencyThrottle to use exponential retry delay for concurrency throttling, instead of the server-specified Retry-After header where applicable. Default is False.
1.2.7:
Fix for CancellationToken not canceling retries during delays Git: https://github.com/microsoft/PowerPlatform-DataverseServiceClient/issues/508
1.2.5:
Fix for Null ILogger passed to the AzAuth Client Creators causing a fault. Git: https://github.com/microsoft/PowerPlatform-DataverseServiceClient/issues/481
Fix for Memory Leak in Retrieve Multiple. Git: https://github.com/microsoft/PowerPlatform-DataverseServiceClient/issues/463
Fix for Memory bloat issue caused by not releasing lastErrorMessage property.
Updated Error messages verbosity when checking for authority from Dataverse during onboard auth phase.
Dependency changes:
System.ServiceModel.Http updated to 8.1.2
REMOVED .net 6.0 Targets. .net 6.0 is no longer in support.
1.2.3:
RequestId on OrganizationRequest is not overridden by random Guid if present. RequestId from ClientRequestBuilder still takes precedence over OrganizationRequest.RequestId
Dependency changes:
Microsoft.Identity.Client updated to 4.66.1
System.Text.Json updated to 8.0.5
Azure.Identity updated to 1.31.1
1.2.2:
***** POSSIBLE Breaking Changes *****
Minor Release Bump,
Added .net 8.0 Target.
.net 6.0 Target will be removed in a subsequent release.
Removed dependence on Microsoft.Rest.Client. this was primary used for exception handling, and the necessary components have been reworked in to DVSC Exception management classes.
Fix memory consumption when too many exception are throw by DV client. Git: https://github.com/microsoft/PowerPlatform-DataverseServiceClient/issues/474
Dependency Changes:
Modified:
System.Text.Json to 8.0.4
Removed:
Microsoft.Rest.Client - Necessary carried over in client.
1.1.32:
Fix for endless retry loop issue in WebAPI calls when specific error states are encountered.
Fix for Logging MSAL telemetry when using ILogger
Previously, Logs for MSAL were not written to the configured ILogger, they would only go to Trace Source and InMemory Logs.
Fix for RequestBuilder to properly honor CrmUserId and AADOid in request builder requests.
Fix for ForceServerMetadataCacheConsistency not being effective until an operation to retrieve current organization version has been executed.
If this us set to a value before any organization detail related information is retrieved, it will now cause the organization info to be retrieved from Dataverse. This is done only once.
Updated ServiceClient retry logic to use the server specified RetryAfter for Time and Concurrency throttling fault codes, in addition to Burst.
Updated ConnectionService retry logic to parse RetryAfter header as seconds instead of hours.
Dependency Changes:
Modified:
Microsoft.Identity.Client to 4.61.3
1.1.22:
Fix for Retry hang introduced in 1.1.21:
Dependency Changes:
Added:
System.ServiceModel.Http 4.10.3
System.ServiceModel.Primitives 4.10.3
1.1.21:
Updated Core SDK to 9.2.24044.9795
Added new ServiceClient method for creating requests called "RequestBuilder" - will allow you to create a request and customized header, user, and other properties as part of there request generation.
Dependency Changes:
Removed
System.Security.Cryptography.Algorithms
System.Security.Cryptography.ProtectedData
System.Drawing.Common
Modified
System.Configuration.ConfigurationManager to 6.0.0
1.1.17:
Fix for Request ID not reflecting correctly for some requests.
Fix for RequestAdditionalHeadersAsync interface not being forwarded to Cloned copies of DVSC. GitHub Reported - Fix #419
Fix for Clone being called concurrently causing unnecessary calls to dataverse. GitHub reported - Fix #422
Fix for invalid filenames and paths being created for token cache path when using user interactive mode. Git Hub reported - Fix #406
RENAME (Possible breaking change) MaxBufferPoolSizeOveride parameter name spelling issue, corrected to MaxBufferPoolSizeOverride
1.1.16:
Updated Core SDK
Added new properties to Organization detail to report Schema Type and Deployment Type.
Fixed bug in creating file to user token cache when host name contains invalid characters. Fixes #406
Dependency changes:
System.Text.Json moved to 7.0.3
Microsoft.Identity.Client moved to 4.56.0
Microsoft.Identity.Client.Extensions.Msal moved to 4.56.0
Removed System.Security.Cryptography.Xml was transitive include to support CVE which is no longer necessary due to depending package updates
Removed System.Security.Cryptography.Pkcs was transitive include to support CVE which is no longer necessary due to depending package updates
1.1.14:
Updated Core SDK Libs
Fixed issue with DataCenter ID not populating in Organization Detail object returned by the client.
Fixed a hang problem when parsing multi layered exceptions
1.1.12:
Refactored CurrentAccessToken property to avoid async call.
Fix for min version of default client, pre-connection so it is recognized by features that require 9.0 or greater.
Fix for notification of unsupported features when not 'breaking' to alert as 'warnings' in log vs information.
Dependency changes:
Microsoft.Rest.Client moved to 2.3.24 due to CVE-2022-26907.
1.1.9:
REMOVED .net 3.1 and .net 5 support as they are out of support frameworks.
Added new DiscoverOnlineOrganizationsAsync which supports CancellationToken
Added new RetrieveSolutionImportResultAsync for retrieving solution import result from Dataverse
Added StageSolution API to Deployment Extensions.
Added Support for "StageSolution" as source for import solution. to use it, you must first stage the solution, then call importsolution passing the staged solution id.
Added GetAsyncOperationStatus API to Deployment Extensions. This provides a simple way to get the status of an async operation.
Added async version of ExecuteWebRequest. Git: https://github.com/microsoft/PowerPlatform-DataverseServiceClient/issues/354
Updated telemetry behavior to remove some unnecessary log noise when cloning connections.
Updated auth flow to reduce access token acquire frequency. Git: https://github.com/microsoft/PowerPlatform-DataverseServiceClient/issues/377
Updated min version of DV required for SessionID Support.
Updated Async via sync calls to support more current patterns. Git: https://github.com/microsoft/PowerPlatform-DataverseServiceClient/issues/372
Fix for cleaning up Last Error reported by Git: https://github.com/microsoft/PowerPlatform-DataverseServiceClient/issues/359
Fix for Object Null exception that occurs when using .Clone under request load in a multi threaded use case. Git issue: https://github.com/microsoft/PowerPlatform-DataverseServiceClient/issues/362
Dependency changes:
System.ServiceModel.Security moved to 4.10.2 due min dependency (transient dependency is vulnerable to CVE-2022-34716).
System.ServiceModel.Http moved to 4.10.2 due min dependency (transient dependency is vulnerable to CVE-2022-34716).
1.0.39:
Added .net 6.0 Target for the Client.
Added implementation for CreateAndReturnAsync variations.
Updated Default Login flow to use WebAPI to allow for detecting Admin Mode on server during login.
A Environment in Admin mode will now throw DataverseConnectionException an error with the text "One or more errors occurred. (User does not have required privileges (or role membership) to access the org when it is in Admin Only mode.)"
Updated Improved error reporting of standard HTTP status codes
Updated ServiceClient Bootstrap to improve startup time.
Fix (Speculative) for Memory Leak in Retrieve Multiple
Fix for issue with cross thread calls and dispose were External authentication is used.
Fix for inappropriate retry operations. Unauthorized errors are no longer retried during WebAPI calls
Fix to enabled GZip Compression for WebAPI requests.
Dependency changes:
System.Text.Json moved to 6.0.7 min dependency (transient dependency is vulnerable to CVE-2022-34716).
System.ServiceModel.Http moved to 4.10.0 due min dependency (transient dependency is vulnerable to CVE-2021-24112).
1.0.26:
Fix by Git user matkov accepted for crash during create when an invalid timespan is passed from a configuration file to the ServiceClient Constructor. See https://github.com/microsoft/PowerPlatform-DataverseServiceClient/issues/326 for details.
Fix by GIT user 0xced accepted for bug in Integrated user security setting, Code will now properly honor integrated security when attempting to authenticate. See https://github.com/microsoft/PowerPlatform-DataverseServiceClient/pull/324 for details.
Fixed a number of places where Async Calls did not have a .ConfigureAwait specification. Thanks to user 0xced for prompting this fix.
Fixed a misleading warning message "Client ID not supplied, using SDK Sample Client ID for this connection" that would be incorrectly shown when ExternalAuthentication type was used. Fixes https://github.com/microsoft/PowerPlatform-DataverseServiceClient/issues/314, Thanks for your report!
Fixed a possible thread contention issue when managing connection context across multiple concurrent threads in the same client. Git issue: https://github.com/microsoft/PowerPlatform-DataverseServiceClient/issues/304 Thanks for your report !
Fixed a memory leak when caused by a logger not being cleaned up when a the creation of the ServiceClient fails. Git issue: https://github.com/microsoft/PowerPlatform-DataverseServiceClient/issues/322
Fixed issue where calling the IOrganizationService* interfaces after the client has been disposed would throw a NullReferenceException. Taking this action will now throw an ObjectDisposedException
Removed a set of exception catch and rethrows to preserve the full callstack to caller. Thanks to Git user 0xceed for prompting ( and sticking with getting us to ) this fix. See: https://github.com/microsoft/PowerPlatform-DataverseServiceClient/pull/248 for details.
1.0.23:
Added Async version of ExecuteOrganizationRequest to allow for requests to be made bounded with a custom logging message.
Update Default settings for "UseWebAPI" in preparation for future work.
Note: for Create or Update operations that make extensive use of related entities you may need to reconfigure UseWebAPI to "true".
1.0.9:
Fixed an issue with Custom User Agent headers incorrectly causing a format error when .net core is used. Proper User-Agent format must be used to send requests including the user agent.
Fixed an issue with an Empty OptionSetValue collection causing an ArgumentOutOfRangeException. Empty OptionSetValue collections will now be mapped to Null. Fixes https://github.com/microsoft/PowerPlatform-DataverseServiceClient/issues/292 Thanks for your report!
Fixed an issue where EntityReference based operations do not propagate RowVersion when using WebAPI protocol. Fixes https://github.com/microsoft/PowerPlatform-DataverseServiceClient/issues/296
1.0.4:
Fixed an issue with External Authentication and Connection and configuration constructor where external auth was not being respected correctly.
Fixed a bug on clone where Ilogger was not being propagated to the cloned connection correctly
Removed a call to WhoAmI during login flow as process of talking to Dataverse to verify the connection is delt with during get environment information call.
Updated Newtonsoft dependencies to 13.0.1 per https://github.com/advisories/GHSA-5crp-9r3c-p9vr
1.0.1:
Fixed a "Duplicate Key Error" issue created when manually adding some request parameters to an organization request, while also setting the appropriate property in the client
Fix formatting issue with RequestId and Session Id.
Fix exponential back off issue for WebAPI based calls when retrying based on a throttled connection.
Added implementation for Connection and Configuration constructor.
- Allows for a instance of the service client to be created and configured without initialization the client. The client can then be initialized later using the .Connect() method.
- This constructor accepts 3 parameters