ContainerResourceBuilderExtensions.WithBuildSecret<T> Method

Reference

Definition

Namespace:: Aspire.Hosting

Assembly:: Aspire.Hosting.dll

Package:: Aspire.Hosting v8.2.0

Package:: Aspire.Hosting v9.0.0

Source:: ContainerResourceBuilderExtensions.cs

Source:: ContainerResourceBuilderExtensions.cs

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 secret build argument when the container is built from a Dockerfile.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<T> WithBuildSecret<T> (this Aspire.Hosting.ApplicationModel.IResourceBuilder<T> builder, string name, Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource> value) where T : Aspire.Hosting.ApplicationModel.ContainerResource;

static member WithBuildSecret : Aspire.Hosting.ApplicationModel.IResourceBuilder<'T (requires 'T :> Aspire.Hosting.ApplicationModel.ContainerResource)> * string * Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource> -> Aspire.Hosting.ApplicationModel.IResourceBuilder<'T (requires 'T :> Aspire.Hosting.ApplicationModel.ContainerResource)> (requires 'T :> Aspire.Hosting.ApplicationModel.ContainerResource)

<Extension()>
Public Function WithBuildSecret(Of T As ContainerResource) (builder As IResourceBuilder(Of T), name As String, value As IResourceBuilder(Of ParameterResource)) As IResourceBuilder(Of T)

Type Parameters

T

The type of container resource.

Parameters

builder: IResourceBuilder<T>

The resource builder for the container resource.

name: String

The name of the secret build argument.

value: IResourceBuilder<ParameterResource>

The resource builder for a parameter resource.

Returns

IResourceBuilder<T>

The resource builder for the container resource.

Exceptions

InvalidOperationException

Thrown when WithBuildSecret<T>(IResourceBuilder<T>, String, IResourceBuilder<ParameterResource>) is called before WithDockerfile<T>(IResourceBuilder<T>, String, String, String).

Examples

Adding a build secret based on a parameter.

var builder = DistributedApplication.CreateBuilder(args);
var accessToken = builder.AddParameter("accessToken", secret: true);
builder.AddContainer("mycontainer", "myimage")
       .WithDockerfile("../mycontainer")
       .WithBuildSecret("ACCESS_TOKEN", accessToken);

Remarks

The WithBuildSecret<T>(IResourceBuilder<T>, String, IResourceBuilder<ParameterResource>) extension method results in a --secret argument being appended to the docker build or podman build command. This overload results in an environment variable-based secret being passed to the build process. The value of the environment variable is the value of the secret referenced by the ParameterResource.

Applies to

Partager via