Share via

ParameterResourceBuilderExtensions.WithDescription Method

Definition

Namespace:
Aspire.Hosting
Assembly:
Aspire.Hosting.dll
Package:
Aspire.Hosting v13.0.0
Package:
Aspire.Hosting v9.5.0
Source:
ParameterResourceBuilderExtensions.cs
Source:
ParameterResourceBuilderExtensions.cs
Source:
ParameterResourceBuilderExtensions.cs

Sets the description of the parameter resource.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource> WithDescription(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource> builder, string description, bool enableMarkdown = false);
static member WithDescription : Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource> * string * bool -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource>
<Extension()>
Public Function WithDescription (builder As IResourceBuilder(Of ParameterResource), description As String, Optional enableMarkdown As Boolean = false) As IResourceBuilder(Of ParameterResource)

Parameters

builder
IResourceBuilder<ParameterResource>

Resource builder for the parameter.

description
String

The parameter description.

enableMarkdown
Boolean

A value indicating whether the description should be rendered as Markdown. true allows the description to contain Markdown elements such as links, text decoration and lists.

Returns

IResourceBuilder<ParameterResource>

Resource builder for the parameter.

Applies to