A container group definition that represents a scalable set of identical containers running as a distributed service
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| autostartPolicy | boolean | ✅ | Defines whether containers in this group should automatically start when deployed (true) or require manual starting (false) |
| container | Container | ✅ | Represents a container with its configuration and resource requirements. |
| countryCodes | CountryCode[] | ✅ | List of country codes where container instances are permitted to run. When not specified or empty, containers may run in any available region. |
| createTime | string | ✅ | ISO 8601 timestamp when this container group was initially created |
| currentState | ContainerGroupState | ✅ | Represents the operational state of a container group during its lifecycle, including timing information, status, and instance distribution metrics. This state captures the current execution status, start and finish times, and provides visibility into the operational health across instances. |
| displayName | string | ✅ | The display-friendly name of the resource. |
| id | string | ✅ | The container group identifier. |
| name | string | ✅ | The container group name. |
| organizationName | string | ✅ | The organization name. |
| pendingChange | boolean | ✅ | Indicates whether a configuration change has been requested but not yet applied to all containers in the group |
| priority | ContainerGroupPriority | ✅ | Specifies the priority level for container group execution, which determines resource allocation and scheduling precedence. |
| projectName | string | ✅ | The project name. |
| replicas | number | ✅ | The container group replicas. |
| restartPolicy | ContainerRestartPolicy | ✅ | Specifies the policy for restarting containers when they exit or fail. |
| updateTime | string | ✅ | ISO 8601 timestamp when this container group was last updated |
| version | number | ✅ | Incremental version number that increases with each configuration change to the container group |
| livenessProbe | ContainerGroupLivenessProbe | ❌ | Defines a liveness probe for container groups that determines when to restart a container if it becomes unhealthy |
| networking | ContainerGroupNetworkingConfiguration | ❌ | Network configuration for container groups that defines connectivity, routing, and access control settings |
| queueAutoscaler | QueueBasedAutoscalerConfiguration | ❌ | Defines configuration for automatically scaling container instances based on queue length. The autoscaler monitors a queue and adjusts the number of running replicas to maintain the desired queue length. |
| queueConnection | ContainerGroupQueueConnection | ❌ | Configuration for connecting a container group to a message queue system, enabling asynchronous communication between services. |
| readinessProbe | ContainerGroupReadinessProbe | ❌ | Defines how to check if a container is ready to serve traffic. The readiness probe determines whether the container's application is ready to accept traffic. If the readiness probe fails, the container is considered not ready and traffic will not be sent to it. |
| startupProbe | ContainerGroupStartupProbe | ❌ | Defines a probe that checks if a container application has started successfully. Startup probes help prevent applications from being prematurely marked as unhealthy during initialization. The probe can use HTTP requests, TCP connections, gRPC calls, or shell commands to determine startup status. |