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.
- Inheritance
-
azure.mgmt.containerinstance.models._models_py3.ResourceContainerGroupazure.mgmt.containerinstance.models._models_py3.ContainerGroupPropertiesContainerGroup
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
|
The identity of the container group, if configured. |
containers
|
The containers within the container group. Required. |
image_registry_credentials
|
The image registry credentials by which the container group is created from. |
restart_policy
|
Restart policy for all containers within the container group.
|
ip_address
|
The IP address type of the container group. |
os_type
|
The operating system type required by the containers in the container group. Required. Known values are: "Windows" and "Linux". |
volumes
|
The list of volumes that can be mounted by containers in this container group. |
diagnostics
|
The diagnostic information for a container group. |
subnet_ids
|
The subnet resource IDs for a container group. |
dns_config
|
The DNS config information for a container group. |
sku
|
The SKU for a container group. Known values are: "Standard", "Dedicated", and "Confidential". |
encryption_properties
|
The encryption properties for a container group. |
init_containers
|
The init containers for a container group. |
extensions
|
extensions used by virtual kubelet. |
confidential_compute_properties
|
The properties for confidential container group. |
priority
|
The priority of the container group. Known values are: "Regular" and "Spot". |
location
|
The resource location. |
tags
|
The resource tags. |
zones
|
The zones for the container group. |
Variables
Name | Description |
---|---|
identity
|
The identity of the container group, if configured. |
provisioning_state
|
The provisioning state of the container group. This only appears in the response. |
containers
|
The containers within the container group. Required. |
image_registry_credentials
|
The image registry credentials by which the container group is created from. |
restart_policy
|
Restart policy for all containers within the container group.
|
ip_address
|
The IP address type of the container group. |
os_type
|
The operating system type required by the containers in the container group. Required. Known values are: "Windows" and "Linux". |
volumes
|
The list of volumes that can be mounted by containers in this container group. |
instance_view
|
The instance view of the container group. Only valid in response. |
diagnostics
|
The diagnostic information for a container group. |
subnet_ids
|
The subnet resource IDs for a container group. |
dns_config
|
The DNS config information for a container group. |
sku
|
The SKU for a container group. Known values are: "Standard", "Dedicated", and "Confidential". |
encryption_properties
|
The encryption properties for a container group. |
init_containers
|
The init containers for a container group. |
extensions
|
extensions used by virtual kubelet. |
confidential_compute_properties
|
The properties for confidential container group. |
priority
|
The priority of the container group. Known values are: "Regular" and "Spot". |
id
|
The resource id. |
name
|
The resource name. |
type
|
The resource type. |
location
|
The resource location. |
tags
|
The resource tags. |
zones
|
The zones for the container group. |
Azure SDK for Python
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for