ServiceCollectionExtensions Methods

Provides extension methods for configuring and integrating the Orleans Dashboard.

AddDashboard(IClientBuilder, Action<DashboardOptions>)

staticextension

public static IClientBuilder AddDashboard(this IClientBuilder clientBuilder, Action<DashboardOptions>? configureOptions = null)

Adds Orleans Dashboard services to an Orleans client builder. This allows you to host the Orleans Dashboard application on an Orleans client, so long as the silos also have the dashboard added.

Parameters

clientBuilderIClientBuilder: The client builder.
configureOptionsAction<DashboardOptions>: Optional configuration action for DashboardOptions.

Returns

The service collection for method chaining.

AddDashboard(ISiloBuilder, Action<DashboardOptions>)

staticextension

View source

public static ISiloBuilder AddDashboard(this ISiloBuilder siloBuilder, Action<DashboardOptions>? configureOptions = null)

Adds Orleans Dashboard services to the silo builder.

Parameters

siloBuilderISiloBuilder: The silo builder.
configureOptionsAction<DashboardOptions>: Optional configuration action for DashboardOptions.

Returns

The silo builder for method chaining.

MapOrleansDashboard(IEndpointRouteBuilder, string?)

staticextension

View source

public static RouteGroupBuilder MapOrleansDashboard(this IEndpointRouteBuilder endpoints, string? routePrefix = null)

Maps Orleans Dashboard endpoints using ASP.NET Core minimal APIs. Returns an Microsoft.AspNetCore.Builder.IEndpointConventionBuilder that can be used to apply authentication, authorization, or other endpoint configuration.

Parameters

endpointsIEndpointRouteBuilder
routePrefixstring?

Examples

             // Basic usage
             app.MapOrleansDashboard();

             // With authentication
             app.MapOrleansDashboard().RequireAuthorization();

             // With custom base path
             app.MapOrleansDashboard(routePrefix: "/dashboard");