UmamiBuilderExtensions Methods

ClassMethods2 members

Provides extension methods for adding Umami resources to the application model.

AddUmami(IDistributedApplicationBuilder, string, IResourceBuilder<ParameterResource>, int?)extensionIResourceBuilder<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)
    {
        // ...
    }
}

UmamiBuilderExtensions.cs#L52-L68

Parameters

builderIDistributedApplicationBuilderThe Hosting.IDistributedApplicationBuilder.

namestringThe name of the resource. This name will be used as the connection string name when referenced in a dependency.

secretIResourceBuilder<ParameterResource>optionalThe parameter used to provide the app secret for the Umami resource.

portint?optionalThe host port for the Umami app.

Returns

IResourceBuilder<UmamiResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

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>)extensionIResourceBuilder<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)
    {
        // ...
    }
}

UmamiBuilderExtensions.cs#L84-L110

Parameters

builderIResourceBuilder<UmamiResource>The Umami resource builder.

databaseIResourceBuilder<PostgresDatabaseResource>The PostgreSQL database resource builder.

Returns

IResourceBuilder<UmamiResource>A reference to the ApplicationModel.IResourceBuilder`1.