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 hcpOpenShiftClusters/nodePools 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.RedHatOpenShift/hcpOpenShiftClusters/nodePools resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.RedHatOpenShift/hcpOpenShiftClusters/nodePools@2026-09-01-preview' = {
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
autoRepair: bool
autoScaling: {
max: int
min: int
}
labels: [
{
key: 'string'
value: 'string'
}
]
nodeDrainTimeoutMinutes: int
platform: {
availabilityZone: 'string'
enableEncryptionAtHost: bool
osDisk: {
diskStorageAccountType: 'string'
diskType: 'string'
encryptionSetId: 'string'
sizeGiB: int
}
subnetId: 'string'
vmSize: 'string'
}
replicas: int
taints: [
{
effect: 'string'
key: 'string'
value: 'string'
}
]
version: {
channelGroup: 'string'
id: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.RedHatOpenShift/hcpOpenShiftClusters/nodePools
| Name | Description | Value |
|---|---|---|
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z]([-a-zA-Z0-9]{0,13}[a-zA-Z0-9])?$ (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: hcpOpenShiftClusters |
| properties | The resource-specific properties for this resource. | NodePoolProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
Label
| Name | Description | Value |
|---|---|---|
| key | The key of the label | string (required) |
| value | The value of the label | string |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
NodePoolAutoScaling
| Name | Description | Value |
|---|---|---|
| max | The maximum number of nodes in the node pool. Validation: - Minimum: 0 (must be >= min) - Maximum: 200 (only when availabilityZone is not specified) - No maximum when availabilityZone is specified |
int Constraints: Min value = 0 |
| min | The minimum number of nodes in the node pool. Validation: - Minimum: 0 - Maximum: 200 (only when availabilityZone is not specified) - No maximum when availabilityZone is specified |
int Constraints: Min value = 0 |
NodePoolPlatformProfile
| Name | Description | Value |
|---|---|---|
| availabilityZone | The availability zone for the node pool. Please read the documentation to see which regions support availability zones - /azure/availability-zones/az-overview |
string |
| enableEncryptionAtHost | Whether to enable host based OS and data drive encryption. - /azure/virtual-machines/disk-encryption#encryption-at-host---end-to-end-encryption-for-your-vm-data |
bool |
| osDisk | The settings and configuration options for OSDisk | OsDiskProfile |
| subnetId | The Azure resource ID of the worker subnet Note that a subnet cannot be reused between ARO-HCP Clusters, however the same subnet can be used for NodePools of the same cluster. |
string |
| vmSize | The VM size according to the documentation: - /azure/virtual-machines/sizes |
string (required) |
NodePoolProperties
| Name | Description | Value |
|---|---|---|
| autoRepair | Auto-repair | bool |
| autoScaling | Representation of a autoscaling in a node pool. | NodePoolAutoScaling |
| labels | Kubernetes labels to propagate to the NodePool Nodes Note that when the labels are updated this is only applied to newly create nodes in the Nodepool, existing node labels remain unchanged. |
Label[] |
| nodeDrainTimeoutMinutes | nodeDrainTimeoutMinutes is the grace period for how long Pod Disruption Budget-protected workloads will be respected during any node draining operation. After this grace period, any workloads protected by Pod Disruption Budgets that have not been successfully drained from a node will be forcibly evicted. This is especially relevant to cluster upgrades. Valid values are from 0 to 10080 minutes (1 week) . 0 means that the NodePool can be drained without any time limitation. If unset the cluster nodeDrainTimeoutMinutes value is used as a default. |
int |
| platform | Azure node pool platform configuration | NodePoolPlatformProfile (required) |
| replicas | The number of worker nodes, it cannot be used together with autoscaling. Validation: - Minimum: 0 - Maximum: 200 (only when availabilityZone is not specified) - No maximum when availabilityZone is specified |
int Constraints: Min value = 0 |
| taints | Taints for the nodes | Taint[] |
| version | OpenShift version for the nodepool | NodePoolVersionProfile |
NodePoolVersionProfile
| Name | Description | Value |
|---|---|---|
| channelGroup | ChannelGroup is the name of the set to which this version belongs. Each version belongs to only a single set. If not specified, the default value is 'stable'. |
string |
| id | ID is the unique identifier of the version. | string (required) |
OsDiskProfile
| Name | Description | Value |
|---|---|---|
| diskStorageAccountType | The type of the disk storage account - /azure/virtual-machines/disks-types |
'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' |
| diskType | The type of the OS disk. - /azure/virtual-machines/ephemeral-os-disks |
'Ephemeral' 'Managed' |
| encryptionSetId | The ID of the DiskEncryptionSet resource to use to encrypt the OS disks for the VMs. This needs to exist in the same subscription id listed in the Hosted Cluster, HostedCluster.Spec.Platform.Azure.SubscriptionID. DiskEncryptionSetID should also exist in a resource group under the same subscription id and the same location listed in the Hosted Cluster, HostedCluster.Spec.Platform.Azure.Location. Details on how to create a Disk Encryption Set can be found here: /azure/virtual-machines/disks-enable-customer-managed-keys-portal#set-up-your-disk-encryption-set |
string |
| sizeGiB | The OS disk size in GiB. Maximum is 4095 GiB for Managed disks. For Ephemeral disks, the maximum is 2040 GiB; Azure may enforce a lower effective limit based on the selected VM size's local cache, temp, or NVMe capacity. |
int Constraints: Min value = 64 Max value = 4095 |
Taint
| Name | Description | Value |
|---|---|---|
| effect | The effect of the taint | 'NoExecute' 'NoSchedule' 'PreferNoSchedule' (required) |
| key | The key of the taint | string Constraints: Min length = 1 Max length = 316 (required) |
| value | The value of the taint | string Constraints: Max length = 63 |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
ARM template resource definition
The hcpOpenShiftClusters/nodePools 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.
Usage Examples
Resource format
To create a Microsoft.RedHatOpenShift/hcpOpenShiftClusters/nodePools resource, add the following JSON to your template.
{
"type": "Microsoft.RedHatOpenShift/hcpOpenShiftClusters/nodePools",
"apiVersion": "2026-09-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"autoRepair": "bool",
"autoScaling": {
"max": "int",
"min": "int"
},
"labels": [
{
"key": "string",
"value": "string"
}
],
"nodeDrainTimeoutMinutes": "int",
"platform": {
"availabilityZone": "string",
"enableEncryptionAtHost": "bool",
"osDisk": {
"diskStorageAccountType": "string",
"diskType": "string",
"encryptionSetId": "string",
"sizeGiB": "int"
},
"subnetId": "string",
"vmSize": "string"
},
"replicas": "int",
"taints": [
{
"effect": "string",
"key": "string",
"value": "string"
}
],
"version": {
"channelGroup": "string",
"id": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.RedHatOpenShift/hcpOpenShiftClusters/nodePools
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-09-01-preview' |
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z]([-a-zA-Z0-9]{0,13}[a-zA-Z0-9])?$ (required) |
| properties | The resource-specific properties for this resource. | NodePoolProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.RedHatOpenShift/hcpOpenShiftClusters/nodePools' |
Label
| Name | Description | Value |
|---|---|---|
| key | The key of the label | string (required) |
| value | The value of the label | string |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
NodePoolAutoScaling
| Name | Description | Value |
|---|---|---|
| max | The maximum number of nodes in the node pool. Validation: - Minimum: 0 (must be >= min) - Maximum: 200 (only when availabilityZone is not specified) - No maximum when availabilityZone is specified |
int Constraints: Min value = 0 |
| min | The minimum number of nodes in the node pool. Validation: - Minimum: 0 - Maximum: 200 (only when availabilityZone is not specified) - No maximum when availabilityZone is specified |
int Constraints: Min value = 0 |
NodePoolPlatformProfile
| Name | Description | Value |
|---|---|---|
| availabilityZone | The availability zone for the node pool. Please read the documentation to see which regions support availability zones - /azure/availability-zones/az-overview |
string |
| enableEncryptionAtHost | Whether to enable host based OS and data drive encryption. - /azure/virtual-machines/disk-encryption#encryption-at-host---end-to-end-encryption-for-your-vm-data |
bool |
| osDisk | The settings and configuration options for OSDisk | OsDiskProfile |
| subnetId | The Azure resource ID of the worker subnet Note that a subnet cannot be reused between ARO-HCP Clusters, however the same subnet can be used for NodePools of the same cluster. |
string |
| vmSize | The VM size according to the documentation: - /azure/virtual-machines/sizes |
string (required) |
NodePoolProperties
| Name | Description | Value |
|---|---|---|
| autoRepair | Auto-repair | bool |
| autoScaling | Representation of a autoscaling in a node pool. | NodePoolAutoScaling |
| labels | Kubernetes labels to propagate to the NodePool Nodes Note that when the labels are updated this is only applied to newly create nodes in the Nodepool, existing node labels remain unchanged. |
Label[] |
| nodeDrainTimeoutMinutes | nodeDrainTimeoutMinutes is the grace period for how long Pod Disruption Budget-protected workloads will be respected during any node draining operation. After this grace period, any workloads protected by Pod Disruption Budgets that have not been successfully drained from a node will be forcibly evicted. This is especially relevant to cluster upgrades. Valid values are from 0 to 10080 minutes (1 week) . 0 means that the NodePool can be drained without any time limitation. If unset the cluster nodeDrainTimeoutMinutes value is used as a default. |
int |
| platform | Azure node pool platform configuration | NodePoolPlatformProfile (required) |
| replicas | The number of worker nodes, it cannot be used together with autoscaling. Validation: - Minimum: 0 - Maximum: 200 (only when availabilityZone is not specified) - No maximum when availabilityZone is specified |
int Constraints: Min value = 0 |
| taints | Taints for the nodes | Taint[] |
| version | OpenShift version for the nodepool | NodePoolVersionProfile |
NodePoolVersionProfile
| Name | Description | Value |
|---|---|---|
| channelGroup | ChannelGroup is the name of the set to which this version belongs. Each version belongs to only a single set. If not specified, the default value is 'stable'. |
string |
| id | ID is the unique identifier of the version. | string (required) |
OsDiskProfile
| Name | Description | Value |
|---|---|---|
| diskStorageAccountType | The type of the disk storage account - /azure/virtual-machines/disks-types |
'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' |
| diskType | The type of the OS disk. - /azure/virtual-machines/ephemeral-os-disks |
'Ephemeral' 'Managed' |
| encryptionSetId | The ID of the DiskEncryptionSet resource to use to encrypt the OS disks for the VMs. This needs to exist in the same subscription id listed in the Hosted Cluster, HostedCluster.Spec.Platform.Azure.SubscriptionID. DiskEncryptionSetID should also exist in a resource group under the same subscription id and the same location listed in the Hosted Cluster, HostedCluster.Spec.Platform.Azure.Location. Details on how to create a Disk Encryption Set can be found here: /azure/virtual-machines/disks-enable-customer-managed-keys-portal#set-up-your-disk-encryption-set |
string |
| sizeGiB | The OS disk size in GiB. Maximum is 4095 GiB for Managed disks. For Ephemeral disks, the maximum is 2040 GiB; Azure may enforce a lower effective limit based on the selected VM size's local cache, temp, or NVMe capacity. |
int Constraints: Min value = 64 Max value = 4095 |
Taint
| Name | Description | Value |
|---|---|---|
| effect | The effect of the taint | 'NoExecute' 'NoSchedule' 'PreferNoSchedule' (required) |
| key | The key of the taint | string Constraints: Min length = 1 Max length = 316 (required) |
| value | The value of the taint | string Constraints: Max length = 63 |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Terraform (AzAPI provider) resource definition
The hcpOpenShiftClusters/nodePools 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.RedHatOpenShift/hcpOpenShiftClusters/nodePools resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.RedHatOpenShift/hcpOpenShiftClusters/nodePools@2026-09-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
autoRepair = bool
autoScaling = {
max = int
min = int
}
labels = [
{
key = "string"
value = "string"
}
]
nodeDrainTimeoutMinutes = int
platform = {
availabilityZone = "string"
enableEncryptionAtHost = bool
osDisk = {
diskStorageAccountType = "string"
diskType = "string"
encryptionSetId = "string"
sizeGiB = int
}
subnetId = "string"
vmSize = "string"
}
replicas = int
taints = [
{
effect = "string"
key = "string"
value = "string"
}
]
version = {
channelGroup = "string"
id = "string"
}
}
}
}
Property Values
Microsoft.RedHatOpenShift/hcpOpenShiftClusters/nodePools
| Name | Description | Value |
|---|---|---|
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z]([-a-zA-Z0-9]{0,13}[a-zA-Z0-9])?$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: hcpOpenShiftClusters |
| properties | The resource-specific properties for this resource. | NodePoolProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.RedHatOpenShift/hcpOpenShiftClusters/nodePools@2026-09-01-preview" |
Label
| Name | Description | Value |
|---|---|---|
| key | The key of the label | string (required) |
| value | The value of the label | string |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
NodePoolAutoScaling
| Name | Description | Value |
|---|---|---|
| max | The maximum number of nodes in the node pool. Validation: - Minimum: 0 (must be >= min) - Maximum: 200 (only when availabilityZone is not specified) - No maximum when availabilityZone is specified |
int Constraints: Min value = 0 |
| min | The minimum number of nodes in the node pool. Validation: - Minimum: 0 - Maximum: 200 (only when availabilityZone is not specified) - No maximum when availabilityZone is specified |
int Constraints: Min value = 0 |
NodePoolPlatformProfile
| Name | Description | Value |
|---|---|---|
| availabilityZone | The availability zone for the node pool. Please read the documentation to see which regions support availability zones - /azure/availability-zones/az-overview |
string |
| enableEncryptionAtHost | Whether to enable host based OS and data drive encryption. - /azure/virtual-machines/disk-encryption#encryption-at-host---end-to-end-encryption-for-your-vm-data |
bool |
| osDisk | The settings and configuration options for OSDisk | OsDiskProfile |
| subnetId | The Azure resource ID of the worker subnet Note that a subnet cannot be reused between ARO-HCP Clusters, however the same subnet can be used for NodePools of the same cluster. |
string |
| vmSize | The VM size according to the documentation: - /azure/virtual-machines/sizes |
string (required) |
NodePoolProperties
| Name | Description | Value |
|---|---|---|
| autoRepair | Auto-repair | bool |
| autoScaling | Representation of a autoscaling in a node pool. | NodePoolAutoScaling |
| labels | Kubernetes labels to propagate to the NodePool Nodes Note that when the labels are updated this is only applied to newly create nodes in the Nodepool, existing node labels remain unchanged. |
Label[] |
| nodeDrainTimeoutMinutes | nodeDrainTimeoutMinutes is the grace period for how long Pod Disruption Budget-protected workloads will be respected during any node draining operation. After this grace period, any workloads protected by Pod Disruption Budgets that have not been successfully drained from a node will be forcibly evicted. This is especially relevant to cluster upgrades. Valid values are from 0 to 10080 minutes (1 week) . 0 means that the NodePool can be drained without any time limitation. If unset the cluster nodeDrainTimeoutMinutes value is used as a default. |
int |
| platform | Azure node pool platform configuration | NodePoolPlatformProfile (required) |
| replicas | The number of worker nodes, it cannot be used together with autoscaling. Validation: - Minimum: 0 - Maximum: 200 (only when availabilityZone is not specified) - No maximum when availabilityZone is specified |
int Constraints: Min value = 0 |
| taints | Taints for the nodes | Taint[] |
| version | OpenShift version for the nodepool | NodePoolVersionProfile |
NodePoolVersionProfile
| Name | Description | Value |
|---|---|---|
| channelGroup | ChannelGroup is the name of the set to which this version belongs. Each version belongs to only a single set. If not specified, the default value is 'stable'. |
string |
| id | ID is the unique identifier of the version. | string (required) |
OsDiskProfile
| Name | Description | Value |
|---|---|---|
| diskStorageAccountType | The type of the disk storage account - /azure/virtual-machines/disks-types |
'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' |
| diskType | The type of the OS disk. - /azure/virtual-machines/ephemeral-os-disks |
'Ephemeral' 'Managed' |
| encryptionSetId | The ID of the DiskEncryptionSet resource to use to encrypt the OS disks for the VMs. This needs to exist in the same subscription id listed in the Hosted Cluster, HostedCluster.Spec.Platform.Azure.SubscriptionID. DiskEncryptionSetID should also exist in a resource group under the same subscription id and the same location listed in the Hosted Cluster, HostedCluster.Spec.Platform.Azure.Location. Details on how to create a Disk Encryption Set can be found here: /azure/virtual-machines/disks-enable-customer-managed-keys-portal#set-up-your-disk-encryption-set |
string |
| sizeGiB | The OS disk size in GiB. Maximum is 4095 GiB for Managed disks. For Ephemeral disks, the maximum is 2040 GiB; Azure may enforce a lower effective limit based on the selected VM size's local cache, temp, or NVMe capacity. |
int Constraints: Min value = 64 Max value = 4095 |
Taint
| Name | Description | Value |
|---|---|---|
| effect | The effect of the taint | 'NoExecute' 'NoSchedule' 'PreferNoSchedule' (required) |
| key | The key of the taint | string Constraints: Min length = 1 Max length = 316 (required) |
| value | The value of the taint | string Constraints: Max length = 63 |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|