ComposeFile.Secrets Property

Definition

Namespace:: Aspire.Hosting.Docker.Resources

Assembly:: Aspire.Hosting.Docker.dll

Package:: Aspire.Hosting.Docker v9.2.0-preview.1.25209.2

Package:: Aspire.Hosting.Docker v9.3.0-preview.1.25265.20

Source:: ComposeFile.cs

Source:: ComposeFile.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.

Represents the secrets section in a Docker Compose file. Contains a collection of secret definitions used within the Compose file.

[YamlDotNet.Serialization.YamlMember(Alias="secrets", DefaultValuesHandling=YamlDotNet.Serialization.DefaultValuesHandling.OmitEmptyCollections)]
public System.Collections.Generic.Dictionary<string,Aspire.Hosting.Docker.Resources.ComposeNodes.Secret> Secrets { get; set; }

[<YamlDotNet.Serialization.YamlMember(Alias="secrets", DefaultValuesHandling=YamlDotNet.Serialization.DefaultValuesHandling.OmitEmptyCollections)>]
member this.Secrets : System.Collections.Generic.Dictionary<string, Aspire.Hosting.Docker.Resources.ComposeNodes.Secret> with get, set

Public Property Secrets As Dictionary(Of String, Secret)

Property Value

Dictionary<String,Secret>

Attributes: YamlDotNet.Serialization.YamlMemberAttribute

Remarks

Each secret is represented as a key-value pair, where the key is the name of the secret, and the value is an instance of the Secret class, which holds the details about the secret such as file ___location, external status, and additional metadata like labels.

Applies to