Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

ParameterResource.WithDescription

Method
📦 Aspire.Hosting v17.0.0
type ParameterResource interface {
// ... omitted for brevity
WithDescription(
description string,
options ...*WithDescriptionOptions,
) ParameterResource
}

Signature

methodWithDescriptionbuilder
Sets the description of the parameter resource.
WithDescription(
description string,
options ...*WithDescriptionOptions,
) ParameterResource
descriptionstringThe parameter description.
options...*WithDescriptionOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithDescriptionOptions argument.

EnableMarkdown*boolA 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.
ParameterResource

Resource builder for the parameter.

Returns a handle; failures surface later via Err().

Defined on

This method is defined on the following type: