ParameterResourceBuilderExtensions Methods

Docs / Reference / Search C# APIs / Aspire.Hosting / ParameterResourceBuilderExtensions / Methods

Methods

Docs Reference Search C# APIs Aspire.Hosting ParameterResourceBuilderExtensions Methods

Class Methods 13 members

Provides extension methods for adding parameter resources to an application.

AddConnectionString(IDistributedApplicationBuilder, string, string?) extension IResourceBuilder<IResourceWithConnectionString>

Adds a parameter to the distributed application but wrapped in a resource with a connection string for use with ResourceBuilderExtensions.WithReference

public static class ParameterResourceBuilderExtensions
{
    public static IResourceBuilder<IResourceWithConnectionString> AddConnectionString(
        this IDistributedApplicationBuilder builder,
        string name,
        string? environmentVariableName = null)
    {
        // ...
    }
}

ParameterResourceBuilderExtensions.cs#L245-L254

Parameters

builder IDistributedApplicationBuilder Distributed application builder

name string Name of parameter resource. The value of the connection string is read from the "ConnectionStrings:{resourcename}" configuration section, for example in appsettings.json or user secrets

environmentVariableName string? optional Environment variable name to set when WithReference is used.

Returns

IResourceBuilder<IResourceWithConnectionString> Resource builder for the parameter.

Exceptions

DistributedApplicationException

AddParameter(IDistributedApplicationBuilder, string, bool) extension IResourceBuilder<ParameterResource>

Adds a parameter resource to the application.

public static class ParameterResourceBuilderExtensions
{
    public static IResourceBuilder<ParameterResource> AddParameter(
        this IDistributedApplicationBuilder builder,
        string name,
        bool secret = false)
    {
        // ...
    }
}

ParameterResourceBuilderExtensions.cs#L28-L36

Parameters

builder IDistributedApplicationBuilder Distributed application builder

name string Name of parameter resource

secret bool optional Optional flag indicating whether the parameter should be regarded as secret.

Returns

IResourceBuilder<ParameterResource> Resource builder for the parameter.

Exceptions

DistributedApplicationException

AddParameter(IDistributedApplicationBuilder, string, string, bool, bool) extension IResourceBuilder<ParameterResource>

Adds a parameter resource to the application with a given value.

public static class ParameterResourceBuilderExtensions
{
    public static IResourceBuilder<ParameterResource> AddParameter(
        this IDistributedApplicationBuilder builder,
        string name,
        string value,
        bool publishValueAsDefault = false,
        bool secret = false)
    {
        // ...
    }
}

ParameterResourceBuilderExtensions.cs#L53-L57

Parameters

builder IDistributedApplicationBuilder Distributed application builder

name string Name of parameter resource

value string A string value to use for the parameter

publishValueAsDefault bool optional Indicates whether the value should be published to the manifest. This is not meant for sensitive data.

secret bool optional Optional flag indicating whether the parameter should be regarded as secret.

Returns

IResourceBuilder<ParameterResource> Resource builder for the parameter.

Remarks

publishValueAsDefault and secret are mutually exclusive.

AddParameter(IDistributedApplicationBuilder, string, Func<string>, bool, bool) extension IResourceBuilder<ParameterResource>

Adds a parameter resource to the application with a value coming from a callback function.

public static class ParameterResourceBuilderExtensions
{
    public static IResourceBuilder<ParameterResource> AddParameter(
        this IDistributedApplicationBuilder builder,
        string name,
        Func<string> valueGetter,
        bool publishValueAsDefault = false,
        bool secret = false)
    {
        // ...
    }
}

ParameterResourceBuilderExtensions.cs#L74-L94

Parameters

builder IDistributedApplicationBuilder Distributed application builder

name string Name of parameter resource

valueGetter Func<string> A callback function that returns the value of the parameter

publishValueAsDefault bool optional Indicates whether the value should be published to the manifest. This is not meant for sensitive data.

secret bool optional Optional flag indicating whether the parameter should be regarded as secret.

Returns

IResourceBuilder<ParameterResource> Resource builder for the parameter.

Remarks

publishValueAsDefault and secret are mutually exclusive.

AddParameter(IDistributedApplicationBuilder, string, ParameterDefault, bool, bool) extension IResourceBuilder<ParameterResource>

Adds a parameter resource to the application, with a value coming from a ParameterDefault if not supplied from configuration.

public static class ParameterResourceBuilderExtensions
{
    public static IResourceBuilder<ParameterResource> AddParameter(
        this IDistributedApplicationBuilder builder,
        string name,
        ParameterDefault value,
        bool secret = false,
        bool persist = false)
    {
        // ...
    }
}

ParameterResourceBuilderExtensions.cs#L137-L151

Parameters

builder IDistributedApplicationBuilder Distributed application builder

name string Name of parameter resource

value ParameterDefault A ParameterDefault that is used to provide the parameter value if a value is not present in configuration

secret bool optional Optional flag indicating whether the parameter should be regarded as secret.

persist bool optional Persist the value to the app host project's user secrets store. This is typically done when the value is generated, so that it stays stable across runs. This is only relevant when DistributedApplicationExecutionContext.IsRunMode is true

Returns

IResourceBuilder<ParameterResource> Resource builder for the parameter.

AddParameterFromConfiguration(IDistributedApplicationBuilder, string, string, bool) extension IResourceBuilder<ParameterResource>

Adds a parameter resource to the application, with a value coming from configuration.

public static class ParameterResourceBuilderExtensions
{
    public static IResourceBuilder<ParameterResource> AddParameterFromConfiguration(
        this IDistributedApplicationBuilder builder,
        string name,
        string configurationKey,
        bool secret = false)
    {
        // ...
    }
}

ParameterResourceBuilderExtensions.cs#L107-L118

Parameters

builder IDistributedApplicationBuilder Distributed application builder

name string Name of parameter resource

configurationKey string Configuration key used to get the value of the parameter

secret bool optional Optional flag indicating whether the parameter should be regarded as secret.

Returns

IResourceBuilder<ParameterResource> Resource builder for the parameter.

ConfigureConnectionStringManifestPublisher(IResourceBuilder<IResourceWithConnectionString>) static

Configures the manifest writer for this resource to be a parameter resource.

public static class ParameterResourceBuilderExtensions
{
    public static void ConfigureConnectionStringManifestPublisher(
        IResourceBuilder<IResourceWithConnectionString> builder)
    {
        // ...
    }
}

ParameterResourceBuilderExtensions.cs#L278-L285

Parameters

builder IResourceBuilder<IResourceWithConnectionString> The ApplicationModel.IResourceBuilder`1.

CreateDefaultPasswordParameter(IDistributedApplicationBuilder, string, bool, bool, bool, bool, int, int, int, int) static ParameterResource

Creates a default password parameter that generates a random password.

public static class ParameterResourceBuilderExtensions
{
    public static ParameterResource CreateDefaultPasswordParameter(
        IDistributedApplicationBuilder builder,
        string name,
        bool lower = true,
        bool upper = true,
        bool numeric = true,
        bool special = true,
        int minLower = 0,
        int minUpper = 0,
        int minNumeric = 0,
        int minSpecial = 0)
    {
        // ...
    }
}

ParameterResourceBuilderExtensions.cs#L310-L326

Parameters

builder IDistributedApplicationBuilder Distributed application builder

name string Name of parameter resource

lower bool optional true if lowercase alphabet characters should be included; otherwise, false.

upper bool optional true if uppercase alphabet characters should be included; otherwise, false.

numeric bool optional true if numeric characters should be included; otherwise, false.

special bool optional true if special characters should be included; otherwise, false.

minLower int optional The minimum number of lowercase characters in the result.

minUpper int optional The minimum number of uppercase characters in the result.

minNumeric int optional The minimum number of numeric characters in the result.

minSpecial int optional The minimum number of special characters in the result.

Returns

ParameterResource The created ParameterResource.

Remarks

To ensure the generated password has enough entropy, see the remarks in GenerateParameterDefault. The value will be saved to the app host project's user secrets store when DistributedApplicationExecutionContext.IsRunMode is true.

CreateGeneratedParameter(IDistributedApplicationBuilder, string, bool, GenerateParameterDefault) static ParameterResource

Creates a new ParameterResource that has a generated value using the parameterDefault.

public static class ParameterResourceBuilderExtensions
{
    public static ParameterResource CreateGeneratedParameter(
        IDistributedApplicationBuilder builder,
        string name,
        bool secret,
        GenerateParameterDefault parameterDefault)
    {
        // ...
    }
}

ParameterResourceBuilderExtensions.cs#L343-L356

Parameters

builder IDistributedApplicationBuilder Distributed application builder

name string Name of parameter resource

secret bool Flag indicating whether the parameter should be regarded as secret.

parameterDefault GenerateParameterDefault The GenerateParameterDefault that describes how the parameter's value should be generated.

Returns

ParameterResource The created ParameterResource.

Remarks

The value will be saved to the app host project's user secrets store when DistributedApplicationExecutionContext.IsRunMode is true.

CreateParameter(IDistributedApplicationBuilder, string, bool) static ParameterResource

Creates a new ParameterResource.

public static class ParameterResourceBuilderExtensions
{
    public static ParameterResource CreateParameter(
        IDistributedApplicationBuilder builder,
        string name,
        bool secret)
    {
        // ...
    }
}

ParameterResourceBuilderExtensions.cs#L371-L376

Parameters

builder IDistributedApplicationBuilder Distributed application builder

name string Name of parameter resource

secret bool Flag indicating whether the parameter should be regarded as secret.

Returns

ParameterResource The created ParameterResource.

Remarks

The value will be saved to the app host project's user secrets store when DistributedApplicationExecutionContext.IsRunMode is true.

PublishAsConnectionString(IResourceBuilder<T>) extension IResourceBuilder<T>

Changes the resource to be published as a connection string reference in the manifest.

public static class ParameterResourceBuilderExtensions
{
    public static IResourceBuilder<T> PublishAsConnectionString<T>(
        this IResourceBuilder<T> builder)
    {
        // ...
    }
}

ParameterResourceBuilderExtensions.cs#L266-L269

Parameters

builder IResourceBuilder<T> The resource builder.

Returns

IResourceBuilder<T> The configured ApplicationModel.IResourceBuilder`1.

Experimental — ASPIREINTERACTION001

WithCustomInput(IResourceBuilder<ParameterResource>, Func<ParameterResource, InteractionInput>) extension IResourceBuilder<ParameterResource>

Sets a custom input generator function for the parameter resource.

public static class ParameterResourceBuilderExtensions
{
    public static IResourceBuilder<ParameterResource> WithCustomInput(
        this IResourceBuilder<ParameterResource> builder,
        Func<ParameterResource, InteractionInput> createInput)
    {
        // ...
    }
}

ParameterResourceBuilderExtensions.cs#L198-L203

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
    });

WithDescription(IResourceBuilder<ParameterResource>, string, bool) extension IResourceBuilder<ParameterResource>

Sets the description of the parameter resource.

public static class ParameterResourceBuilderExtensions
{
    public static IResourceBuilder<ParameterResource> WithDescription(
        this IResourceBuilder<ParameterResource> builder,
        string description,
        bool enableMarkdown = false)
    {
        // ...
    }
}

ParameterResourceBuilderExtensions.cs#L166-L172

Parameters

builder IResourceBuilder<ParameterResource> Resource builder for the parameter.

description string The parameter description.

enableMarkdown bool optional 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.