Share via

ContainerGroup interface

  • Reference
Package:
@azure/arm-containerinstance

A container group.

Extends

Resource,ContainerGroupProperties

Inherited Properties

confidentialComputeProperties

The properties for confidential container group
containers

The containers within the container group.
diagnostics

The diagnostic information for a container group.
dnsConfig

The DNS config information for a container group.
encryptionProperties

The encryption properties for a container group.
extensions

extensions used by virtual kubelet
id

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.
identity

The identity of the container group, if configured.
imageRegistryCredentials

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

The init containers for a container group.
instanceView

The instance view of the container group. Only valid in response. NOTE: This property will not be serialized. It can only be populated by the server.
ipAddress

The IP address type of the container group.
location

The resource location.
name

The resource name. NOTE: This property will not be serialized. It can only be populated by the server.
osType

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

The priority of the container group.
provisioningState

The provisioning state of the container group. This only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.
restartPolicy

Restart policy for all containers within the container group.

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

The SKU for a container group.
subnetIds

The subnet resource IDs for a container group.
tags

The resource tags.
type

The resource type. NOTE: This property will not be serialized. It can only be populated by the server.
volumes

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

The zones for the container group.

Inherited Property Details

confidentialComputeProperties

The properties for confidential container group

confidentialComputeProperties?: ConfidentialComputeProperties

Property Value

ConfidentialComputeProperties

Inherited From ContainerGroupProperties.confidentialComputeProperties

containers

The containers within the container group.

containers: Container[]

Property Value

Container[]

Inherited From ContainerGroupProperties.containers

diagnostics

The diagnostic information for a container group.

diagnostics?: ContainerGroupDiagnostics

Property Value

ContainerGroupDiagnostics

Inherited From ContainerGroupProperties.diagnostics

dnsConfig

The DNS config information for a container group.

dnsConfig?: DnsConfiguration

Property Value

DnsConfiguration

Inherited From ContainerGroupProperties.dnsConfig

encryptionProperties

The encryption properties for a container group.

encryptionProperties?: EncryptionProperties

Property Value

EncryptionProperties

Inherited From ContainerGroupProperties.encryptionProperties

extensions

extensions used by virtual kubelet

extensions?: DeploymentExtensionSpec[]

Property Value

DeploymentExtensionSpec[]

Inherited From ContainerGroupProperties.extensions

id

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

identity

The identity of the container group, if configured.

identity?: ContainerGroupIdentity

Property Value

ContainerGroupIdentity

Inherited From ContainerGroupProperties.identity

imageRegistryCredentials

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

imageRegistryCredentials?: ImageRegistryCredential[]

Property Value

ImageRegistryCredential[]

Inherited From ContainerGroupProperties.imageRegistryCredentials

initContainers

The init containers for a container group.

initContainers?: InitContainerDefinition[]

Property Value

InitContainerDefinition[]

Inherited From ContainerGroupProperties.initContainers

instanceView

The instance view of the container group. Only valid in response. NOTE: This property will not be serialized. It can only be populated by the server.

instanceView?: ContainerGroupPropertiesInstanceView

Property Value

ContainerGroupPropertiesInstanceView

Inherited From ContainerGroupProperties.instanceView

ipAddress

The IP address type of the container group.

ipAddress?: IpAddress

Property Value

IpAddress

Inherited From ContainerGroupProperties.ipAddress

location

The resource location.

location?: string

Property Value

string

Inherited From Resource.location

name

The resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

osType

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

osType: string

Property Value

string

Inherited From ContainerGroupProperties.osType

priority

The priority of the container group.

priority?: string

Property Value

string

Inherited From ContainerGroupProperties.priority

provisioningState

The provisioning state of the container group. This only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

Inherited From ContainerGroupProperties.provisioningState

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

Inherited From ContainerGroupProperties.restartPolicy

sku

The SKU for a container group.

sku?: string

Property Value

string

Inherited From ContainerGroupProperties.sku

subnetIds

The subnet resource IDs for a container group.

subnetIds?: ContainerGroupSubnetId[]

Property Value

ContainerGroupSubnetId[]

Inherited From ContainerGroupProperties.subnetIds

tags

The resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

The resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type

volumes

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

volumes?: Volume[]

Property Value

Volume[]

Inherited From ContainerGroupProperties.volumes

zones

The zones for the container group.

zones?: string[]

Property Value

string[]

Inherited From Resource.zones