Skip to main content

Interface: ContainerCreateOptions

Properties​

AttachStderr?​

optional AttachStderr: boolean

Whether to attach to stderr (default false)

Source​

packages/extension-api/src/extension-api.d.ts:2435

AttachStdin?​

optional AttachStdin: boolean

Whether to attach to stdin (default false)

Source​

packages/extension-api/src/extension-api.d.ts:2425

AttachStdout?​

optional AttachStdout: boolean

Whether to attach to stdout(default false)

Source​

packages/extension-api/src/extension-api.d.ts:2430

Cmd?​

optional Cmd: string[]

Command to run specified as an array of strings

Source​

packages/extension-api/src/extension-api.d.ts:2413

Detach?​

optional Detach: boolean

Run the container in the background

Source​

packages/extension-api/src/extension-api.d.ts:2450

Entrypoint?​

optional Entrypoint: string | string[]

The entry point for the container as a string or an array of strings.

If the array consists of exactly one empty string ([""]) then the entry point is reset to system default (i.e., the entry point used by docker when there is no ENTRYPOINT instruction in the Containerfile).

Source​

packages/extension-api/src/extension-api.d.ts:2420

Env?​

optional Env: string[]

A list of environment variables to set inside the container in the form ["VAR=value", ...]. A variable without = is removed from the environment, rather than to have an empty value

Source​

packages/extension-api/src/extension-api.d.ts:2377

EnvFiles?​

optional EnvFiles: string[]

Environment files to use

Source​

packages/extension-api/src/extension-api.d.ts:2382

ExposedPorts?​

optional ExposedPorts: Object

An object mapping ports to an empty object in the form: {"<port>/<tcp|udp|sctp>": {}}

Index signature​

[port: string]: Object

Source​

packages/extension-api/src/extension-api.d.ts:2393

HealthCheck?​

optional HealthCheck: HealthConfig

A test to perform to check that the container is healthy.

Source​

packages/extension-api/src/extension-api.d.ts:2460

HostConfig?​

optional HostConfig: HostConfig

Container configuration that depends on the host we are running on

Source​

packages/extension-api/src/extension-api.d.ts:2398

Hostname?​

optional Hostname: string

The hostname to use for the container, as a valid RFC 1123 hostname

Source​

packages/extension-api/src/extension-api.d.ts:2367

Image?​

optional Image: string

The name (or reference) of the image to use when creating the container

Source​

packages/extension-api/src/extension-api.d.ts:2403

Labels?​

optional Labels: Object

User-defined key/value metadata

Index signature​

[label: string]: string

Source​

packages/extension-api/src/extension-api.d.ts:2387

OpenStdin?​

optional OpenStdin: boolean

Whether to open stdin (default false)

Source​

packages/extension-api/src/extension-api.d.ts:2440

StdinOnce?​

optional StdinOnce: boolean

Close stdin after one attached client disconnects (deafult false)

Source​

packages/extension-api/src/extension-api.d.ts:2445

Tty?​

optional Tty: boolean

Attach standard streams to a TTY, including stdin if it is not closed (default false)

Source​

packages/extension-api/src/extension-api.d.ts:2408

User?​

optional User: string

The user that commands are run as inside the container

Source​

packages/extension-api/src/extension-api.d.ts:2372

name?​

optional name: string

Assign the specified name to the container. Must match the regular expression/?[a-zA-Z0-9][a-zA-Z0-9_.-]+. If not speficied, the platform assigns a unique name to the container

Source​

packages/extension-api/src/extension-api.d.ts:2363

start?​

optional start: boolean

Start the container immediately (default true)

Source​

packages/extension-api/src/extension-api.d.ts:2455