XrmEmulator.Aspire.Hosting.Dataverse 1.6.0

dotnet add package XrmEmulator.Aspire.Hosting.Dataverse --version 1.6.0
                    
NuGet\Install-Package XrmEmulator.Aspire.Hosting.Dataverse -Version 1.6.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="XrmEmulator.Aspire.Hosting.Dataverse" Version="1.6.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="XrmEmulator.Aspire.Hosting.Dataverse" Version="1.6.0" />
                    
Directory.Packages.props
<PackageReference Include="XrmEmulator.Aspire.Hosting.Dataverse" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add XrmEmulator.Aspire.Hosting.Dataverse --version 1.6.0
                    
#r "nuget: XrmEmulator.Aspire.Hosting.Dataverse, 1.6.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package XrmEmulator.Aspire.Hosting.Dataverse@1.6.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=XrmEmulator.Aspire.Hosting.Dataverse&version=1.6.0
                    
Install as a Cake Addin
#tool nuget:?package=XrmEmulator.Aspire.Hosting.Dataverse&version=1.6.0
                    
Install as a Cake Tool

XrmEmulator.Aspire.Hosting.Dataverse

.NET Aspire hosting integration for XrmEmulator, a local Dataverse emulator powered by XrmMockup.

Usage

Add the package to your Aspire AppHost project:

dotnet add package XrmEmulator.Aspire.Hosting.Dataverse

Container resource

Run XrmEmulator as a container from the GitHub Container Registry:

var builder = DistributedApplication.CreateBuilder(args);

var emulator = builder.AddXrmEmulatorContainer("dataverse")
    .WithMetadataFolder("../Metadata")
    .WithSnapshotPersistence();

builder.Build().Run();

Project resource

Reference the XrmEmulator project directly in your AppHost:

var emulator = builder.AddProject<Projects.XrmEmulator>("dataverse")
    .WithSnapshotPersistence();

Extension methods

Method Description
AddXrmEmulatorContainer(name, tag) Add the emulator as a container resource
WithMetadataFolder(path) Bind mount a local metadata directory into the container
WithSnapshotPersistence(interval, dataPath) Enable save/restore of database state across restarts
WithoutSnapshotPersistence() Explicitly disable snapshots (useful for tests)
WithLicenseKey(key) Configure a license key via environment variable
WithLicenseFile(path) Configure a license key from a .lic file
DisableIPv6() Avoid slow localhost connections on Windows

Metadata

Entity metadata files are required for the emulator to function. Use the XrmEmulator.MetadataSync CLI tool to export metadata from a Dataverse environment:

dnx XrmEmulator.MetadataSync

This will interactively guide you through authenticating with your Microsoft tenant, selecting a Dataverse environment, and choosing which entities to sync. The exported metadata files can then be mounted into the emulator using WithMetadataFolder.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.6.0 105 2/9/2026