Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The standbyContainerGroupPools resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.StandbyPool/standbyContainerGroupPools resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.StandbyPool/standbyContainerGroupPools@2025-03-01' = {
location: 'string'
name: 'string'
properties: {
containerGroupProperties: {
containerGroupProfile: {
id: 'string'
revision: int
}
subnetIds: [
{
id: 'string'
}
]
}
elasticityProfile: {
maxReadyCapacity: int
refillPolicy: 'string'
}
zones: [
'string'
]
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.StandbyPool/standbyContainerGroupPools
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9-]{3,24}$ (required) |
| properties | The resource-specific properties for this resource. | StandbyContainerGroupPoolResourceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ContainerGroupProfile
| Name | Description | Value |
|---|---|---|
| id | Specifies container group profile id of standby container groups. | string (required) |
| revision | Specifies revision of container group profile. | int |
ContainerGroupProperties
| Name | Description | Value |
|---|---|---|
| containerGroupProfile | Specifies container group profile of standby container groups. | ContainerGroupProfile (required) |
| subnetIds | Specifies subnet Ids for container group. | Subnet[] |
StandbyContainerGroupPoolElasticityProfile
| Name | Description | Value |
|---|---|---|
| maxReadyCapacity | Specifies maximum number of standby container groups in the standby pool. | int Constraints: Min value = 0 Max value = 2000 (required) |
| refillPolicy | Specifies refill policy of the pool. | 'always' |
StandbyContainerGroupPoolResourceProperties
| Name | Description | Value |
|---|---|---|
| containerGroupProperties | Specifies container group properties of standby container group pools. | ContainerGroupProperties (required) |
| elasticityProfile | Specifies elasticity profile of standby container group pools. | StandbyContainerGroupPoolElasticityProfile (required) |
| zones | Specifies zones of standby container group pools. | string[] |
Subnet
| Name | Description | Value |
|---|---|---|
| id | Specifies ARM resource id of the subnet. | string (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The standbyContainerGroupPools resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.StandbyPool/standbyContainerGroupPools resource, add the following JSON to your template.
{
"type": "Microsoft.StandbyPool/standbyContainerGroupPools",
"apiVersion": "2025-03-01",
"name": "string",
"location": "string",
"properties": {
"containerGroupProperties": {
"containerGroupProfile": {
"id": "string",
"revision": "int"
},
"subnetIds": [
{
"id": "string"
}
]
},
"elasticityProfile": {
"maxReadyCapacity": "int",
"refillPolicy": "string"
},
"zones": [ "string" ]
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.StandbyPool/standbyContainerGroupPools
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-03-01' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9-]{3,24}$ (required) |
| properties | The resource-specific properties for this resource. | StandbyContainerGroupPoolResourceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.StandbyPool/standbyContainerGroupPools' |
ContainerGroupProfile
| Name | Description | Value |
|---|---|---|
| id | Specifies container group profile id of standby container groups. | string (required) |
| revision | Specifies revision of container group profile. | int |
ContainerGroupProperties
| Name | Description | Value |
|---|---|---|
| containerGroupProfile | Specifies container group profile of standby container groups. | ContainerGroupProfile (required) |
| subnetIds | Specifies subnet Ids for container group. | Subnet[] |
StandbyContainerGroupPoolElasticityProfile
| Name | Description | Value |
|---|---|---|
| maxReadyCapacity | Specifies maximum number of standby container groups in the standby pool. | int Constraints: Min value = 0 Max value = 2000 (required) |
| refillPolicy | Specifies refill policy of the pool. | 'always' |
StandbyContainerGroupPoolResourceProperties
| Name | Description | Value |
|---|---|---|
| containerGroupProperties | Specifies container group properties of standby container group pools. | ContainerGroupProperties (required) |
| elasticityProfile | Specifies elasticity profile of standby container group pools. | StandbyContainerGroupPoolElasticityProfile (required) |
| zones | Specifies zones of standby container group pools. | string[] |
Subnet
| Name | Description | Value |
|---|---|---|
| id | Specifies ARM resource id of the subnet. | string (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The standbyContainerGroupPools resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.StandbyPool/standbyContainerGroupPools resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.StandbyPool/standbyContainerGroupPools@2025-03-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
containerGroupProperties = {
containerGroupProfile = {
id = "string"
revision = int
}
subnetIds = [
{
id = "string"
}
]
}
elasticityProfile = {
maxReadyCapacity = int
refillPolicy = "string"
}
zones = [
"string"
]
}
}
}
Property Values
Microsoft.StandbyPool/standbyContainerGroupPools
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9-]{3,24}$ (required) |
| properties | The resource-specific properties for this resource. | StandbyContainerGroupPoolResourceProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.StandbyPool/standbyContainerGroupPools@2025-03-01" |
ContainerGroupProfile
| Name | Description | Value |
|---|---|---|
| id | Specifies container group profile id of standby container groups. | string (required) |
| revision | Specifies revision of container group profile. | int |
ContainerGroupProperties
| Name | Description | Value |
|---|---|---|
| containerGroupProfile | Specifies container group profile of standby container groups. | ContainerGroupProfile (required) |
| subnetIds | Specifies subnet Ids for container group. | Subnet[] |
StandbyContainerGroupPoolElasticityProfile
| Name | Description | Value |
|---|---|---|
| maxReadyCapacity | Specifies maximum number of standby container groups in the standby pool. | int Constraints: Min value = 0 Max value = 2000 (required) |
| refillPolicy | Specifies refill policy of the pool. | 'always' |
StandbyContainerGroupPoolResourceProperties
| Name | Description | Value |
|---|---|---|
| containerGroupProperties | Specifies container group properties of standby container group pools. | ContainerGroupProperties (required) |
| elasticityProfile | Specifies elasticity profile of standby container group pools. | StandbyContainerGroupPoolElasticityProfile (required) |
| zones | Specifies zones of standby container group pools. | string[] |
Subnet
| Name | Description | Value |
|---|---|---|
| id | Specifies ARM resource id of the subnet. | string (required) |
TrackedResourceTags
| Name | Description | Value |
|---|