Represents a request to create a container group, which manages a collection of container instances with shared configuration and scaling policies
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| autostartPolicy | boolean | ✅ | Determines whether the container group should start automatically when created (true) or remain stopped until manually started (false) |
| container | ContainerConfiguration | ✅ | Configuration for creating a container within a container group. Defines the container image, resource requirements, environment variables, and other settings needed to deploy and run the container. |
| name | string | ✅ | Unique identifier for the container group that must follow DNS naming conventions (lowercase alphanumeric with hyphens) |
| replicas | number | ✅ | Number of container instances to deploy and maintain for this container group |
| restartPolicy | ContainerRestartPolicy | ✅ | Specifies the policy for restarting containers when they exit or fail. |
| countryCodes | CountryCode[] | ❌ | List of countries nodes must be located in. Remove this field to permit nodes from any country. |
| displayName | string | ❌ | Human-readable name for the container group that can include spaces and special characters, used for display purposes |
| livenessProbe | ContainerGroupLivenessProbe | ❌ | Defines a liveness probe for container groups that determines when to restart a container if it becomes unhealthy |
| networking | CreateContainerGroupNetworking | ❌ | Network configuration for container groups specifying connectivity parameters, including authentication, protocol, and timeout 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. |