DockerSdk.Containers Namespace Reference

Classes
class	Container
	Represents a Docker container.
class	ContainerAccess
	Provides access to functionality involving Docker containers. More...
class	ContainerFactory
class	ContainerInfo
	Holds detailed information about a Docker container.
class	ContainerNotFoundException
	Indicates that no Docker container with the given name is known to the Docker daemon. More...
class	CreateContainerOptions
	Settings for how to create a container and how it should behave. More...
interface	IContainer
	Represents a Docker container. More...
interface	IContainerInfo
	Holds detailed information about a Docker container. More...
class	ListContainersOptions
	Filters for container listings. More...

Enumerations
enum class	ContainerExitAction {   None = 0 , Remove , Restart , RestartUnlessStopped ,   RestartOnFailure }
	Lists actions that Docker can do automatically when a container exits. More...
enum class	ContainerStatus {   Created , Restarting , Running , Removing ,   Paused , Exited , Dead }
	One of the discrete states that a Docker image can be in. More...
enum class	PullImageCondition { Never = 0 , IfMissing , Always }
	Conditions under which an operation should automatically pull the required image from the appropriate Docker registry. More...

Functions
record override string	ToString () => _value

Variables
record	ContainerFullId
	Represents a Docker container's full-length ID. More...
record	ContainerId
	Represents a Docker container's ID in either short form or long form. More...
record	ContainerName
	Represents a Docker container's name. More...

Enumeration Type Documentation

ContainerExitAction

enum DockerSdk.Containers.ContainerExitAction

strong

Lists actions that Docker can do automatically when a container exits.

Enumerator
None	Take no special action when the container exits.
Remove	Automatically remove the container when it exits.
Restart	Automatically restart the container whenever it exits.
RestartUnlessStopped	Automatically restart the container when it exits, unless it was specifically stopped.
RestartOnFailure	Automatically restart the container when it exits, but only if the exit code is non-zero. See also CreateContainerOptions.MaximumRetriesCount

ContainerStatus

enum DockerSdk.Containers.ContainerStatus

strong

One of the discrete states that a Docker image can be in.

Enumerator
Created	The container exists but has not been started.
Restarting	The container is resetting to run again.
Running	The container has live processes.
Removing	The container is being removed. At this point it is not running.
Paused	The container is paused. Its processes are not running, but can be resumed.
Exited	The container stopped gracefully and is being removed. This status can apply regardless of exit code.
Dead	The daemon shut down the container non-gracefully.

PullImageCondition

enum DockerSdk.Containers.PullImageCondition

strong

Conditions under which an operation should automatically pull the required image from the appropriate Docker registry.

Enumerator
Never	Do not pull the image. If the image does not exist, the operation fails.
IfMissing	Pull the image if it is not already present.
Always	Pull the image, even if it's already present. This is useful to get the newest image for a given tag, for example.

Variable Documentation

ContainerFullId

record DockerSdk.Containers.ContainerFullId

Represents a Docker container's full-length ID.

ContainerId

record DockerSdk.Containers.ContainerId

Represents a Docker container's ID in either short form or long form.

ContainerName

record DockerSdk.Containers.ContainerName

Represents a Docker container's name.

Container names are case-sensitive. The must be at least two characters long. The first character must be alphanumeric (ASCII character set), and subsequent characters may be alphanumeric, underscore, hyphen, or period.