Config Class
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.
Represents a configuration object in a Docker Compose file.
[YamlDotNet.Serialization.YamlSerializable]
public sealed class Config[<YamlDotNet.Serialization.YamlSerializable>]
type Config = classPublic NotInheritable Class Config- Inheritance
-
Config
- Attributes
-
YamlDotNet.Serialization.YamlSerializableAttribute
Remarks
This class models a configuration entry within a Docker Compose file, such as file-based or external configurations. It includes properties to define the source file, external flag, custom name, and additional labels for the configuration.
Constructors
| Config() |
Properties
| External |
Indicates whether the configuration is external to the current project context. When set to true, the configuration will not be managed or created by the Compose file; instead, it references an existing resource outside the current scope. If null, the external status is not explicitly specified. |
| File |
Gets or sets the path to the configuration file. This property is used to specify the file containing the configuration data for the service or component. |
| Labels |
Represents a collection of key-value pairs used as metadata for configuration objects. The labels provide additional descriptive information, which can be utilized for tagging, grouping, or identification purposes. |
| Name |
Represents the name of the Docker configuration resource as defined in the Compose file. |