ContainerNetworkOptions Class

Network options for a container.

public sealed class ContainerNetworkOptions

Remarks

Name	Description
Alias	Gets or sets a network alias for the container on `ContainerNetworkOptions.Network`, or on the default network when `ContainerNetworkOptions.Network` is not set.
Attachments	Gets the networks added with `ContainerNetworkOptions.Add` and `ContainerNetworkOptions.Add`.
Network	Gets or sets the network the container connects to first. It can also be a network mode, such as `host` or `none`.

Gets or sets a network alias for the container on ContainerNetworkOptions.Network, or on the default network when ContainerNetworkOptions.Network is not set.

public string? Alias { get; set; }

public IReadOnlyList<ContainerNetworkAttachment> Attachments { get; }

Gets or sets the network the container connects to first. It can also be a network mode, such as host or none.

public string? Network { get; set; }

Name	Description
Add(TemporaryNetwork, string[])	Connects the container to a `TemporaryNetwork`. The network is created, if needed, when the container is created.
Add(string, string[])	Connects the container to an existing network.
Remove(string)	Disconnects the container from a network added with `ContainerNetworkOptions.Add` or `ContainerNetworkOptions.Add`.

Connects the container to a TemporaryNetwork. The network is created, if needed, when the container is created.

public void Add(TemporaryNetwork network, params string[] aliases)

network TemporaryNetwork: The network.
aliases string[]: The aliases the other containers of the network reach the container by.

Connects the container to an existing network.

public void Add(string network, params string[] aliases)

network string: The name of the network.
aliases string[]: The aliases the other containers of the network reach the container by.

public bool Remove(string network)

bool true if the network was removed; otherwise, false.