DockerSdk.Networks.INetwork Interface Reference

Represents a Docker network. More...

Inheritance diagram for DockerSdk.Networks.INetwork:

Public Member Functions
Task	AttachAsync (ContainerReference container, CancellationToken ct=default)
	Attaches the network to a Docker container. More...
Task	AttachAsync (ContainerReference container, AttachNetworkOptions options, CancellationToken ct=default)
	Attaches the network to a Docker container. More...
Task	AttachAsync (string container, CancellationToken ct=default)
	Attaches the network to a Docker container. More...
Task	AttachAsync (string container, AttachNetworkOptions options, CancellationToken ct=default)
	Attaches the network to a Docker container. More...
Task< INetworkInfo >	GetDetailsAsync (CancellationToken ct=default)
	Loads detailed information about the Docker network. More...

Properties
NetworkFullId	Id [get]
	Gets the networks's full ID. More...

Detailed Description

Represents a Docker network.

See also

NetworkInfo

Member Function Documentation

AttachAsync() [1/4]

Task DockerSdk.Networks.INetwork.AttachAsync	(	ContainerReference	container,
		AttachNetworkOptions	options,
		CancellationToken	ct = default
	)

Attaches the network to a Docker container.

Parameters

container	A reference to the container.
options	Options for how to perform the operation.
ct	A token used to cancel the operation.

Returns

A Task that resolves when the network has been attached.

Exceptions

ArgumentNullException	One or more of the inputs are null.
ArgumentException	The options input has invalid values, such as an IPv6 address in the AttachNetworkOptions.IPv6Address property.
NetworkNotFoundException	The network no longer exists.
ContainerNotFoundException	The indicated container does not exist.
System.Net.Http.HttpRequestException	The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation, or timeout.

AttachAsync() [2/4]

Task DockerSdk.Networks.INetwork.AttachAsync	(	ContainerReference	container,
		CancellationToken	ct = default
	)

Attaches the network to a Docker container.

Parameters

container	A reference to the container.
ct	A token used to cancel the operation.

Returns

A Task that resolves when the network has been attached.

Exceptions

ArgumentNullException	container is null.
NetworkNotFoundException	The network no longer exists.
ContainerNotFoundException	The indicated container does not exist.
System.Net.Http.HttpRequestException	The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation, or timeout.

AttachAsync() [3/4]

Task DockerSdk.Networks.INetwork.AttachAsync	(	string	container,
		AttachNetworkOptions	options,
		CancellationToken	ct = default
	)

Attaches the network to a Docker container.

Parameters

container	A reference to the container.
options	Options for how to perform the operation.
ct	A token used to cancel the operation.

Returns

A Task that resolves when the network has been attached.

Exceptions

ArgumentNullException	One or more of the inputs are null.
ArgumentException	The options input has invalid values, such as an IPv6 address in the AttachNetworkOptions.IPv6Address property.
NetworkNotFoundException	The network no longer exists.
MalformedReferenceException	container is not a well-formed container reference.
ContainerNotFoundException	The indicated container does not exist.
System.Net.Http.HttpRequestException	The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation, or timeout.

AttachAsync() [4/4]

Task DockerSdk.Networks.INetwork.AttachAsync	(	string	container,
		CancellationToken	ct = default
	)

Attaches the network to a Docker container.

Parameters

container	A reference to the container.
ct	A token used to cancel the operation.

Returns

A Task that resolves when the network has been attached.

Exceptions

ArgumentNullException	container is null.
NetworkNotFoundException	The network no longer exists.
MalformedReferenceException	container is not a well-formed container reference.
ContainerNotFoundException	The indicated container does not exist.
System.Net.Http.HttpRequestException	The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation, or timeout.

GetDetailsAsync()

Task<INetworkInfo> DockerSdk.Networks.INetwork.GetDetailsAsync

(

CancellationToken

ct = default

)

Loads detailed information about the Docker network.

Parameters

ct	A token used to cancel the operation.

Returns

A Task<TResult> that resolves to the details.

Exceptions

NetworkNotFoundException	The network no longer exists.
System.Net.Http.HttpRequestException	The request failed due to an underlying issue such as network connectivity.

Property Documentation

Id

NetworkFullId DockerSdk.Networks.INetwork.Id

get

Gets the networks's full ID.

---

The documentation for this interface was generated from the following file:

• Networks/INetwork.cs