IResourceWithCustomWithReference<TSelf> Methods

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

Methods

Docs Reference Search C# APIs Aspire.Hosting IResourceWithCustomWithReference Methods

InterfaceMethods1 member

Defines custom WithReference dispatch behavior for a resource type.

TryWithReference(IResourceBuilder<TDestination>, IResourceBuilder<IResource>, string?, bool, string?)staticabstractnullableIResourceBuilder<TDestination>

Applies a reference from source to builder using resource-specific behavior.

public interface IResourceWithCustomWithReference<TSelf>
{
    public static abstract IResourceBuilder<TDestination>? TryWithReference<TDestination>(
        IResourceBuilder<TDestination> builder,
        IResourceBuilder<IResource> source,
        string? connectionName = null,
        bool optional = false,
        string? name = null)
    {
        // ...
    }
}

Parameters

builderIResourceBuilder<TDestination>The destination resource builder.

sourceIResourceBuilder<IResource>The source resource builder.

connectionNamestring?optionalAn optional connection string override used by connection-string-based references.

optionalbooloptionaltrue to allow a missing connection string; otherwise, false.

namestring?optionalAn optional service discovery name override used by service-based references.

Returns

IResourceBuilder<TDestination>The destination ApplicationModel.IResourceBuilder`1 when handled; otherwise, null.