ContainerGroupProfile interface

A container group profile object

Extends

Properties

confidentialComputeProperties

The properties for confidential container group

containers

The containers within the container group.

diagnostics

The diagnostic information for a container group.

encryptionProperties

The encryption properties for a container group.

extensions

extensions used by virtual kubelet

imageRegistryCredentials

The image registry credentials by which the container group is created from.

initContainers

The init containers for a container group.

ipAddress

The IP address type of the container group.

location

The geo-location where the resource lives

osType

The operating system type required by the containers in the container group.

priority

The priority of the container group.

registeredRevisions

Registered revisions are calculated at request time based off the records in the table logs.

restartPolicy

Restart policy for all containers within the container group.

  • Always Always restart
  • OnFailure Restart on failure
  • Never Never restart
revision

Container group profile current revision number

securityContext

The container security properties.

shutdownGracePeriod

Shutdown grace period for containers in a container group.

sku

The SKU for a container group.

tags

Resource tags.

timeToLive

Post completion time to live for containers of a CG

useKrypton

Gets or sets Krypton use property.

volumes

The list of volumes that can be mounted by containers in this container group.

zones

The availability zones.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

The name of the resource

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

confidentialComputeProperties

The properties for confidential container group

confidentialComputeProperties?: ConfidentialComputeProperties

Property Value

containers

The containers within the container group.

containers?: Container[]

Property Value

diagnostics

The diagnostic information for a container group.

diagnostics?: ContainerGroupDiagnostics

Property Value

encryptionProperties

The encryption properties for a container group.

encryptionProperties?: EncryptionProperties

Property Value

extensions

extensions used by virtual kubelet

extensions?: DeploymentExtensionSpec[]

Property Value

imageRegistryCredentials

The image registry credentials by which the container group is created from.

imageRegistryCredentials?: ImageRegistryCredential[]

Property Value

initContainers

The init containers for a container group.

initContainers?: InitContainerDefinition[]

Property Value

ipAddress

The IP address type of the container group.

ipAddress?: IpAddress

Property Value

location

The geo-location where the resource lives

location?: string

Property Value

string

osType

The operating system type required by the containers in the container group.

osType?: string

Property Value

string

priority

The priority of the container group.

priority?: string

Property Value

string

registeredRevisions

Registered revisions are calculated at request time based off the records in the table logs.

registeredRevisions?: number[]

Property Value

number[]

restartPolicy

Restart policy for all containers within the container group.

  • Always Always restart
  • OnFailure Restart on failure
  • Never Never restart
restartPolicy?: string

Property Value

string

revision

Container group profile current revision number

revision?: number

Property Value

number

securityContext

The container security properties.

securityContext?: SecurityContextDefinition

Property Value

shutdownGracePeriod

Shutdown grace period for containers in a container group.

shutdownGracePeriod?: Date

Property Value

Date

sku

The SKU for a container group.

sku?: string

Property Value

string

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

timeToLive

Post completion time to live for containers of a CG

timeToLive?: Date

Property Value

Date

useKrypton

Gets or sets Krypton use property.

useKrypton?: boolean

Property Value

boolean

volumes

The list of volumes that can be mounted by containers in this container group.

volumes?: Volume[]

Property Value

Volume[]

zones

The availability zones.

zones?: string[]

Property Value

string[]

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type