Network

Classsealednet10.0

📦 Aspire.Hosting.Docker v13.6.0

Represents a Docker network configuration as part of a Compose file.

namespace Aspire.Hosting.Docker.Resources.ComposeNodes;

public sealed class Network
    : Aspire.Hosting.Docker.Resources.ComposeNodes.NamedComposeMember
{
    // ...
}

NamedComposeMember

9 members

Remarks

This class encapsulates the properties and options related to a network in a Docker Compose file. It includes configurations such as driver type, options, labels, IPAM settings, and more.

Constructors1

Network

View all constructors

Properties8

Attachableget; set

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.

Driverget; set

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.

DriverOptsget; set

Dictionary<string, string>

Represents a dictionary of driver-specific options for the network configuration in a Docker service node.

Externalget; set

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.

Ingressget; set

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.

Internalget; set

bool?

Determines if the network is restricted to internal usage only. When set to true, the network is not accessible externally.

Ipamget; set

Ipam?

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.

Labelsget; set

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.

View all properties