ContainerGroup interface

A container group.

Extends

Properties

confidentialComputeProperties

The properties for confidential container group

containerGroupProfile

The reference container group profile properties.

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

identity

The identity of the container group, if configured.

identityAcls

The access control levels of the identities.

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.

ipAddress

The IP address type of the container group.

isCreatedFromStandbyPool

The flag to determine whether the container group is created from standby pool.

location

The resource location of the container group.

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.

restartPolicy

Restart policy for all containers within the container group.

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

The secret references that will be referenced within the container group.

sku

The SKU for a container group.

standbyPoolProfile

The reference standby pool profile properties.

subnetIds

The subnet resource IDs for a container group.

tags

The resource tags.

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

containerGroupProfile

The reference container group profile properties.

containerGroupProfile?: ContainerGroupProfileReferenceDefinition

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

dnsConfig

The DNS config information for a container group.

dnsConfig?: DnsConfiguration

Property Value

encryptionProperties

The encryption properties for a container group.

encryptionProperties?: EncryptionProperties

Property Value

extensions

extensions used by virtual kubelet

extensions?: DeploymentExtensionSpec[]

Property Value

identity

The identity of the container group, if configured.

identity?: ContainerGroupIdentity

Property Value

identityAcls

The access control levels of the identities.

identityAcls?: IdentityAcls

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

instanceView

The instance view of the container group. Only valid in response.

instanceView?: ContainerGroupPropertiesInstanceView

Property Value

ipAddress

The IP address type of the container group.

ipAddress?: IpAddress

Property Value

isCreatedFromStandbyPool

The flag to determine whether the container group is created from standby pool.

isCreatedFromStandbyPool?: boolean

Property Value

boolean

location

The resource location of the container group.

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

provisioningState

The provisioning state of the container group. This only appears in the response.

provisioningState?: string

Property Value

string

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

secretReferences

The secret references that will be referenced within the container group.

secretReferences?: SecretReference[]

Property Value

sku

The SKU for a container group.

sku?: string

Property Value

string

standbyPoolProfile

The reference standby pool profile properties.

standbyPoolProfile?: StandbyPoolProfileDefinition

Property Value

subnetIds

The subnet resource IDs for a container group.

subnetIds?: ContainerGroupSubnetId[]

Property Value

tags

The resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

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