Show / Hide Table of Contents

Class ContainerSummary

Summary information about a container.

Inheritance
object
ContainerSummary
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 ContainerSummary

Properties

AvailabilityDomain

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

The availability domain where the container instance that hosts this container runs.

Remarks

Required

CompartmentId

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

The compartment OCID.

Remarks

Required

ContainerInstanceId

Declaration
[Required(ErrorMessage = "ContainerInstanceId is required.")]
[JsonProperty(PropertyName = "containerInstanceId")]
public string ContainerInstanceId { get; set; }
Property Value
Type Description
string

The OCID of the container instance on which the container is running.

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

FaultDomain

Declaration
[JsonProperty(PropertyName = "faultDomain")]
public string FaultDomain { get; set; }
Property Value
Type Description
string

The fault domain where the container instance that hosts the container runs.

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"}

Id

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

The OCID of the container.

Remarks

Required

ImageUrl

Declaration
[Required(ErrorMessage = "ImageUrl is required.")]
[JsonProperty(PropertyName = "imageUrl")]
public string ImageUrl { get; set; }
Property Value
Type Description
string

A URL identifying the image that the container runs in, such as docker.io/library/busybox:latest. If you do not provide a tag, the tag will default to latest.
If no registry is provided, will default the registry to public docker hub docker.io/library. The registry used for container image must be reachable over the Container Instance's VNIC.

Remarks

Required

IsResourcePrincipalDisabled

Declaration
[JsonProperty(PropertyName = "isResourcePrincipalDisabled")]
public bool? IsResourcePrincipalDisabled { get; set; }
Property Value
Type Description
bool?

Determines whether the container will have access to the container instance resource principal.
This method utilizes resource principal version 2.2. For information on how to use the exposed resource principal elements, see https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal.

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(StringEnumConverter))]
public Container.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
Container.LifecycleStateEnum?

The current state of the container.

Remarks

Required

ResourceConfig

Declaration
[JsonProperty(PropertyName = "resourceConfig")]
public ContainerResourceConfig ResourceConfig { get; set; }
Property Value
Type Description
ContainerResourceConfig

SecurityContext

Declaration
[JsonProperty(PropertyName = "securityContext")]
public SecurityContext SecurityContext { get; set; }
Property Value
Type Description
SecurityContext

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 the container 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 was updated in the format defined by RFC 3339.

In this article
Back to top