ContainerGroup class

Definition

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.

ContainerGroup(*, containers, os_type, location: str = None, tags=None, identity=None, image_registry_credentials=None, restart_policy=None, ip_address=None, volumes=None, diagnostics=None, network_profile=None, dns_config=None, **kwargs) -> None
Inheritance
ContainerGroup

Parameters

location
str

The resource location.

tags
dict[str or str]

The resource tags.

identity
ContainerGroupIdentity

The identity of the container group, if configured.

containers
list[Container]

Required. The containers within the container group.

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 . Possible values include: 'Always', 'OnFailure', 'Never'
ip_address
IpAddress

The IP address type of the container group.

os_type
str or OperatingSystemTypes

Required. The operating system type required by the containers in the container group. Possible values include: 'Windows', 'Linux'

volumes
list[Volume]

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

diagnostics
ContainerGroupDiagnostics

The diagnostic information for a container group.

network_profile
ContainerGroupNetworkProfile

The network profile information for a container group.

dns_config
DnsConfiguration

The DNS config information for a container group.

Variables

id
str
The resource id.
name
str
The resource name.
type
str
The resource type.
provisioning_state
str
The provisioning state of the container group. This only appears in the response.
instance_view
ContainerGroupPropertiesInstanceView
The instance view of the container group. Only valid in response.