Skip to content
Docs Try Aspire

UmamiBuilderExtensions Methods

Class Methods 2 members
Provides extension methods for adding Umami resources to the application model.
AddUmami(IDistributedApplicationBuilder, string, IResourceBuilder<ParameterResource>, int?) Section titled AddUmami(IDistributedApplicationBuilder, string, IResourceBuilder<ParameterResource>, int?) extension IResourceBuilder<UmamiResource>
Adds a Umami resource to the application model. A container is used for local development. The default image is and the tag is .
public static class UmamiBuilderExtensions
{
public static IResourceBuilder<UmamiResource> AddUmami(
this IDistributedApplicationBuilder builder,
string name,
IResourceBuilder<ParameterResource>? secret = null,
int? port = null)
{
// ...
}
}
builder IDistributedApplicationBuilder The Hosting.IDistributedApplicationBuilder.
name string The name of the resource. This name will be used as the connection string name when referenced in a dependency.
secret IResourceBuilder<ParameterResource> optional The parameter used to provide the app secret for the Umami resource.
port int? optional The host port for the Umami app.
IResourceBuilder<UmamiResource> A reference to the ApplicationModel.IResourceBuilder`1.
Add a Umami container to the application model and reference it in a .NET project.
var builder = DistributedApplication.CreateBuilder(args);
var db = builder.AddPostgres("postgres")
.AddDatabase("db");
var umami = builder.AddUmami("umami")
.WithPostgreSQL(db);
builder.Build().Run();
WithPostgreSQL(IResourceBuilder<UmamiResource>, IResourceBuilder<PostgresDatabaseResource>) Section titled WithPostgreSQL(IResourceBuilder<UmamiResource>, IResourceBuilder<PostgresDatabaseResource>) extension IResourceBuilder<UmamiResource>
References a ApplicationModel.PostgresDatabaseResource as the storage backend for the UmamiResource.
public static class UmamiBuilderExtensions
{
public static IResourceBuilder<UmamiResource> WithPostgreSQL(
this IResourceBuilder<UmamiResource> builder,
IResourceBuilder<PostgresDatabaseResource> database)
{
// ...
}
}
builder IResourceBuilder<UmamiResource> The Umami resource builder.
database IResourceBuilder<PostgresDatabaseResource> The PostgreSQL database resource builder.
IResourceBuilder<UmamiResource> A reference to the ApplicationModel.IResourceBuilder`1.