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 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 resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.RedHatOpenShift/hcpOpenShiftClusters@2026-09-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
api: {
authorizedCidrs: [
'string'
]
visibility: 'string'
}
autoscaling: {
maxNodeProvisionTimeSeconds: int
maxNodesTotal: int
maxPodGracePeriodSeconds: int
podPriorityThreshold: int
}
clusterImageRegistry: {
state: 'string'
}
cryptoRestrictions: 'string'
dns: {
baseDomainPrefix: 'string'
}
etcd: {
dataEncryption: {
customerManaged: {
encryptionType: 'string'
kms: {
activeKey: {
name: 'string'
version: 'string'
}
vaultName: 'string'
visibility: 'string'
}
}
keyManagementMode: 'string'
}
}
imageDigestMirrors: [
{
mirrors: [
'string'
]
source: 'string'
}
]
ingress: {
type: 'string'
}
network: {
hostPrefix: int
machineCidr: 'string'
networkType: 'string'
podCidr: 'string'
serviceCidr: 'string'
}
nodeDrainTimeoutMinutes: int
platform: {
managedResourceGroup: 'string'
networkSecurityGroupId: 'string'
operatorsAuthentication: {
userAssignedIdentities: {
controlPlaneOperators: {
{customized property}: 'string'
}
dataPlaneOperators: {
{customized property}: 'string'
}
serviceManagedIdentity: 'string'
}
}
outboundType: 'string'
subnetId: 'string'
vnetIntegrationSubnetId: 'string'
}
version: {
channelGroup: 'string'
id: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.RedHatOpenShift/hcpOpenShiftClusters
| 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,52}[a-zA-Z0-9])?$ (required) |
| properties | The resource-specific properties for this resource. | HcpOpenShiftClusterProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ApiProfile
| Name | Description | Value |
|---|---|---|
| authorizedCidrs | The list of authorized IPv4 CIDR blocks allowed to access the API server. Maximum 500 entries. | string[] |
| visibility | The internet visibility of the OpenShift API server | 'Private' 'Public' |
ClusterAutoscalingProfile
| Name | Description | Value |
|---|---|---|
| maxNodeProvisionTimeSeconds | maxNodeProvisionTimeSeconds is the maximum time to wait for node provisioning before considering the provisioning to be unsuccessful. The default is 900 seconds, or 15 minutes. |
int Constraints: Min value = 0 |
| maxNodesTotal | maxNodesTotal is the maximum allowable number of nodes for the Autoscaler scale out to be operational. The autoscaler will not grow the cluster beyond this number. If omitted, the autoscaler will not have a maximum limit. |
int Constraints: Min value = 0 |
| maxPodGracePeriodSeconds | maxPodGracePeriod is the maximum seconds to wait for graceful pod termination before scaling down a NodePool. The default is 600 seconds. |
int Constraints: Min value = 0 |
| podPriorityThreshold | podPriorityThreshold enables users to schedule "best-effort" pods, which shouldn't trigger autoscaler actions, but only run when there are spare resources available. The default is -10. See the following for more details: https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#how-does-cluster-autoscaler-work-with-pod-priority-and-preemption |
int |
ClusterImageRegistryProfile
| Name | Description | Value |
|---|---|---|
| state | state indicates the desired ImageStream-backed cluster image registry installation mode. This can only be set during cluster creation and cannot be changed after cluster creation. Enabled means the ImageStream-backed image registry will be run as pods on worker nodes in the cluster. Disabled means the ImageStream-backed image registry will not be present in the cluster. The default is Enabled. |
'Disabled' 'Enabled' |
CustomerManagedEncryptionProfile
| Name | Description | Value |
|---|---|---|
| encryptionType | The encryption type used. By default, "KMS" is used. |
'KMS' |
| kms | The Key Management Service (KMS) encryption key details. Required when encryptionType is "KMS". |
KmsEncryptionProfile |
DnsProfile
| Name | Description | Value |
|---|---|---|
| baseDomainPrefix | BaseDomainPrefix is the unique name of the cluster representing the OpenShift's cluster name. BaseDomainPrefix is the name that will appear in the cluster's DNS, provisioned cloud providers resources |
string Constraints: Max length = 15 Pattern = ^[a-z]([-a-z0-9]*[a-z0-9])?$ |
EtcdDataEncryptionProfile
| Name | Description | Value |
|---|---|---|
| customerManaged | Specify customer managed encryption key details. Required when keyManagementMode is "CustomerManaged". |
CustomerManagedEncryptionProfile |
| keyManagementMode | Specify the key management strategy used for the encryption key that encrypts the ETCD data. | 'CustomerManaged' (required) |
EtcdProfile
| Name | Description | Value |
|---|---|---|
| dataEncryption | ETCD Data Encryption settings. If not specified platform managed keys are used. |
EtcdDataEncryptionProfile |
HcpOpenShiftClusterProperties
| Name | Description | Value |
|---|---|---|
| api | Shows the cluster API server profile | ApiProfile |
| autoscaling | Configure ClusterAutoscaling . | ClusterAutoscalingProfile |
| clusterImageRegistry | OpenShift internal image registry | ClusterImageRegistryProfile |
| cryptoRestrictions | Cryptographic restrictions for kernel and userspace libraries | 'FIPS' 'None' |
| dns | Cluster DNS configuration | DnsProfile |
| etcd | Configure ETCD. | EtcdProfile |
| imageDigestMirrors | imageDigestMirrors is a set of rules to allow pulling images from a mirrored registry by using digest specifications. WARNING: Updating this array will redeploy all node pools in the cluster. |
ImageDigestMirror[] |
| ingress | The cluster ingress configuration | IngressProfile |
| network | Cluster network configuration | NetworkProfile |
| 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 in minutes and from 0 to 10080 minutes (1 week). 0 means that the MachinePool can be drained without any time limitation. This is the value is used a default for all NodePools. It can be overridden by specifying nodeDrainTimeoutMinutes for a given NodePool |
int Constraints: Min value = 0 Max value = 10080 |
| platform | Azure platform configuration | PlatformProfile (required) |
| version | Version of the control plane components | VersionProfile (required) |
ImageDigestMirror
| Name | Description | Value |
|---|---|---|
| mirrors | mirrors is zero or more locations that may also contain the same images. No mirror will be configured if not specified. Images can be pulled from these mirrors only if they are referenced by their digests. The mirrored location is obtained by replacing the part of the input reference that matches source by the mirrors entry, e.g. for registry.redhat.io/product/repo reference, a (source, mirror) pair .redhat.io, mirror.local/redhat causes a mirror.local/redhat/product/repo repository to be used. The order of mirrors in this list is treated as the user's desired priority, while source is by default considered lower priority than all mirrors. If no mirror is specified or all image pulls from the mirror list fail, the image will continue to be pulled from the repository in the pull spec. Other cluster configuration, including (but not limited to) other imageDigestMirrors objects, may impact the exact order mirrors are contacted in, or some mirrors may be contacted in parallel, so this should be considered a preference rather than a guarantee of ordering. mirrors uses one of the following formats: host[:port] * host[:port]/namespace[/namespace...] * host[:port]/namespace[/namespace...]/repo for more information about the format, see: https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md#choosing-a-registry-toml-table |
string Constraints: Max length = 255[] (required) |
| source | source matches the repository that users refer to, e.g. in image pull specifications. Setting source to a registry hostname, e.g. docker.io, quay.io, or registry.redhat.io, will match the image pull specification of the corresponding registry. source uses one of the following formats: * host[:port] * host[:port]/namespace[/namespace...] * host[:port]/namespace[/namespace...]/repo * [*.]host for more information about the format, see: https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md#choosing-a-registry-toml-table |
string Constraints: Max length = 255 (required) |
IngressProfile
| Name | Description | Value |
|---|---|---|
| type | The type of the default cluster ingress. | 'Disabled' 'Private' 'Public' |
KmsEncryptionProfile
| Name | Description | Value |
|---|---|---|
| activeKey | The details of the active key. | KmsKey (required) |
| vaultName | vaultName is the name of the keyvault that contains the secret. | string Constraints: Min length = 1 Max length = 255 (required) |
| visibility | visibility of the keyvault that contains the secret. | 'Private' 'Public' (required) |
KmsKey
| Name | Description | Value |
|---|---|---|
| name | name is the name of the keyvault key used for encryption/decryption. | string Constraints: Min length = 1 Max length = 255 (required) |
| version | version contains the version of the key to use. | string Constraints: Min length = 1 Max length = 255 (required) |
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 |
|---|
NetworkProfile
| Name | Description | Value |
|---|---|---|
| hostPrefix | Network host prefix | int |
| machineCidr | The CIDR block from which to assign machine IP addresses | string |
| networkType | The main controller responsible for rendering the core networking components | 'Other' 'OVNKubernetes' |
| podCidr | The CIDR of the pod IP addresses | string |
| serviceCidr | The CIDR block for assigned service IPs | string |
OperatorsAuthenticationProfile
| Name | Description | Value |
|---|---|---|
| userAssignedIdentities | Represents the information related to Azure User-Assigned managed identities needed to perform Operators authentication based on Azure User-Assigned Managed Identities |
UserAssignedIdentitiesProfile (required) |
PlatformProfile
| Name | Description | Value |
|---|---|---|
| managedResourceGroup | Resource group name to put cluster resources If not specified then a unique name is generated from the following pattern "aro-hcp-" + clusterName + "-" + UUID where clusterName means the hcpOpenShiftClusters resource name (up to 45 characters) followed by a 16-byte universally unique identifier per RFC 4122. |
string |
| networkSecurityGroupId | ResourceId for the NSG (network security group) attached to the cluster subnet Note that NSGs cannot be reused for other ARO-HCP clusters. |
string (required) |
| operatorsAuthentication | The configuration that the operators of the cluster have to authenticate to Azure | OperatorsAuthenticationProfile (required) |
| outboundType | The core outgoing configuration | 'LoadBalancer' |
| subnetId | The Azure resource ID of the worker subnet Note that a subnet cannot be reused between ARO-HCP Clusters. |
string (required) |
| vnetIntegrationSubnetId | The Azure resource ID of a subnet that enables direct, private network connectivity between the hosted control plane and your cluster's nodes. This subnet must be dedicated to ARO HCP and cannot be shared with the cluster subnet or any node pool subnets. |
string (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentitiesProfile
| Name | Description | Value |
|---|---|---|
| controlPlaneOperators | The set of Azure User-Assigned Managed Identities leveraged for the Control Plane operators of the cluster. The set of required managed identities is dependent on the Cluster's OpenShift version. |
UserAssignedIdentitiesProfileControlPlaneOperators (required) |
| dataPlaneOperators | The set of Azure User-Assigned Managed Identities leveraged for the Data Plane operators of the cluster. The set of required managed identities is dependent on the Cluster's OpenShift version. |
UserAssignedIdentitiesProfileDataPlaneOperators (required) |
| serviceManagedIdentity | Represents the information associated to an Azure User-Assigned Managed Identity whose purpose is to perform service level actions. |
string (required) |
UserAssignedIdentitiesProfileControlPlaneOperators
| Name | Description | Value |
|---|
UserAssignedIdentitiesProfileDataPlaneOperators
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
VersionProfile
| 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 desired X.Y version of the cluster control plane. | string (required) |
ARM template resource definition
The hcpOpenShiftClusters 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 resource, add the following JSON to your template.
{
"type": "Microsoft.RedHatOpenShift/hcpOpenShiftClusters",
"apiVersion": "2026-09-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"api": {
"authorizedCidrs": [ "string" ],
"visibility": "string"
},
"autoscaling": {
"maxNodeProvisionTimeSeconds": "int",
"maxNodesTotal": "int",
"maxPodGracePeriodSeconds": "int",
"podPriorityThreshold": "int"
},
"clusterImageRegistry": {
"state": "string"
},
"cryptoRestrictions": "string",
"dns": {
"baseDomainPrefix": "string"
},
"etcd": {
"dataEncryption": {
"customerManaged": {
"encryptionType": "string",
"kms": {
"activeKey": {
"name": "string",
"version": "string"
},
"vaultName": "string",
"visibility": "string"
}
},
"keyManagementMode": "string"
}
},
"imageDigestMirrors": [
{
"mirrors": [ "string" ],
"source": "string"
}
],
"ingress": {
"type": "string"
},
"network": {
"hostPrefix": "int",
"machineCidr": "string",
"networkType": "string",
"podCidr": "string",
"serviceCidr": "string"
},
"nodeDrainTimeoutMinutes": "int",
"platform": {
"managedResourceGroup": "string",
"networkSecurityGroupId": "string",
"operatorsAuthentication": {
"userAssignedIdentities": {
"controlPlaneOperators": {
"{customized property}": "string"
},
"dataPlaneOperators": {
"{customized property}": "string"
},
"serviceManagedIdentity": "string"
}
},
"outboundType": "string",
"subnetId": "string",
"vnetIntegrationSubnetId": "string"
},
"version": {
"channelGroup": "string",
"id": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.RedHatOpenShift/hcpOpenShiftClusters
| 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,52}[a-zA-Z0-9])?$ (required) |
| properties | The resource-specific properties for this resource. | HcpOpenShiftClusterProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.RedHatOpenShift/hcpOpenShiftClusters' |
ApiProfile
| Name | Description | Value |
|---|---|---|
| authorizedCidrs | The list of authorized IPv4 CIDR blocks allowed to access the API server. Maximum 500 entries. | string[] |
| visibility | The internet visibility of the OpenShift API server | 'Private' 'Public' |
ClusterAutoscalingProfile
| Name | Description | Value |
|---|---|---|
| maxNodeProvisionTimeSeconds | maxNodeProvisionTimeSeconds is the maximum time to wait for node provisioning before considering the provisioning to be unsuccessful. The default is 900 seconds, or 15 minutes. |
int Constraints: Min value = 0 |
| maxNodesTotal | maxNodesTotal is the maximum allowable number of nodes for the Autoscaler scale out to be operational. The autoscaler will not grow the cluster beyond this number. If omitted, the autoscaler will not have a maximum limit. |
int Constraints: Min value = 0 |
| maxPodGracePeriodSeconds | maxPodGracePeriod is the maximum seconds to wait for graceful pod termination before scaling down a NodePool. The default is 600 seconds. |
int Constraints: Min value = 0 |
| podPriorityThreshold | podPriorityThreshold enables users to schedule "best-effort" pods, which shouldn't trigger autoscaler actions, but only run when there are spare resources available. The default is -10. See the following for more details: https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#how-does-cluster-autoscaler-work-with-pod-priority-and-preemption |
int |
ClusterImageRegistryProfile
| Name | Description | Value |
|---|---|---|
| state | state indicates the desired ImageStream-backed cluster image registry installation mode. This can only be set during cluster creation and cannot be changed after cluster creation. Enabled means the ImageStream-backed image registry will be run as pods on worker nodes in the cluster. Disabled means the ImageStream-backed image registry will not be present in the cluster. The default is Enabled. |
'Disabled' 'Enabled' |
CustomerManagedEncryptionProfile
| Name | Description | Value |
|---|---|---|
| encryptionType | The encryption type used. By default, "KMS" is used. |
'KMS' |
| kms | The Key Management Service (KMS) encryption key details. Required when encryptionType is "KMS". |
KmsEncryptionProfile |
DnsProfile
| Name | Description | Value |
|---|---|---|
| baseDomainPrefix | BaseDomainPrefix is the unique name of the cluster representing the OpenShift's cluster name. BaseDomainPrefix is the name that will appear in the cluster's DNS, provisioned cloud providers resources |
string Constraints: Max length = 15 Pattern = ^[a-z]([-a-z0-9]*[a-z0-9])?$ |
EtcdDataEncryptionProfile
| Name | Description | Value |
|---|---|---|
| customerManaged | Specify customer managed encryption key details. Required when keyManagementMode is "CustomerManaged". |
CustomerManagedEncryptionProfile |
| keyManagementMode | Specify the key management strategy used for the encryption key that encrypts the ETCD data. | 'CustomerManaged' (required) |
EtcdProfile
| Name | Description | Value |
|---|---|---|
| dataEncryption | ETCD Data Encryption settings. If not specified platform managed keys are used. |
EtcdDataEncryptionProfile |
HcpOpenShiftClusterProperties
| Name | Description | Value |
|---|---|---|
| api | Shows the cluster API server profile | ApiProfile |
| autoscaling | Configure ClusterAutoscaling . | ClusterAutoscalingProfile |
| clusterImageRegistry | OpenShift internal image registry | ClusterImageRegistryProfile |
| cryptoRestrictions | Cryptographic restrictions for kernel and userspace libraries | 'FIPS' 'None' |
| dns | Cluster DNS configuration | DnsProfile |
| etcd | Configure ETCD. | EtcdProfile |
| imageDigestMirrors | imageDigestMirrors is a set of rules to allow pulling images from a mirrored registry by using digest specifications. WARNING: Updating this array will redeploy all node pools in the cluster. |
ImageDigestMirror[] |
| ingress | The cluster ingress configuration | IngressProfile |
| network | Cluster network configuration | NetworkProfile |
| 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 in minutes and from 0 to 10080 minutes (1 week). 0 means that the MachinePool can be drained without any time limitation. This is the value is used a default for all NodePools. It can be overridden by specifying nodeDrainTimeoutMinutes for a given NodePool |
int Constraints: Min value = 0 Max value = 10080 |
| platform | Azure platform configuration | PlatformProfile (required) |
| version | Version of the control plane components | VersionProfile (required) |
ImageDigestMirror
| Name | Description | Value |
|---|---|---|
| mirrors | mirrors is zero or more locations that may also contain the same images. No mirror will be configured if not specified. Images can be pulled from these mirrors only if they are referenced by their digests. The mirrored location is obtained by replacing the part of the input reference that matches source by the mirrors entry, e.g. for registry.redhat.io/product/repo reference, a (source, mirror) pair .redhat.io, mirror.local/redhat causes a mirror.local/redhat/product/repo repository to be used. The order of mirrors in this list is treated as the user's desired priority, while source is by default considered lower priority than all mirrors. If no mirror is specified or all image pulls from the mirror list fail, the image will continue to be pulled from the repository in the pull spec. Other cluster configuration, including (but not limited to) other imageDigestMirrors objects, may impact the exact order mirrors are contacted in, or some mirrors may be contacted in parallel, so this should be considered a preference rather than a guarantee of ordering. mirrors uses one of the following formats: host[:port] * host[:port]/namespace[/namespace...] * host[:port]/namespace[/namespace...]/repo for more information about the format, see: https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md#choosing-a-registry-toml-table |
string Constraints: Max length = 255[] (required) |
| source | source matches the repository that users refer to, e.g. in image pull specifications. Setting source to a registry hostname, e.g. docker.io, quay.io, or registry.redhat.io, will match the image pull specification of the corresponding registry. source uses one of the following formats: * host[:port] * host[:port]/namespace[/namespace...] * host[:port]/namespace[/namespace...]/repo * [*.]host for more information about the format, see: https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md#choosing-a-registry-toml-table |
string Constraints: Max length = 255 (required) |
IngressProfile
| Name | Description | Value |
|---|---|---|
| type | The type of the default cluster ingress. | 'Disabled' 'Private' 'Public' |
KmsEncryptionProfile
| Name | Description | Value |
|---|---|---|
| activeKey | The details of the active key. | KmsKey (required) |
| vaultName | vaultName is the name of the keyvault that contains the secret. | string Constraints: Min length = 1 Max length = 255 (required) |
| visibility | visibility of the keyvault that contains the secret. | 'Private' 'Public' (required) |
KmsKey
| Name | Description | Value |
|---|---|---|
| name | name is the name of the keyvault key used for encryption/decryption. | string Constraints: Min length = 1 Max length = 255 (required) |
| version | version contains the version of the key to use. | string Constraints: Min length = 1 Max length = 255 (required) |
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 |
|---|
NetworkProfile
| Name | Description | Value |
|---|---|---|
| hostPrefix | Network host prefix | int |
| machineCidr | The CIDR block from which to assign machine IP addresses | string |
| networkType | The main controller responsible for rendering the core networking components | 'Other' 'OVNKubernetes' |
| podCidr | The CIDR of the pod IP addresses | string |
| serviceCidr | The CIDR block for assigned service IPs | string |
OperatorsAuthenticationProfile
| Name | Description | Value |
|---|---|---|
| userAssignedIdentities | Represents the information related to Azure User-Assigned managed identities needed to perform Operators authentication based on Azure User-Assigned Managed Identities |
UserAssignedIdentitiesProfile (required) |
PlatformProfile
| Name | Description | Value |
|---|---|---|
| managedResourceGroup | Resource group name to put cluster resources If not specified then a unique name is generated from the following pattern "aro-hcp-" + clusterName + "-" + UUID where clusterName means the hcpOpenShiftClusters resource name (up to 45 characters) followed by a 16-byte universally unique identifier per RFC 4122. |
string |
| networkSecurityGroupId | ResourceId for the NSG (network security group) attached to the cluster subnet Note that NSGs cannot be reused for other ARO-HCP clusters. |
string (required) |
| operatorsAuthentication | The configuration that the operators of the cluster have to authenticate to Azure | OperatorsAuthenticationProfile (required) |
| outboundType | The core outgoing configuration | 'LoadBalancer' |
| subnetId | The Azure resource ID of the worker subnet Note that a subnet cannot be reused between ARO-HCP Clusters. |
string (required) |
| vnetIntegrationSubnetId | The Azure resource ID of a subnet that enables direct, private network connectivity between the hosted control plane and your cluster's nodes. This subnet must be dedicated to ARO HCP and cannot be shared with the cluster subnet or any node pool subnets. |
string (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentitiesProfile
| Name | Description | Value |
|---|---|---|
| controlPlaneOperators | The set of Azure User-Assigned Managed Identities leveraged for the Control Plane operators of the cluster. The set of required managed identities is dependent on the Cluster's OpenShift version. |
UserAssignedIdentitiesProfileControlPlaneOperators (required) |
| dataPlaneOperators | The set of Azure User-Assigned Managed Identities leveraged for the Data Plane operators of the cluster. The set of required managed identities is dependent on the Cluster's OpenShift version. |
UserAssignedIdentitiesProfileDataPlaneOperators (required) |
| serviceManagedIdentity | Represents the information associated to an Azure User-Assigned Managed Identity whose purpose is to perform service level actions. |
string (required) |
UserAssignedIdentitiesProfileControlPlaneOperators
| Name | Description | Value |
|---|
UserAssignedIdentitiesProfileDataPlaneOperators
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
VersionProfile
| 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 desired X.Y version of the cluster control plane. | string (required) |
Terraform (AzAPI provider) resource definition
The hcpOpenShiftClusters 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 resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.RedHatOpenShift/hcpOpenShiftClusters@2026-09-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
api = {
authorizedCidrs = [
"string"
]
visibility = "string"
}
autoscaling = {
maxNodeProvisionTimeSeconds = int
maxNodesTotal = int
maxPodGracePeriodSeconds = int
podPriorityThreshold = int
}
clusterImageRegistry = {
state = "string"
}
cryptoRestrictions = "string"
dns = {
baseDomainPrefix = "string"
}
etcd = {
dataEncryption = {
customerManaged = {
encryptionType = "string"
kms = {
activeKey = {
name = "string"
version = "string"
}
vaultName = "string"
visibility = "string"
}
}
keyManagementMode = "string"
}
}
imageDigestMirrors = [
{
mirrors = [
"string"
]
source = "string"
}
]
ingress = {
type = "string"
}
network = {
hostPrefix = int
machineCidr = "string"
networkType = "string"
podCidr = "string"
serviceCidr = "string"
}
nodeDrainTimeoutMinutes = int
platform = {
managedResourceGroup = "string"
networkSecurityGroupId = "string"
operatorsAuthentication = {
userAssignedIdentities = {
controlPlaneOperators = {
{customized property} = "string"
}
dataPlaneOperators = {
{customized property} = "string"
}
serviceManagedIdentity = "string"
}
}
outboundType = "string"
subnetId = "string"
vnetIntegrationSubnetId = "string"
}
version = {
channelGroup = "string"
id = "string"
}
}
}
}
Property Values
Microsoft.RedHatOpenShift/hcpOpenShiftClusters
| 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,52}[a-zA-Z0-9])?$ (required) |
| properties | The resource-specific properties for this resource. | HcpOpenShiftClusterProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.RedHatOpenShift/hcpOpenShiftClusters@2026-09-01-preview" |
ApiProfile
| Name | Description | Value |
|---|---|---|
| authorizedCidrs | The list of authorized IPv4 CIDR blocks allowed to access the API server. Maximum 500 entries. | string[] |
| visibility | The internet visibility of the OpenShift API server | 'Private' 'Public' |
ClusterAutoscalingProfile
| Name | Description | Value |
|---|---|---|
| maxNodeProvisionTimeSeconds | maxNodeProvisionTimeSeconds is the maximum time to wait for node provisioning before considering the provisioning to be unsuccessful. The default is 900 seconds, or 15 minutes. |
int Constraints: Min value = 0 |
| maxNodesTotal | maxNodesTotal is the maximum allowable number of nodes for the Autoscaler scale out to be operational. The autoscaler will not grow the cluster beyond this number. If omitted, the autoscaler will not have a maximum limit. |
int Constraints: Min value = 0 |
| maxPodGracePeriodSeconds | maxPodGracePeriod is the maximum seconds to wait for graceful pod termination before scaling down a NodePool. The default is 600 seconds. |
int Constraints: Min value = 0 |
| podPriorityThreshold | podPriorityThreshold enables users to schedule "best-effort" pods, which shouldn't trigger autoscaler actions, but only run when there are spare resources available. The default is -10. See the following for more details: https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#how-does-cluster-autoscaler-work-with-pod-priority-and-preemption |
int |
ClusterImageRegistryProfile
| Name | Description | Value |
|---|---|---|
| state | state indicates the desired ImageStream-backed cluster image registry installation mode. This can only be set during cluster creation and cannot be changed after cluster creation. Enabled means the ImageStream-backed image registry will be run as pods on worker nodes in the cluster. Disabled means the ImageStream-backed image registry will not be present in the cluster. The default is Enabled. |
'Disabled' 'Enabled' |
CustomerManagedEncryptionProfile
| Name | Description | Value |
|---|---|---|
| encryptionType | The encryption type used. By default, "KMS" is used. |
'KMS' |
| kms | The Key Management Service (KMS) encryption key details. Required when encryptionType is "KMS". |
KmsEncryptionProfile |
DnsProfile
| Name | Description | Value |
|---|---|---|
| baseDomainPrefix | BaseDomainPrefix is the unique name of the cluster representing the OpenShift's cluster name. BaseDomainPrefix is the name that will appear in the cluster's DNS, provisioned cloud providers resources |
string Constraints: Max length = 15 Pattern = ^[a-z]([-a-z0-9]*[a-z0-9])?$ |
EtcdDataEncryptionProfile
| Name | Description | Value |
|---|---|---|
| customerManaged | Specify customer managed encryption key details. Required when keyManagementMode is "CustomerManaged". |
CustomerManagedEncryptionProfile |
| keyManagementMode | Specify the key management strategy used for the encryption key that encrypts the ETCD data. | 'CustomerManaged' (required) |
EtcdProfile
| Name | Description | Value |
|---|---|---|
| dataEncryption | ETCD Data Encryption settings. If not specified platform managed keys are used. |
EtcdDataEncryptionProfile |
HcpOpenShiftClusterProperties
| Name | Description | Value |
|---|---|---|
| api | Shows the cluster API server profile | ApiProfile |
| autoscaling | Configure ClusterAutoscaling . | ClusterAutoscalingProfile |
| clusterImageRegistry | OpenShift internal image registry | ClusterImageRegistryProfile |
| cryptoRestrictions | Cryptographic restrictions for kernel and userspace libraries | 'FIPS' 'None' |
| dns | Cluster DNS configuration | DnsProfile |
| etcd | Configure ETCD. | EtcdProfile |
| imageDigestMirrors | imageDigestMirrors is a set of rules to allow pulling images from a mirrored registry by using digest specifications. WARNING: Updating this array will redeploy all node pools in the cluster. |
ImageDigestMirror[] |
| ingress | The cluster ingress configuration | IngressProfile |
| network | Cluster network configuration | NetworkProfile |
| 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 in minutes and from 0 to 10080 minutes (1 week). 0 means that the MachinePool can be drained without any time limitation. This is the value is used a default for all NodePools. It can be overridden by specifying nodeDrainTimeoutMinutes for a given NodePool |
int Constraints: Min value = 0 Max value = 10080 |
| platform | Azure platform configuration | PlatformProfile (required) |
| version | Version of the control plane components | VersionProfile (required) |
ImageDigestMirror
| Name | Description | Value |
|---|---|---|
| mirrors | mirrors is zero or more locations that may also contain the same images. No mirror will be configured if not specified. Images can be pulled from these mirrors only if they are referenced by their digests. The mirrored location is obtained by replacing the part of the input reference that matches source by the mirrors entry, e.g. for registry.redhat.io/product/repo reference, a (source, mirror) pair .redhat.io, mirror.local/redhat causes a mirror.local/redhat/product/repo repository to be used. The order of mirrors in this list is treated as the user's desired priority, while source is by default considered lower priority than all mirrors. If no mirror is specified or all image pulls from the mirror list fail, the image will continue to be pulled from the repository in the pull spec. Other cluster configuration, including (but not limited to) other imageDigestMirrors objects, may impact the exact order mirrors are contacted in, or some mirrors may be contacted in parallel, so this should be considered a preference rather than a guarantee of ordering. mirrors uses one of the following formats: host[:port] * host[:port]/namespace[/namespace...] * host[:port]/namespace[/namespace...]/repo for more information about the format, see: https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md#choosing-a-registry-toml-table |
string Constraints: Max length = 255[] (required) |
| source | source matches the repository that users refer to, e.g. in image pull specifications. Setting source to a registry hostname, e.g. docker.io, quay.io, or registry.redhat.io, will match the image pull specification of the corresponding registry. source uses one of the following formats: * host[:port] * host[:port]/namespace[/namespace...] * host[:port]/namespace[/namespace...]/repo * [*.]host for more information about the format, see: https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md#choosing-a-registry-toml-table |
string Constraints: Max length = 255 (required) |
IngressProfile
| Name | Description | Value |
|---|---|---|
| type | The type of the default cluster ingress. | 'Disabled' 'Private' 'Public' |
KmsEncryptionProfile
| Name | Description | Value |
|---|---|---|
| activeKey | The details of the active key. | KmsKey (required) |
| vaultName | vaultName is the name of the keyvault that contains the secret. | string Constraints: Min length = 1 Max length = 255 (required) |
| visibility | visibility of the keyvault that contains the secret. | 'Private' 'Public' (required) |
KmsKey
| Name | Description | Value |
|---|---|---|
| name | name is the name of the keyvault key used for encryption/decryption. | string Constraints: Min length = 1 Max length = 255 (required) |
| version | version contains the version of the key to use. | string Constraints: Min length = 1 Max length = 255 (required) |
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 |
|---|
NetworkProfile
| Name | Description | Value |
|---|---|---|
| hostPrefix | Network host prefix | int |
| machineCidr | The CIDR block from which to assign machine IP addresses | string |
| networkType | The main controller responsible for rendering the core networking components | 'Other' 'OVNKubernetes' |
| podCidr | The CIDR of the pod IP addresses | string |
| serviceCidr | The CIDR block for assigned service IPs | string |
OperatorsAuthenticationProfile
| Name | Description | Value |
|---|---|---|
| userAssignedIdentities | Represents the information related to Azure User-Assigned managed identities needed to perform Operators authentication based on Azure User-Assigned Managed Identities |
UserAssignedIdentitiesProfile (required) |
PlatformProfile
| Name | Description | Value |
|---|---|---|
| managedResourceGroup | Resource group name to put cluster resources If not specified then a unique name is generated from the following pattern "aro-hcp-" + clusterName + "-" + UUID where clusterName means the hcpOpenShiftClusters resource name (up to 45 characters) followed by a 16-byte universally unique identifier per RFC 4122. |
string |
| networkSecurityGroupId | ResourceId for the NSG (network security group) attached to the cluster subnet Note that NSGs cannot be reused for other ARO-HCP clusters. |
string (required) |
| operatorsAuthentication | The configuration that the operators of the cluster have to authenticate to Azure | OperatorsAuthenticationProfile (required) |
| outboundType | The core outgoing configuration | 'LoadBalancer' |
| subnetId | The Azure resource ID of the worker subnet Note that a subnet cannot be reused between ARO-HCP Clusters. |
string (required) |
| vnetIntegrationSubnetId | The Azure resource ID of a subnet that enables direct, private network connectivity between the hosted control plane and your cluster's nodes. This subnet must be dedicated to ARO HCP and cannot be shared with the cluster subnet or any node pool subnets. |
string (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentitiesProfile
| Name | Description | Value |
|---|---|---|
| controlPlaneOperators | The set of Azure User-Assigned Managed Identities leveraged for the Control Plane operators of the cluster. The set of required managed identities is dependent on the Cluster's OpenShift version. |
UserAssignedIdentitiesProfileControlPlaneOperators (required) |
| dataPlaneOperators | The set of Azure User-Assigned Managed Identities leveraged for the Data Plane operators of the cluster. The set of required managed identities is dependent on the Cluster's OpenShift version. |
UserAssignedIdentitiesProfileDataPlaneOperators (required) |
| serviceManagedIdentity | Represents the information associated to an Azure User-Assigned Managed Identity whose purpose is to perform service level actions. |
string (required) |
UserAssignedIdentitiesProfileControlPlaneOperators
| Name | Description | Value |
|---|
UserAssignedIdentitiesProfileDataPlaneOperators
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
VersionProfile
| 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 desired X.Y version of the cluster control plane. | string (required) |