AzureEventGridSimulator.Aspire.Hosting
6.1.0
dotnet add package AzureEventGridSimulator.Aspire.Hosting --version 6.1.0
NuGet\Install-Package AzureEventGridSimulator.Aspire.Hosting -Version 6.1.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="AzureEventGridSimulator.Aspire.Hosting" Version="6.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="AzureEventGridSimulator.Aspire.Hosting" Version="6.1.0" />
<PackageReference Include="AzureEventGridSimulator.Aspire.Hosting" />
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 AzureEventGridSimulator.Aspire.Hosting --version 6.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: AzureEventGridSimulator.Aspire.Hosting, 6.1.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 AzureEventGridSimulator.Aspire.Hosting@6.1.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=AzureEventGridSimulator.Aspire.Hosting&version=6.1.0
#tool nuget:?package=AzureEventGridSimulator.Aspire.Hosting&version=6.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
AzureEventGridSimulator.Aspire.Hosting
Runs the Azure Event Grid Simulator as a container from an Aspire AppHost, with topics and subscribers declared in code.
Requirements
- A container runtime, such as Docker Desktop or Podman. The simulator runs from the
pmcilreavy/azureeventgridsimulatorimage. - A trusted developer certificate:
dotnet dev-certs https --trust. Aspire hands it to the container, so there's no certificate file to export or mount.
Usage
var key = builder.AddParameter("orders-key", secret: true);
var storage = builder.AddAzureStorage("storage").RunAsEmulator();
var queues = storage.AddQueues("queues");
var api = builder.AddProject<Projects.Api>("api");
var orders = builder
.AddAzureEventGridSimulator("eventgrid")
.AddTopic("orders", port: 60101, key: key)
.WithWebhookSubscriber("api-webhook", api, path: "/api/events")
.WithStorageQueueSubscriber("orders-queue", queues, queueName: "orders");
builder.AddProject<Projects.Publisher>("publisher").WithReference(orders).WaitFor(orders);
What a referencing application gets
WithReference(orders) sets:
| Variable | Value |
|---|---|
ConnectionStrings__orders |
Endpoint=https://localhost:60101/api/events;Key=<key> |
ORDERS_URI |
https://localhost:60101/api/events |
ORDERS_KEY |
The key, when the topic has one |
A referencing container gets the simulator's address on the container network in place of localhost.
var client = new EventGridPublisherClient(
new Uri(configuration["ORDERS_URI"]!),
new AzureKeyCredential(configuration["ORDERS_KEY"]!)
);
Subscribers
| Method | Delivers to |
|---|---|
WithWebhookSubscriber |
A webhook on another AppHost resource |
WithStorageQueueSubscriber |
An Azure Storage queue |
WithServiceBusQueueSubscriber |
A Service Bus queue |
WithServiceBusTopicSubscriber |
A Service Bus topic |
WithEventHubSubscriber |
An Event Hub |
Webhook subscribers skip Event Grid's validation handshake by default, because the simulator starts validating before the target is ready. Pass disableValidation: false to keep it.
Troubleshooting
- A container publishing to a topic doesn't trust the simulator. Aspire puts the developer certificate in each container and points
SSL_CERT_DIRat it. Publishing from the host needs nothing extra, but a container client that ignores that variable has to be told, such as thecurlimages/curlimage withcurl --capath "$SSL_CERT_DIR". - A webhook or a container publisher fails certificate name validation. Aspire addresses resources across the container boundary by names ending in
.dev.internal, and your developer certificate may predate those names. Recreate it withdotnet dev-certs https --clean, thendotnet dev-certs https --trust.
Limitations
- The simulator is for local development, so it's left out of Aspire's published manifest.
- Each topic's port is used both on the host and inside the container, so it must be free on the host.
- The image's tag matches this package's version. Call
.WithImageTag(...)on the simulator to run another one. - Azurite doesn't raise blob events, so uploading a blob won't publish anything to a topic. Publish a
Microsoft.Storage.BlobCreatedevent to the topic yourself to test a handler.
| 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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- Aspire.Hosting (>= 13.6.4)
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 |
|---|---|---|
| 6.1.0 | 76 | 11/10/2026 |