Secret

Docs / Reference / Search C# APIs / Aspire.Hosting.Docker / Secret

Secret

Docs Reference Search C# APIs Aspire.Hosting.Docker Secret

Class sealed net8.0

📦 Aspire.Hosting.Docker v13.2.0

Represents a Secret object in a Docker Compose configuration file.

namespace Aspire.Hosting.Docker.Resources.ComposeNodes;

public sealed class Secret
{
    // ...
}

Source

Search members of Secret...

constructor property

5 members Clear filters

Remarks

A Secret object is used to define sensitive information to be shared with containers, such as passwords, keys, or certificates. These secrets can either be externally managed or provided locally from a specific file.

Constructors1

Secret

View all constructors

Properties4

Externalget; set

bool?

Indicates whether the secret is managed externally. If set to true, the secret must already exist, as it will not be created or modified.

Fileget; set

string?

Represents the file path associated with the secret. This specifies the location of the file on the host system that will be used as the source for the secret in the container.

Labelsget; set

Dictionary<string, string>

Gets or sets a collection of key-value pairs representing metadata or additional information associated with the secret. These labels can be used for categorization, identification, or other purposes as determined by the user.

Nameget; set

string?

Gets or sets the name of the secret in the Docker Compose configuration.

View all properties