DaprMetadataResourceBuilderExtensions Methods

Docs / Reference / Search C# APIs / CommunityToolkit.Aspire.Hosting.Dapr / DaprMetadataResourceBuilderExtensions / Methods

Methods

Docs Reference Search C# APIs CommunityToolkit.Aspire.Hosting.Dapr DaprMetadataResourceBuilderExtensions Methods

Class Methods 3 members

Provides extension methods for configuring dapr components with metadata

WithMetadata(IResourceBuilder<IDaprComponentResource>, string, string) extension IResourceBuilder<IDaprComponentResource>

Adds static value metadata to the Dapr component

public static class DaprMetadataResourceBuilderExtensions
{
    public static IResourceBuilder<IDaprComponentResource> WithMetadata(
        this IResourceBuilder<IDaprComponentResource> builder,
        string name,
        string value)
    {
        // ...
    }
}

DaprMetadataResourceBuilderExtensions.cs#L19-L32

Parameters

builder IResourceBuilder<IDaprComponentResource>

name string

value string

WithMetadata(IResourceBuilder<IDaprComponentResource>, string, IValueProvider) extension IResourceBuilder<IDaprComponentResource>

Adds a value provider as metadata to the Dapr component that will be resolved at runtime.

public static class DaprMetadataResourceBuilderExtensions
{
    public static IResourceBuilder<IDaprComponentResource> WithMetadata(
        this IResourceBuilder<IDaprComponentResource> builder,
        string name,
        IValueProvider valueProvider)
    {
        // ...
    }
}

DaprMetadataResourceBuilderExtensions.cs#L62-L87

Parameters

builder IResourceBuilder<IDaprComponentResource> The resource builder for the Dapr component being configured.

name string The name of the metadata property to add to the Dapr component configuration.

valueProvider IValueProvider The value provider (e.g., EndpointReference, ConnectionStringReference) whose value will be resolved at runtime. The provider's value is stored as an environment variable and referenced through Dapr's secret key reference mechanism.

Returns

IResourceBuilder<IDaprComponentResource> The resource builder instance.

Remarks

This method enables dynamic configuration of Dapr components by:

The environment variable name format is: {COMPONENT_NAME}_{METADATA_NAME} (uppercased, hyphens replaced with underscores). This approach allows for secure injection of dynamic values like endpoint URLs or connection strings that are only known at runtime.

Examples

var cache = builder.AddDaprComponent("cache", "state.redis")
    .WithMetadata("redisHost", redis.GetEndpoint("tcp"));

WithMetadata(IResourceBuilder<IDaprComponentResource>, string, ParameterResource) extension IResourceBuilder<IDaprComponentResource>

Adds a parameter resource as metadata to the Dapr component

public static class DaprMetadataResourceBuilderExtensions
{
    public static IResourceBuilder<IDaprComponentResource> WithMetadata(
        this IResourceBuilder<IDaprComponentResource> builder,
        string name,
        ParameterResource parameterResource)
    {
        // ...
    }
}

DaprMetadataResourceBuilderExtensions.cs#L100-L135

Parameters

builder IResourceBuilder<IDaprComponentResource>

name string

parameterResource ParameterResource