ResourceBuilderExtensions.WithHttpsCertificate<TResource> Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Adds a HttpsCertificateAnnotation to the resource annotations to associate an X.509 certificate key pair with the resource. This is used to configure the certificate presented by the resource for HTTPS/TLS endpoints.
public static Aspire.Hosting.ApplicationModel.IResourceBuilder<TResource> WithHttpsCertificate<TResource>(this Aspire.Hosting.ApplicationModel.IResourceBuilder<TResource> builder, System.Security.Cryptography.X509Certificates.X509Certificate2 certificate, Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource>? password = default) where TResource : Aspire.Hosting.ApplicationModel.IResourceWithEnvironment, Aspire.Hosting.ApplicationModel.IResourceWithArgs;static member WithHttpsCertificate : Aspire.Hosting.ApplicationModel.IResourceBuilder<'Resource (requires 'Resource :> Aspire.Hosting.ApplicationModel.IResourceWithEnvironment and 'Resource :> Aspire.Hosting.ApplicationModel.IResourceWithArgs)> * System.Security.Cryptography.X509Certificates.X509Certificate2 * Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource> -> 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 WithHttpsCertificate(Of TResource As {IResourceWithEnvironment, IResourceWithArgs}) (builder As IResourceBuilder(Of TResource), certificate As X509Certificate2, Optional password As IResourceBuilder(Of ParameterResource) = Nothing) As IResourceBuilder(Of TResource)Type Parameters
- TResource
The type of the resource.
Parameters
- builder
- IResourceBuilder<TResource>
The resource builder.
- certificate
- X509Certificate2
An X509Certificate2 key pair to use for HTTPS/TLS endpoints on the resource.
- password
- IResourceBuilder<ParameterResource>
A parameter specifying the password used to encrypt the certificate private key.
Returns
IResourceBuilder<TResource>
The IResourceBuilder<T>.
Remarks
Use a custom certificate for HTTPS/TLS endpoints on a container resource:
var certificate = new X509Certificate2("path/to/certificate.pfx", "password");
builder.AddContainer("my-service", "my-image")
.WithHttpsCertificate(certificate);