Skip to content
Docs Try Aspire

Network Properties

Class Properties 8 members
Represents a Docker network configuration as part of a Compose file.
Attachable Section titled Attachable nullable bool?
Gets or sets a value indicating whether the network is attachable. When this property is set to true, containers can dynamically attach to the network at runtime. This feature is primarily used in Docker Swarm mode to enable service discovery and communication between services.
public bool? Attachable { get; set; }
Driver Section titled Driver nullable string?
Gets or sets the driver used for the network. The driver determines the networking implementation that the container network is based on. Examples include bridge, overlay, host, etc.
public string? Driver { get; set; }
DriverOpts Section titled DriverOpts Dictionary<string, string>
Represents a dictionary of driver-specific options for the network configuration in a Docker service node.
public Dictionary<string, string> DriverOpts { get; set; }
These options are key-value pairs that allow customization of network settings based on the specified driver. They can control behaviors or features unique to the driver being used.
External Section titled External nullable bool?
Indicates whether the network is external or managed by Docker outside of the application stack. When set to true, the network is assumed to be pre-existing and not defined by the application's configuration. When set to false or null, the network can be defined and created within the application scope.
public bool? External { get; set; }
Ingress Section titled Ingress nullable bool?
Represents whether the network is configured as an ingress network. An ingress network is used to manage the internal routing and load balancing for swarm services in Docker.
public bool? Ingress { get; set; }
Internal Section titled Internal nullable bool?
Determines if the network is restricted to internal usage only. When set to true, the network is not accessible externally.
public bool? Internal { get; set; }
Represents the IP Address Management (IPAM) configuration for a network in a container environment. IPAM is used to manage network configurations such as custom IP ranges, subnets, and gateway settings.
public Ipam? Ipam { get; set; }
Labels Section titled Labels Dictionary<string, string>
Represents a collection of metadata labels applied to the network configuration. These labels can be used to organize, manage, or identify network resources.
public Dictionary<string, string> Labels { get; set; }