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
<PackageReference Include="XrmEmulator.Aspire.Hosting.Dataverse" Version="1.6.0" />
<PackageVersion Include="XrmEmulator.Aspire.Hosting.Dataverse" Version="1.6.0" />
<PackageReference Include="XrmEmulator.Aspire.Hosting.Dataverse" />
paket add XrmEmulator.Aspire.Hosting.Dataverse --version 1.6.0
#r "nuget: XrmEmulator.Aspire.Hosting.Dataverse, 1.6.0"
#:package XrmEmulator.Aspire.Hosting.Dataverse@1.6.0
#addin nuget:?package=XrmEmulator.Aspire.Hosting.Dataverse&version=1.6.0
#tool nuget:?package=XrmEmulator.Aspire.Hosting.Dataverse&version=1.6.0
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 | Versions 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. |
-
net10.0
- Aspire.Hosting (>= 13.1.0)
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 |