ContainerCodePackageProperties interface

Describes a container and its runtime properties.

Properties

commands

Command array to execute within the container in exec form.

diagnostics

Reference to sinks in DiagnosticsDescription.

endpoints

The endpoints exposed by this container.

entrypoint

Override for the default entry point in the container.

environmentVariables

The environment variables to set in this container

image

The Container image to use.

imageRegistryCredential

Image registry credential.

instanceView

Runtime information of a container instance. NOTE: This property will not be serialized. It can only be populated by the server.

labels

The labels to set in this container.

name

The name of the code package.

reliableCollectionsRefs

A list of ReliableCollection resources used by this particular code package. Please refer to ReliableCollectionsRef for more details.

resources

The resources required by this container.

settings

The settings to set in this container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\secrets". The path for Linux container is "/var/secrets".

volumeRefs

Volumes to be attached to the container. The lifetime of these volumes is independent of the application's lifetime.

volumes

Volumes to be attached to the container. The lifetime of these volumes is scoped to the application's lifetime.

Property Details

commands

Command array to execute within the container in exec form.

commands?: string[]

Property Value

string[]

diagnostics

Reference to sinks in DiagnosticsDescription.

diagnostics?: DiagnosticsRef

Property Value

endpoints

The endpoints exposed by this container.

endpoints?: EndpointProperties[]

Property Value

entrypoint

Override for the default entry point in the container.

entrypoint?: string

Property Value

string

environmentVariables

The environment variables to set in this container

environmentVariables?: EnvironmentVariable[]

Property Value

image

The Container image to use.

image: string

Property Value

string

imageRegistryCredential

Image registry credential.

imageRegistryCredential?: ImageRegistryCredential

Property Value

instanceView

Runtime information of a container instance. NOTE: This property will not be serialized. It can only be populated by the server.

instanceView?: ContainerInstanceView

Property Value

labels

The labels to set in this container.

labels?: ContainerLabel[]

Property Value

name

The name of the code package.

name: string

Property Value

string

reliableCollectionsRefs

A list of ReliableCollection resources used by this particular code package. Please refer to ReliableCollectionsRef for more details.

reliableCollectionsRefs?: ReliableCollectionsRef[]

Property Value

resources

The resources required by this container.

resources: ResourceRequirements

Property Value

settings

The settings to set in this container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\secrets". The path for Linux container is "/var/secrets".

settings?: Setting[]

Property Value

volumeRefs

Volumes to be attached to the container. The lifetime of these volumes is independent of the application's lifetime.

volumeRefs?: VolumeReference[]

Property Value

volumes

Volumes to be attached to the container. The lifetime of these volumes is scoped to the application's lifetime.

volumes?: ApplicationScopedVolume[]

Property Value