Skip to content
Aspire
Docs Try Aspire
Docs Try

Install Aspire CLI

macOS

curl -sSL https://aspire.dev/install.sh | bash

Linux

curl -sSL https://aspire.dev/install.sh | bash

Windows

irm https://aspire.dev/install.ps1 | iex
More installation options

CertificateAuthorityCollectionResourceExtensions Methods

Class Methods 6 members
Provides extension methods for CertificateAuthorityCollection.
AddCertificateAuthorityCollection(IDistributedApplicationBuilder, string) Section titled AddCertificateAuthorityCollection(IDistributedApplicationBuilder, string) extension IResourceBuilder<CertificateAuthorityCollection>
Adds a new CertificateAuthorityCollection to the application model. This resource is intended for local development run time configuration and is excluded from published artifacts. 
public static class CertificateAuthorityCollectionResourceExtensions
{
    public static IResourceBuilder<CertificateAuthorityCollection> AddCertificateAuthorityCollection(
        this IDistributedApplicationBuilder builder,
        string name)
    {
        // ...
    }
}
CertificateAuthorityCollectionResourceExtensions.cs#L22-L35
Parameters
builder IDistributedApplicationBuilder The IDistributedApplicationBuilder.
name string The name of the certificate authority collection resource.
Returns
IResourceBuilder<CertificateAuthorityCollection> An ApplicationModel.IResourceBuilder`1 instance.
WithCertificate(IResourceBuilder<CertificateAuthorityCollection>, X509Certificate2) Section titled WithCertificate(IResourceBuilder<CertificateAuthorityCollection>, X509Certificate2) extension IResourceBuilder<CertificateAuthorityCollection>
Adds a certificate to the CertificateAuthorityCollection.Certificates collection. 
public static class CertificateAuthorityCollectionResourceExtensions
{
    public static IResourceBuilder<CertificateAuthorityCollection> WithCertificate(
        this IResourceBuilder<CertificateAuthorityCollection> builder,
        X509Certificate2 certificate)
    {
        // ...
    }
}
CertificateAuthorityCollectionResourceExtensions.cs#L46-L50
Parameters
builder IResourceBuilder<CertificateAuthorityCollection> The ApplicationModel.IResourceBuilder`1.
certificate X509Certificate2 The certificate to add.
Returns
IResourceBuilder<CertificateAuthorityCollection> The updated ApplicationModel.IResourceBuilder`1.
WithCertificates(IResourceBuilder<CertificateAuthorityCollection>, X509Certificate2Collection) Section titled WithCertificates(IResourceBuilder<CertificateAuthorityCollection>, X509Certificate2Collection) extension IResourceBuilder<CertificateAuthorityCollection>
Adds a collection of certificates to the CertificateAuthorityCollection.Certificates collection. 
public static class CertificateAuthorityCollectionResourceExtensions
{
    public static IResourceBuilder<CertificateAuthorityCollection> WithCertificates(
        this IResourceBuilder<CertificateAuthorityCollection> builder,
        X509Certificate2Collection certificates)
    {
        // ...
    }
}
CertificateAuthorityCollectionResourceExtensions.cs
Parameters
builder IResourceBuilder<CertificateAuthorityCollection> The ApplicationModel.IResourceBuilder`1.
certificates X509Certificate2Collection The collection of certificates to add.
Returns
IResourceBuilder<CertificateAuthorityCollection> The updated ApplicationModel.IResourceBuilder`1.
WithCertificates(IResourceBuilder<CertificateAuthorityCollection>, IEnumerable<X509Certificate2>) Section titled WithCertificates(IResourceBuilder<CertificateAuthorityCollection>, IEnumerable<X509Certificate2>) extension IResourceBuilder<CertificateAuthorityCollection>
Adds a collection of certificates to the CertificateAuthorityCollection.Certificates collection. 
public static class CertificateAuthorityCollectionResourceExtensions
{
    public static IResourceBuilder<CertificateAuthorityCollection> WithCertificates(
        this IResourceBuilder<CertificateAuthorityCollection> builder,
        IEnumerable<X509Certificate2> certificates)
    {
        // ...
    }
}
CertificateAuthorityCollectionResourceExtensions.cs
Parameters
builder IResourceBuilder<CertificateAuthorityCollection> The ApplicationModel.IResourceBuilder`1.
certificates IEnumerable<X509Certificate2> The collection of certificates to add.
Returns
IResourceBuilder<CertificateAuthorityCollection> The updated ApplicationModel.IResourceBuilder`1.
WithCertificatesFromFile(IResourceBuilder<CertificateAuthorityCollection>, string, Func<X509Certificate2, bool>) Section titled WithCertificatesFromFile(IResourceBuilder<CertificateAuthorityCollection>, string, Func<X509Certificate2, bool>) extension IResourceBuilder<CertificateAuthorityCollection>
Adds certificates from a PEM file to the CertificateAuthorityCollection.Certificates collection. 
public static class CertificateAuthorityCollectionResourceExtensions
{
    public static IResourceBuilder<CertificateAuthorityCollection> WithCertificatesFromFile(
        this IResourceBuilder<CertificateAuthorityCollection> builder,
        string pemFilePath,
        Func<X509Certificate2, bool>? filter = null)
    {
        // ...
    }
}
CertificateAuthorityCollectionResourceExtensions.cs#L147-L161
Parameters
builder IResourceBuilder<CertificateAuthorityCollection> The ApplicationModel.IResourceBuilder`1.
pemFilePath string The path to the PEM file.
filter Func<X509Certificate2, bool> optional An optional filter to apply to the loaded certificates before they are added to the collection.
Returns
IResourceBuilder<CertificateAuthorityCollection> The updated ApplicationModel.IResourceBuilder`1.
Remarks
This example adds certificates from a PEM file located at "../path/to/certificates.pem". 
builder.AddCertificateAuthorityCollection("my-ca")
    .WithCertificatesFromFile("../path/to/certificates.pem");
This example adds only certificates that are not expired from a PEM file located at "../path/to/certificates.pem". 
builder.AddCertificateAuthorityCollection("my-ca")
    .WithCertificatesFromFile(
        "../path/to/certificates.pem",
        c => c.NotAfter > DateTime.UtcNow);
WithCertificatesFromStore(IResourceBuilder<CertificateAuthorityCollection>, StoreName, StoreLocation, Func<X509Certificate2, bool>) Section titled WithCertificatesFromStore(IResourceBuilder<CertificateAuthorityCollection>, StoreName, StoreLocation, Func<X509Certificate2, bool>) extension IResourceBuilder<CertificateAuthorityCollection>
Adds certificates from a certificate store to the CertificateAuthorityCollection.Certificates collection. 
public static class CertificateAuthorityCollectionResourceExtensions
{
    public static IResourceBuilder<CertificateAuthorityCollection> WithCertificatesFromStore(
        this IResourceBuilder<CertificateAuthorityCollection> builder,
        StoreName storeName,
        StoreLocation storeLocation,
        Func<X509Certificate2, bool>? filter = null)
    {
        // ...
    }
}
CertificateAuthorityCollectionResourceExtensions.cs#L109-L120
Parameters
builder IResourceBuilder<CertificateAuthorityCollection> The ApplicationModel.IResourceBuilder`1.
storeName StoreName The name of the certificate store.
storeLocation StoreLocation The location of the certificate store.
filter Func<X509Certificate2, bool> optional An optional filter to apply to the certificates.
Returns
IResourceBuilder<CertificateAuthorityCollection> The updated ApplicationModel.IResourceBuilder`1.
Remarks
This example adds all certificates from the "Root" store in the "LocalMachine" location. 
builder.AddCertificateAuthorityCollection("my-ca")
    .WithCertificatesFromStore(StoreName.Root, StoreLocation.LocalMachine);
This example adds only certificates that are not expired from the "My" store in the "CurrentUser" location. 
builder.AddCertificateAuthorityCollection("my-ca")
    .WithCertificatesFromStore(
        StoreName.My,
        StoreLocation.CurrentUser,
        c => c.NotAfter > DateTime.UtcNow);
Connect with us

Community

SHA — 037d613 © Microsoft