Class ContainerInstance

A container instance to host containers.
If you delete a container instance, the record remains visible for a short period of time before being permanently removed.

Inheritance

object

ContainerInstance

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ContainerinstancesService.Models

Assembly: OCI.DotNetSDK.Containerinstances.dll

Syntax

public class ContainerInstance

Properties

AvailabilityDomain

Declaration

[Required(ErrorMessage = "AvailabilityDomain is required.")]
[JsonProperty(PropertyName = "availabilityDomain")]
public string AvailabilityDomain { get; set; }

Property Value

Type	Description
string	The availability domain to place the container instance.

Remarks

Required

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment.

Remarks

Required

ContainerCount

Declaration

[Required(ErrorMessage = "ContainerCount is required.")]
[JsonProperty(PropertyName = "containerCount")]
public int? ContainerCount { get; set; }

Property Value

Type	Description
int?	The number of containers on the container instance.

Remarks

Required

ContainerRestartPolicy

Declaration

[Required(ErrorMessage = "ContainerRestartPolicy is required.")]
[JsonProperty(PropertyName = "containerRestartPolicy")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ContainerInstance.ContainerRestartPolicyEnum? ContainerRestartPolicy { get; set; }

Property Value

Type	Description
ContainerInstance.ContainerRestartPolicyEnum?	The container restart policy is applied for all containers in container instance.

Remarks

Required

Containers

Declaration

[Required(ErrorMessage = "Containers is required.")]
[JsonProperty(PropertyName = "containers")]
public List<ContainerInstanceContainer> Containers { get; set; }

Property Value

Type	Description
List<ContainerInstanceContainer>	The containers on the container instance.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}.

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Remarks

Required

DnsConfig

Declaration

[JsonProperty(PropertyName = "dnsConfig")]
public ContainerDnsConfig DnsConfig { get; set; }

Property Value

Type	Description
ContainerDnsConfig

FaultDomain

Declaration

[JsonProperty(PropertyName = "faultDomain")]
public string FaultDomain { get; set; }

Property Value

Type	Description
string	The fault domain to place the container instance.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

GracefulShutdownTimeoutInSeconds

Declaration

[JsonProperty(PropertyName = "gracefulShutdownTimeoutInSeconds")]
public long? GracefulShutdownTimeoutInSeconds { get; set; }

Property Value

Type	Description
long?	The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted.

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	An OCID that cannot be changed.

Remarks

Required

ImagePullSecrets

Declaration

[JsonProperty(PropertyName = "imagePullSecrets")]
public List<ImagePullSecret> ImagePullSecrets { get; set; }

Property Value

Type	Description
List<ImagePullSecret>	The image pulls secrets so you can access private registry to pull container images.

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	A message that describes the current state of the container in more detail. Can be used to provide actionable information.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ContainerInstance.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
ContainerInstance.LifecycleStateEnum?	The current state of the container instance.

Remarks

Required

Shape

Declaration

[Required(ErrorMessage = "Shape is required.")]
[JsonProperty(PropertyName = "shape")]
public string Shape { get; set; }

Property Value

Type	Description
string	The shape of the container instance. The shape determines the number of OCPUs, amount of memory, and other resources that are allocated to a container instance.

Remarks

Required

ShapeConfig

Declaration

[Required(ErrorMessage = "ShapeConfig is required.")]
[JsonProperty(PropertyName = "shapeConfig")]
public ContainerInstanceShapeConfig ShapeConfig { get; set; }

Property Value

Type	Description
ContainerInstanceShapeConfig

Remarks

Required

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}.

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The time the container instance was created, in the format defined by RFC 3339.

Remarks

Required

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The time the container instance was updated, in the format defined by RFC 3339.

Vnics

Declaration

[Required(ErrorMessage = "Vnics is required.")]
[JsonProperty(PropertyName = "vnics")]
public List<ContainerVnic> Vnics { get; set; }

Property Value

Type	Description
List<ContainerVnic>	The virtual networks available to the containers in the container instance.

Remarks

Required

VolumeCount

Declaration

[JsonProperty(PropertyName = "volumeCount")]
public int? VolumeCount { get; set; }

Property Value

Type	Description
int?	The number of volumes that are attached to the container instance.

Volumes

Declaration

[JsonProperty(PropertyName = "volumes")]
public List<ContainerVolume> Volumes { get; set; }

Property Value

Type	Description
List<ContainerVolume>	A volume is a directory with data that is accessible across multiple containers in a container instance.