ResourceBuilderExtensions.WithIconName<T> Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Specifies the icon to use when displaying the resource in the dashboard.
public static Aspire.Hosting.ApplicationModel.IResourceBuilder<T> WithIconName<T>(this Aspire.Hosting.ApplicationModel.IResourceBuilder<T> builder, string iconName, Aspire.Hosting.ApplicationModel.IconVariant iconVariant = Aspire.Hosting.ApplicationModel.IconVariant.Filled) where T : Aspire.Hosting.ApplicationModel.IResource;static member WithIconName : Aspire.Hosting.ApplicationModel.IResourceBuilder<'T (requires 'T :> Aspire.Hosting.ApplicationModel.IResource)> * string * Aspire.Hosting.ApplicationModel.IconVariant -> Aspire.Hosting.ApplicationModel.IResourceBuilder<'T (requires 'T :> Aspire.Hosting.ApplicationModel.IResource)> (requires 'T :> Aspire.Hosting.ApplicationModel.IResource)<Extension()>
Public Function WithIconName(Of T As IResource) (builder As IResourceBuilder(Of T), iconName As String, Optional iconVariant As IconVariant = Aspire.Hosting.ApplicationModel.IconVariant.Filled) As IResourceBuilder(Of T)Type Parameters
- T
The resource type.
Parameters
- builder
- IResourceBuilder<T>
The resource builder.
- iconName
- String
The name of the FluentUI icon to use. See https://aka.ms/fluentui-system-icons for available icons.
- iconVariant
- IconVariant
The variant of the icon (Regular or Filled). Defaults to Filled.
Returns
The IResourceBuilder<T>.
Remarks
This method allows you to specify a custom FluentUI icon that will be displayed for the resource in the dashboard. If no custom icon is specified, the dashboard will use default icons based on the resource type.
Set a Redis resource to use the Database icon:
var redis = builder.AddContainer("redis", "redis:latest")
.WithIconName("Database");
Set a custom service to use a specific icon with Regular variant:
var service = builder.AddProject<Projects.MyService>("service")
.WithIconName("CloudArrowUp", IconVariant.Regular);