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 provisionedClusterInstances/agentPools resource type can be deployed with operations that target:
- Tenant - See tenant deployment commands* Management groups - See management group deployment commands* Subscription - See subscription deployment commands* 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.HybridContainerService/provisionedClusterInstances/agentPools resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.HybridContainerService/provisionedClusterInstances/agentPools@2026-04-01-preview' = {
parent: resourceSymbolicName
extendedLocation: {
name: 'string'
type: 'string'
}
name: 'string'
properties: {
count: int
enableAutoScaling: bool
gpuCountPerNode: int
maxCount: int
maxPods: int
minCount: int
nodeLabels: {
{customized property}: 'string'
}
nodeTaints: [
'string'
]
osSKU: 'string'
osType: 'string'
status: {
errorMessage: 'string'
readyReplicas: [
{
count: int
gpuCountPerNode: int
vmSize: 'string'
}
]
}
vmSize: 'string'
}
}
Property Values
Microsoft.HybridContainerService/provisionedClusterInstances/agentPools
| Name | Description | Value |
|---|---|---|
| extendedLocation | Extended location pointing to the underlying infrastructure | ExtendedLocation |
| name | The resource name | string Constraints: Min length = 3 Max length = 12 Pattern = ^[a-z][a-z0-9]{2,11}$ (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: provisionedClusterInstances |
| properties | The resource-specific properties for this resource. | AgentPoolProperties |
AgentPoolProperties
| Name | Description | Value |
|---|---|---|
| count | Number of nodes in the agent pool. The default value is 1. | int |
| enableAutoScaling | Whether to enable auto-scaler. Default value is false | bool |
| gpuCountPerNode | The number of gpus attached to a node. | int |
| maxCount | The maximum number of nodes for auto-scaling | int |
| maxPods | The maximum number of pods that can run on a node. | int |
| minCount | The minimum number of nodes for auto-scaling | int |
| nodeLabels | The node labels to be persisted across all nodes in agent pool. | AgentPoolPropertiesNodeLabels |
| nodeTaints | Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. | string[] |
| osSKU | Specifies the OS SKU used by the agent pool. The default is CBLMariner if OSType is Linux. The default is Windows2019 when OSType is Windows. | 'CBLMariner' 'Windows2019' 'Windows2022' |
| osType | The particular KubernetesVersion Image OS Type (Linux, Windows) | 'Linux' 'Windows' |
| status | The observed status of the agent pool. | AgentPoolProvisioningStatus |
| vmSize | The VM sku size of the agent pool node VMs. | string |
AgentPoolPropertiesNodeLabels
| Name | Description | Value |
|---|
AgentPoolProvisioningStatus
| Name | Description | Value |
|---|---|---|
| errorMessage | Error messages during an agent pool operation or steady state. | string |
| readyReplicas | The agent pools that are ready. | AgentPoolUpdateProfile[] |
AgentPoolUpdateProfile
| Name | Description | Value |
|---|---|---|
| count | Number of nodes in the agent pool. The default value is 1. | int |
| gpuCountPerNode | The number of gpus attached to a node. | int |
| vmSize | The VM sku size of the agent pool node VMs. | string |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | ARM Id of the extended location. | string |
| type | The extended location type. Allowed value: 'CustomLocation' | 'CustomLocation' |
ARM template resource definition
The provisionedClusterInstances/agentPools resource type can be deployed with operations that target:
- Tenant - See tenant deployment commands* Management groups - See management group deployment commands* Subscription - See subscription deployment commands* Resource groups - See resource group deployment commands For a list of changed properties in each API version, see change log.
Usage Examples
Resource format
To create a Microsoft.HybridContainerService/provisionedClusterInstances/agentPools resource, add the following JSON to your template.
{
"type": "Microsoft.HybridContainerService/provisionedClusterInstances/agentPools",
"apiVersion": "2026-04-01-preview",
"name": "string",
"extendedLocation": {
"name": "string",
"type": "string"
},
"properties": {
"count": "int",
"enableAutoScaling": "bool",
"gpuCountPerNode": "int",
"maxCount": "int",
"maxPods": "int",
"minCount": "int",
"nodeLabels": {
"{customized property}": "string"
},
"nodeTaints": [ "string" ],
"osSKU": "string",
"osType": "string",
"status": {
"errorMessage": "string",
"readyReplicas": [
{
"count": "int",
"gpuCountPerNode": "int",
"vmSize": "string"
}
]
},
"vmSize": "string"
}
}
Property Values
Microsoft.HybridContainerService/provisionedClusterInstances/agentPools
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-04-01-preview' |
| extendedLocation | Extended location pointing to the underlying infrastructure | ExtendedLocation |
| name | The resource name | string Constraints: Min length = 3 Max length = 12 Pattern = ^[a-z][a-z0-9]{2,11}$ (required) |
| properties | The resource-specific properties for this resource. | AgentPoolProperties |
| type | The resource type | 'Microsoft.HybridContainerService/provisionedClusterInstances/agentPools' |
AgentPoolProperties
| Name | Description | Value |
|---|---|---|
| count | Number of nodes in the agent pool. The default value is 1. | int |
| enableAutoScaling | Whether to enable auto-scaler. Default value is false | bool |
| gpuCountPerNode | The number of gpus attached to a node. | int |
| maxCount | The maximum number of nodes for auto-scaling | int |
| maxPods | The maximum number of pods that can run on a node. | int |
| minCount | The minimum number of nodes for auto-scaling | int |
| nodeLabels | The node labels to be persisted across all nodes in agent pool. | AgentPoolPropertiesNodeLabels |
| nodeTaints | Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. | string[] |
| osSKU | Specifies the OS SKU used by the agent pool. The default is CBLMariner if OSType is Linux. The default is Windows2019 when OSType is Windows. | 'CBLMariner' 'Windows2019' 'Windows2022' |
| osType | The particular KubernetesVersion Image OS Type (Linux, Windows) | 'Linux' 'Windows' |
| status | The observed status of the agent pool. | AgentPoolProvisioningStatus |
| vmSize | The VM sku size of the agent pool node VMs. | string |
AgentPoolPropertiesNodeLabels
| Name | Description | Value |
|---|
AgentPoolProvisioningStatus
| Name | Description | Value |
|---|---|---|
| errorMessage | Error messages during an agent pool operation or steady state. | string |
| readyReplicas | The agent pools that are ready. | AgentPoolUpdateProfile[] |
AgentPoolUpdateProfile
| Name | Description | Value |
|---|---|---|
| count | Number of nodes in the agent pool. The default value is 1. | int |
| gpuCountPerNode | The number of gpus attached to a node. | int |
| vmSize | The VM sku size of the agent pool node VMs. | string |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | ARM Id of the extended location. | string |
| type | The extended location type. Allowed value: 'CustomLocation' | 'CustomLocation' |
Terraform (AzAPI provider) resource definition
The provisionedClusterInstances/agentPools resource type can be deployed with operations that target:
- Tenant* Management groups* Subscription* Resource groups For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.HybridContainerService/provisionedClusterInstances/agentPools resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.HybridContainerService/provisionedClusterInstances/agentPools@2026-04-01-preview"
name = "string"
parent_id = "string"
body = {
extendedLocation = {
name = "string"
type = "string"
}
properties = {
count = int
enableAutoScaling = bool
gpuCountPerNode = int
maxCount = int
maxPods = int
minCount = int
nodeLabels = {
{customized property} = "string"
}
nodeTaints = [
"string"
]
osSKU = "string"
osType = "string"
status = {
errorMessage = "string"
readyReplicas = [
{
count = int
gpuCountPerNode = int
vmSize = "string"
}
]
}
vmSize = "string"
}
}
}
Property Values
Microsoft.HybridContainerService/provisionedClusterInstances/agentPools
| Name | Description | Value |
|---|---|---|
| extendedLocation | Extended location pointing to the underlying infrastructure | ExtendedLocation |
| name | The resource name | string Constraints: Min length = 3 Max length = 12 Pattern = ^[a-z][a-z0-9]{2,11}$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: provisionedClusterInstances |
| properties | The resource-specific properties for this resource. | AgentPoolProperties |
| type | The resource type | "Microsoft.HybridContainerService/provisionedClusterInstances/agentPools@2026-04-01-preview" |
AgentPoolProperties
| Name | Description | Value |
|---|---|---|
| count | Number of nodes in the agent pool. The default value is 1. | int |
| enableAutoScaling | Whether to enable auto-scaler. Default value is false | bool |
| gpuCountPerNode | The number of gpus attached to a node. | int |
| maxCount | The maximum number of nodes for auto-scaling | int |
| maxPods | The maximum number of pods that can run on a node. | int |
| minCount | The minimum number of nodes for auto-scaling | int |
| nodeLabels | The node labels to be persisted across all nodes in agent pool. | AgentPoolPropertiesNodeLabels |
| nodeTaints | Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. | string[] |
| osSKU | Specifies the OS SKU used by the agent pool. The default is CBLMariner if OSType is Linux. The default is Windows2019 when OSType is Windows. | 'CBLMariner' 'Windows2019' 'Windows2022' |
| osType | The particular KubernetesVersion Image OS Type (Linux, Windows) | 'Linux' 'Windows' |
| status | The observed status of the agent pool. | AgentPoolProvisioningStatus |
| vmSize | The VM sku size of the agent pool node VMs. | string |
AgentPoolPropertiesNodeLabels
| Name | Description | Value |
|---|
AgentPoolProvisioningStatus
| Name | Description | Value |
|---|---|---|
| errorMessage | Error messages during an agent pool operation or steady state. | string |
| readyReplicas | The agent pools that are ready. | AgentPoolUpdateProfile[] |
AgentPoolUpdateProfile
| Name | Description | Value |
|---|---|---|
| count | Number of nodes in the agent pool. The default value is 1. | int |
| gpuCountPerNode | The number of gpus attached to a node. | int |
| vmSize | The VM sku size of the agent pool node VMs. | string |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | ARM Id of the extended location. | string |
| type | The extended location type. Allowed value: 'CustomLocation' | 'CustomLocation' |