Network

Handle

📦 Aspire.Hosting.Docker v13.4.0

interface Network {
  attachable: boolean;
  driver: string;
  driverOpts: Dict<string,string>;
  external: boolean;
  ingress: boolean;
  internal: boolean;
  labels: Dict<string,string>;
  name: string;
}

16 members

Properties

property attachable boolean get · set

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.

property driver string get · set

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.

property driverOpts Dict<string,string> get · set

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

property external boolean get · set

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.

property ingress boolean get · set

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.

property internal boolean get · set

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

property labels Dict<string,string> get · set

Represents a collection of metadata labels applied to the network configuration. These labels can be used to organize, manage, or identify network resources.

property name string get · set

Gets or sets the name of the Docker Compose member.