Share via

ResourceBuilderExtensions.WithHttpsCertificateConfiguration<TResource> Method

Definition

Namespace:
Aspire.Hosting
Assembly:
Aspire.Hosting.dll
Package:
Aspire.Hosting v13.1.0
Source:
ResourceBuilderExtensions.cs

Adds a callback that allows configuring the resource to use a specific HTTPS/TLS certificate key pair for server authentication.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<TResource> WithHttpsCertificateConfiguration<TResource>(this Aspire.Hosting.ApplicationModel.IResourceBuilder<TResource> builder, Func<Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext,System.Threading.Tasks.Task> callback) where TResource : Aspire.Hosting.ApplicationModel.IResourceWithEnvironment, Aspire.Hosting.ApplicationModel.IResourceWithArgs;
static member WithHttpsCertificateConfiguration : Aspire.Hosting.ApplicationModel.IResourceBuilder<'Resource (requires 'Resource :> Aspire.Hosting.ApplicationModel.IResourceWithEnvironment and 'Resource :> Aspire.Hosting.ApplicationModel.IResourceWithArgs)> * Func<Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext, System.Threading.Tasks.Task> -> Aspire.Hosting.ApplicationModel.IResourceBuilder<'Resource (requires 'Resource :> Aspire.Hosting.ApplicationModel.IResourceWithEnvironment and 'Resource :> Aspire.Hosting.ApplicationModel.IResourceWithArgs)> (requires 'Resource :> Aspire.Hosting.ApplicationModel.IResourceWithEnvironment and 'Resource :> Aspire.Hosting.ApplicationModel.IResourceWithArgs)
<Extension()>
Public Function WithHttpsCertificateConfiguration(Of TResource As {IResourceWithEnvironment, IResourceWithArgs}) (builder As IResourceBuilder(Of TResource), callback As Func(Of HttpsCertificateConfigurationCallbackAnnotationContext, Task)) As IResourceBuilder(Of TResource)

Type Parameters

TResource

The type of the resource.

Parameters

builder
IResourceBuilder<TResource>

The resource builder.

callback
Func<HttpsCertificateConfigurationCallbackAnnotationContext,Task>

The callback to configure the resource to use a certificate key pair.

Returns

IResourceBuilder<TResource>

The updated resource builder.

Remarks

Pass the path to the PFX certificate file to the container arguments. 
builder.AddContainer("my-service", "my-image")
    .WithHttpsCertificateConfiguration(ctx =>
    {
        ctx.Arguments.Add("--https-certificate-path");
        ctx.Arguments.Add(ctx.PfxPath);
        return Task.CompletedTask;
    });

Applies to