Share via

ParameterResourceBuilderExtensions.WithCustomInput 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 a custom input generator function for the parameter resource.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource> WithCustomInput(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource> builder, Func<Aspire.Hosting.ApplicationModel.ParameterResource,Aspire.Hosting.InteractionInput> createInput);
static member WithCustomInput : Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource> * Func<Aspire.Hosting.ApplicationModel.ParameterResource, Aspire.Hosting.InteractionInput> -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource>
<Extension()>
Public Function WithCustomInput (builder As IResourceBuilder(Of ParameterResource), createInput As Func(Of ParameterResource, InteractionInput)) As IResourceBuilder(Of ParameterResource)

Parameters

builder
IResourceBuilder<ParameterResource>

Resource builder for the parameter.

createInput
Func<ParameterResource,InteractionInput>

Function to customize the input for the parameter.

Returns

IResourceBuilder<ParameterResource>

Resource builder for the parameter.

Remarks

Use this method to customize how the input field for this parameter is rendered when its value is requested, e.g.: 

builder.AddParameter("external-service-url")
    .WithCustomInput(parameter => new()
    {
        InputType = parameter.Secret ? InputType.SecretText : InputType.Text,
        Value = "https://example.com",
        Label = parameter.Name,
        Placeholder = $"Enter value for {parameter.Name}",
        Description = parameter.Description
    });

Applies to