ContainerGroup Class

A container group.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Constructor

ContainerGroup(*, containers: List[_models.Container], os_type: str | _models.OperatingSystemTypes, identity: _models.ContainerGroupIdentity | None = None, image_registry_credentials: List[_models.ImageRegistryCredential] | None = None, restart_policy: str | _models.ContainerGroupRestartPolicy | None = None, ip_address: _models.IpAddress | None = None, volumes: List[_models.Volume] | None = None, diagnostics: _models.ContainerGroupDiagnostics | None = None, subnet_ids: List[_models.ContainerGroupSubnetId] | None = None, dns_config: _models.DnsConfiguration | None = None, sku: str | _models.ContainerGroupSku | None = None, encryption_properties: _models.EncryptionProperties | None = None, init_containers: List[_models.InitContainerDefinition] | None = None, extensions: List[_models.DeploymentExtensionSpec] | None = None, confidential_compute_properties: _models.ConfidentialComputeProperties | None = None, priority: str | _models.ContainerGroupPriority | None = None, location: str | None = None, tags: Dict[str, str] | None = None, zones: List[str] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
identity	ContainerGroupIdentity The identity of the container group, if configured. Default value: None
containers	list[Container] The containers within the container group. Required.
image_registry_credentials	list[ImageRegistryCredential] The image registry credentials by which the container group is created from. Default value: None
restart_policy	str or ContainerGroupRestartPolicy Restart policy for all containers within the container group. Always Always restart OnFailure Restart on failure Never Never restart. Known values are: "Always", "OnFailure", and "Never". Default value: None
ip_address	IpAddress The IP address type of the container group. Default value: None
os_type	str or OperatingSystemTypes The operating system type required by the containers in the container group. Required. Known values are: "Windows" and "Linux".
volumes	list[Volume] The list of volumes that can be mounted by containers in this container group. Default value: None
diagnostics	ContainerGroupDiagnostics The diagnostic information for a container group. Default value: None
subnet_ids	list[ContainerGroupSubnetId] The subnet resource IDs for a container group. Default value: None
dns_config	DnsConfiguration The DNS config information for a container group. Default value: None
sku	str or ContainerGroupSku The SKU for a container group. Known values are: "Standard", "Dedicated", and "Confidential". Default value: None
encryption_properties	EncryptionProperties The encryption properties for a container group. Default value: None
init_containers	list[InitContainerDefinition] The init containers for a container group. Default value: None
extensions	list[DeploymentExtensionSpec] extensions used by virtual kubelet. Default value: None
confidential_compute_properties	ConfidentialComputeProperties The properties for confidential container group. Default value: None
priority	str or ContainerGroupPriority The priority of the container group. Known values are: "Regular" and "Spot". Default value: None
location	str The resource location. Default value: None
tags	dict[str, str] The resource tags. Default value: None
zones	list[str] The zones for the container group. Default value: None

Variables

Name	Description
identity	ContainerGroupIdentity The identity of the container group, if configured.
provisioning_state	str The provisioning state of the container group. This only appears in the response.
containers	list[Container] The containers within the container group. Required.
image_registry_credentials	list[ImageRegistryCredential] The image registry credentials by which the container group is created from.
restart_policy	str or ContainerGroupRestartPolicy Restart policy for all containers within the container group. Always Always restart OnFailure Restart on failure Never Never restart. Known values are: "Always", "OnFailure", and "Never".
ip_address	IpAddress The IP address type of the container group.
os_type	str or OperatingSystemTypes The operating system type required by the containers in the container group. Required. Known values are: "Windows" and "Linux".
volumes	list[Volume] The list of volumes that can be mounted by containers in this container group.
instance_view	ContainerGroupPropertiesInstanceView The instance view of the container group. Only valid in response.
diagnostics	ContainerGroupDiagnostics The diagnostic information for a container group.
subnet_ids	list[ContainerGroupSubnetId] The subnet resource IDs for a container group.
dns_config	DnsConfiguration The DNS config information for a container group.
sku	str or ContainerGroupSku The SKU for a container group. Known values are: "Standard", "Dedicated", and "Confidential".
encryption_properties	EncryptionProperties The encryption properties for a container group.
init_containers	list[InitContainerDefinition] The init containers for a container group.
extensions	list[DeploymentExtensionSpec] extensions used by virtual kubelet.
confidential_compute_properties	ConfidentialComputeProperties The properties for confidential container group.
priority	str or ContainerGroupPriority The priority of the container group. Known values are: "Regular" and "Spot".
id	str The resource id.
name	str The resource name.
type	str The resource type.
location	str The resource location.
tags	dict[str, str] The resource tags.
zones	list[str] The zones for the container group.