DistributedApplication.ResourceNotifications Property

Definition

Namespace:

Aspire.Hosting

Assembly:

Aspire.Hosting.dll

Package:

Aspire.Hosting v9.1.0

Source:

DistributedApplication.cs

Gets the service for monitoring and responding to resource state changes in the distributed application.

C#

public Aspire.Hosting.ApplicationModel.ResourceNotificationService ResourceNotifications { get; }

Property Value

ResourceNotificationService

Examples

Wait for resource readiness:

await app.ResourceNotifications.WaitForResourceHealthyAsync("postgres");

Monitor state changes:

await foreach (var update in app.ResourceNotifications.WatchAsync(cancellationToken))
{
    Console.WriteLine($"Resource {update.Resource.Name} state: {update.Snapshot.State?.Text}");
}

Wait for a specific state:

await app.ResourceNotifications.WaitForResourceAsync("worker", KnownResourceStates.Running);

Seed a database once it becomes available:

// Wait for the database to be healthy before seeding
await app.ResourceNotifications.WaitForResourceHealthyAsync("postgres");
using var scope = app.Services.CreateScope();
var dbContext = scope.ServiceProvider.GetRequiredService<ApplicationDbContext>();
await dbContext.Database.EnsureCreatedAsync();
if (!dbContext.Products.Any())
{
    await dbContext.Products.AddRangeAsync(
    [
        new Product { Name = "Product 1", Price = 10.99m },
        new Product { Name = "Product 2", Price = 20.99m }
    ]);
    await dbContext.SaveChangesAsync();
}

Remarks

Two common use cases for the ResourceNotificationService are:

Applies to