Codefix.Dataverse 2.0.0

Codefix.Dataverse

NuGet package for connecting to Microsoft Dataverse using an EF Core–style DbContext and DbSet pattern over the Dataverse Web API (OData).

Features

• ODataDbContext / ODataDbSet<T> for querying entities with LINQ-like filters, expand, select, order-by, paging
• CRUD helpers: ToListAsync, FirstOrDefaultAsync, CreateAsync, UpdateAsync, DeleteAsync
• Dependency injection via AddOdataDbContext and AddDataverse
• Azure AD app registration, client secret, or TokenCredential (e.g. DefaultAzureCredential / managed identity)
• Multi-environment factory via AddDataverseFactory and keyed IDataverseFactory
• Attributes for table names, primary keys, lookups, and read-only fields

Installation

dotnet add package Codefix.Dataverse

Requires .NET 10 and a Dataverse environment URL (e.g. https://yourorg.crm4.dynamics.com).

Quick start

1. Define entities

Map each Dataverse table to a class and decorate it with [ODataTable("logical_name")]. Use [JsonProperty] (Newtonsoft) for column logical names.

using Codefix.Dataverse.Attributes;
using Newtonsoft.Json;

[ODataTable("account")]
public class Account
{
    [OdataPrimaryKey]
    [JsonProperty("accountid")]
    public Guid? AccountId { get; set; }

    [JsonProperty("name")]
    public string? Name { get; set; }
}

Optional: inherit DataverseRecord for standard audit columns (createdon, modifiedon, etc.).

2. Define a DbContext

using Codefix.Dataverse.Core;

public class CrmDb : ODataDbContext
{
    public ODataDbSet<Account> Accounts { get; set; } = null!;
}

3. Register in DI (ASP.NET Core)

Client secret

using Codefix.Dataverse.Bootstrappers;

builder.Services.AddOdataDbContext<CrmDb>(options =>
{
    options.BaseUrl = "https://yourorg.crm4.dynamics.com";
    options.TenantId = "<tenant-id>";
    options.ClientId = "<app-id>";
    options.ClientSecret = "<secret>";
});

Managed identity / Azure credential

using Azure.Identity;
using Codefix.Dataverse.Bootstrappers;

builder.Services.AddOdataDbContext<CrmDb>(options =>
{
    options.BaseUrl = "https://yourorg.crm4.dynamics.com";
    options.Credentials = new DefaultAzureCredential();
});

4. Query and mutate

public class AccountService(CrmDb db)
{
    public async Task<IList<Account>> GetActiveAccountsAsync() =>
        await db.Accounts
            .Where(a => a.Name != null)
            .Top(50)
            .ToListAsync();

    public async Task<Account?> GetByIdAsync(Guid id) =>
        await db.Accounts.FirstOrDefaultAsync(id);

    public async Task<Account> CreateAsync(Account account) =>
        await db.Accounts.CreateAsync(account);
}

Inject CrmDb (registered as transient per request scope in the sample above).

Low-level Web API access

Register only IDataverseService when you do not need ODataDbContext:

builder.Services.AddDataverse(options =>
{
    options.BaseUrl = "https://yourorg.crm4.dynamics.com";
    options.Credential = new DefaultAzureCredential();
    options.Lifetime = ServiceLifetime.Scoped;
});

Use GetEntityInDataverse, PostEntityInDataverse, PatchEntityInDataverse, PutEntityInDataverse, and DeleteEntityInDataverse on IDataverseService.

Multiple environments

builder.Services.AddDataverseFactory(options =>
{
    options.AddDataVerseConfig("Production", "https://prod.crm.dynamics.com", tenantId, clientId, secret);
    options.AddDataVerseConfig("Test", "https://test.crm.dynamics.com", tenantId, clientId, secret);
});

// Resolve by key
var prod = factory.CreateService("Production");

Attributes

Sandbox

The Sandbox project in this repository is a minimal ASP.NET Core app demonstrating AddOdataDbContext and ToListAsync. Replace the sample environment URL and credentials before running.

dotnet run --project Sandbox

Publish to NuGet.org

1. Create an API key at nuget.org (scope: Codefix.Dataverse).
2. Pack and push from the repo root:

dotnet pack Codefix.Dataverse/Codefix.Dataverse.csproj -c Release
dotnet nuget push Codefix.Dataverse/bin/Release/Codefix.Dataverse.*.nupkg --api-key <YOUR_API_KEY> --source https://api.nuget.org/v3/index.json

3. In consuming repos:

dotnet add package Codefix.Dataverse

Versioning

• 1.x – .NET 6 / 8 (legacy, last NuGet: 1.2.6)
• 2.0.0 – .NET 10 (current)

See GitHub releases for changelog details.

License

MIT – see LICENSE.