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 clusters/pools 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
Bicep Samples
Create a minimum provisioned HorizonDB pool.
@description('The name of the HorizonDB cluster')
param clusterName string = 'example-cluster'
@description('The name of the HorizonDB pool')
param poolName string = 'example-pool-01'
resource horizonDbResource 'Microsoft.HorizonDb/clusters/pools@2026-10-01-preview' = {
name: '${clusterName}/${poolName}'
properties: {
computeModel: {
type: 'Provisioned'
computeProcessor: 'AMD'
computeGeneration: 3
vCores: 2
}
parameterGroup: {
parameterGroupResourceId: '/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/parameterGroups/default-postgresql-17-provisioned'
applyMethod: 'Immediate'
}
scheduledMaintenance: {
maintenanceManagementType: 'System'
}
nodeCount: 1
highAvailability: {
mode: 'Disabled'
}
}
}
Update a single HorizonDB pool compute property.
@description('The name of the HorizonDB cluster')
param clusterName string = 'example-cluster'
@description('The name of the HorizonDB pool')
param poolName string = 'example-pool-01'
resource horizonDbResource 'Microsoft.HorizonDb/clusters/pools@2026-10-01-preview' = {
name: '${clusterName}/${poolName}'
properties: {
computeModel: {
vCores: 16
}
scheduledMaintenance: {
maintenanceManagementType: 'System'
}
}
}
Require zone-redundant placement for a HorizonDB pool.
@description('The name of the HorizonDB cluster')
param clusterName string = 'example-cluster'
@description('The name of the HorizonDB pool')
param poolName string = 'example-pool-01'
resource horizonDbResource 'Microsoft.HorizonDb/clusters/pools@2026-10-01-preview' = {
name: '${clusterName}/${poolName}'
properties: {
highAvailability: {
mode: 'ZoneRedundant'
}
}
}
Switch a HorizonDB pool back to its corresponding default parameter group.
@description('The name of the HorizonDB cluster')
param clusterName string = 'example-cluster'
@description('The name of the HorizonDB pool')
param poolName string = 'example-pool-01'
resource horizonDbResource 'Microsoft.HorizonDb/clusters/pools@2026-10-01-preview' = {
name: '${clusterName}/${poolName}'
properties: {
parameterGroup: {
parameterGroupResourceId: '/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/parameterGroups/default-postgresql-17-provisioned'
applyMethod: 'Immediate'
}
}
}
Associate a HorizonDB pool with a parameter group immediately.
@description('The name of the HorizonDB cluster')
param clusterName string = 'example-cluster'
@description('The name of the HorizonDB pool')
param poolName string = 'example-pool-01'
resource horizonDbResource 'Microsoft.HorizonDb/clusters/pools@2026-10-01-preview' = {
name: '${clusterName}/${poolName}'
properties: {
parameterGroup: {
parameterGroupResourceId: '/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/production-parameters'
applyMethod: 'Immediate'
}
}
}
Associate a HorizonDB pool with a parameter group pending reboot.
@description('The name of the HorizonDB cluster')
param clusterName string = 'example-cluster'
@description('The name of the HorizonDB pool')
param poolName string = 'example-pool-01'
resource horizonDbResource 'Microsoft.HorizonDb/clusters/pools@2026-10-01-preview' = {
name: '${clusterName}/${poolName}'
properties: {
parameterGroup: {
parameterGroupResourceId: '/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/maintenance-window-parameters'
applyMethod: 'PendingReboot'
}
}
}
Resource format
To create a Microsoft.HorizonDb/clusters/pools resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.HorizonDb/clusters/pools@2026-10-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
computeModel: {
computeGeneration: int
computeProcessor: 'string'
type: 'string'
vCores: int
}
highAvailability: {
mode: 'string'
}
nodeCount: int
parameterGroup: {
applyMethod: 'string'
parameterGroupResourceId: 'string'
}
scheduledMaintenance: {
maintenanceManagementType: 'string'
// For remaining properties, see ScheduledMaintenanceProperties objects
}
}
tags: {
{customized property}: 'string'
}
}
ScheduledMaintenanceProperties objects
Set the maintenanceManagementType property to specify the type of object.
For System, use:
{
maintenanceManagementType: 'System'
}
Property Values
Microsoft.HorizonDb/clusters/pools
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 1 Max length = 63 Pattern = ^[a-z0-9](?:[-a-z0-9]*[a-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: clusters |
| properties | The resource-specific properties for this resource. | PoolProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
PoolComputeModel
| Name | Description | Value |
|---|---|---|
| computeGeneration | The compute generation for the compute model. | int Constraints: Min value = 1 (required) |
| computeProcessor | The processor type for the compute model. | 'AMD' 'Intel' (required) |
| type | The type of compute model. | 'Provisioned' (required) |
| vCores | The number of vCores. Allowed values are 1 through 192. | int Constraints: Min value = 2 Max value = 192 (required) |
PoolHighAvailability
| Name | Description | Value |
|---|---|---|
| mode | The high-availability mode. Disabled is required when nodeCount is 1. AnyZone or ZoneRedundant is required when nodeCount is 2 through 16. | 'AnyZone' 'Disabled' 'ZoneRedundant' (required) |
PoolParameterGroupReference
| Name | Description | Value |
|---|---|---|
| applyMethod | Determines when dynamic parameter changes from the associated parameter group become effective. Static parameter changes always require a customer-initiated pool Restart, regardless of this value. Stop followed by Start and scheduled maintenance do not apply pending parameter changes. | 'Immediate' 'PendingReboot' (required) |
| parameterGroupResourceId | The Azure resource ID of the associated parameter group. Initial pool creation in this API version requires the corresponding Microsoft.HorizonDb/locations/parameterGroups resource. For an existing pool, PUT can specify either the corresponding default group or a customer-created Microsoft.HorizonDb/parameterGroups resource. | string (required) |
PoolProperties
| Name | Description | Value |
|---|---|---|
| computeModel | The required compute model for the HorizonDB pool. | PoolComputeModel (required) |
| highAvailability | The required high-availability configuration for the pool. mode must be Disabled when nodeCount is 1, and must be AnyZone or ZoneRedundant when nodeCount is 2 through 16. | PoolHighAvailability (required) |
| nodeCount | The required number of nodes to allocate and assign to the pool. Allowed values are 1 through 16. To deallocate runtime compute without changing the configured node count, stop the pool. | int Constraints: Min value = 1 Max value = 16 (required) |
| parameterGroup | The required parameter group associated with the pool. When creating a new pool in this API version, the caller must supply the corresponding default parameter group; customer-created parameter groups are not accepted during creation. For an existing pool, PUT or PATCH can associate either the corresponding default parameter group or a customer-created parameter group. The create-visible shape intentionally supports both resource ID forms so a future API version can allow customer-created parameter groups during creation without a breaking schema change. | PoolParameterGroupReference (required) |
| scheduledMaintenance | The scheduled maintenance configuration for the pool. The properties available depend on the selected maintenance management type. | ScheduledMaintenanceProperties |
PoolTags
| Name | Description | Value |
|---|
ScheduledMaintenanceProperties
| Name | Description | Value |
|---|---|---|
| maintenanceManagementType | Set to 'System' for type SystemScheduledMaintenanceProperties. | 'System' (required) |
SystemScheduledMaintenanceProperties
| Name | Description | Value |
|---|---|---|
| maintenanceManagementType | Specifies whether scheduled maintenance is managed by the system or by the user. | 'System' (required) |
ARM template resource definition
The clusters/pools 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
ARM Template Samples
Create a minimum provisioned HorizonDB pool.
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"clusterName": {
"type": "string",
"defaultValue": "example-cluster",
"metadata": {
"description": "The name of the HorizonDB cluster"
}
},
"poolName": {
"type": "string",
"defaultValue": "example-pool-01",
"metadata": {
"description": "The name of the HorizonDB pool"
}
}
},
"resources": [
{
"type": "Microsoft.HorizonDb/clusters/pools",
"apiVersion": "2026-10-01-preview",
"name": "[format('{0}/{1}', parameters('clusterName'), parameters('poolName'))]",
"properties": {
"computeModel": {
"type": "Provisioned",
"computeProcessor": "AMD",
"computeGeneration": 3,
"vCores": 2
},
"parameterGroup": {
"parameterGroupResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/parameterGroups/default-postgresql-17-provisioned",
"applyMethod": "Immediate"
},
"scheduledMaintenance": {
"maintenanceManagementType": "System"
},
"nodeCount": 1,
"highAvailability": {
"mode": "Disabled"
}
}
}
]
}
Update a single HorizonDB pool compute property.
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"clusterName": {
"type": "string",
"defaultValue": "example-cluster",
"metadata": {
"description": "The name of the HorizonDB cluster"
}
},
"poolName": {
"type": "string",
"defaultValue": "example-pool-01",
"metadata": {
"description": "The name of the HorizonDB pool"
}
}
},
"resources": [
{
"type": "Microsoft.HorizonDb/clusters/pools",
"apiVersion": "2026-10-01-preview",
"name": "[format('{0}/{1}', parameters('clusterName'), parameters('poolName'))]",
"properties": {
"computeModel": {
"vCores": 16
},
"scheduledMaintenance": {
"maintenanceManagementType": "System"
}
}
}
]
}
Require zone-redundant placement for a HorizonDB pool.
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"clusterName": {
"type": "string",
"defaultValue": "example-cluster",
"metadata": {
"description": "The name of the HorizonDB cluster"
}
},
"poolName": {
"type": "string",
"defaultValue": "example-pool-01",
"metadata": {
"description": "The name of the HorizonDB pool"
}
}
},
"resources": [
{
"type": "Microsoft.HorizonDb/clusters/pools",
"apiVersion": "2026-10-01-preview",
"name": "[format('{0}/{1}', parameters('clusterName'), parameters('poolName'))]",
"properties": {
"highAvailability": {
"mode": "ZoneRedundant"
}
}
}
]
}
Switch a HorizonDB pool back to its corresponding default parameter group.
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"clusterName": {
"type": "string",
"defaultValue": "example-cluster",
"metadata": {
"description": "The name of the HorizonDB cluster"
}
},
"poolName": {
"type": "string",
"defaultValue": "example-pool-01",
"metadata": {
"description": "The name of the HorizonDB pool"
}
}
},
"resources": [
{
"type": "Microsoft.HorizonDb/clusters/pools",
"apiVersion": "2026-10-01-preview",
"name": "[format('{0}/{1}', parameters('clusterName'), parameters('poolName'))]",
"properties": {
"parameterGroup": {
"parameterGroupResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/parameterGroups/default-postgresql-17-provisioned",
"applyMethod": "Immediate"
}
}
}
]
}
Associate a HorizonDB pool with a parameter group immediately.
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"clusterName": {
"type": "string",
"defaultValue": "example-cluster",
"metadata": {
"description": "The name of the HorizonDB cluster"
}
},
"poolName": {
"type": "string",
"defaultValue": "example-pool-01",
"metadata": {
"description": "The name of the HorizonDB pool"
}
}
},
"resources": [
{
"type": "Microsoft.HorizonDb/clusters/pools",
"apiVersion": "2026-10-01-preview",
"name": "[format('{0}/{1}', parameters('clusterName'), parameters('poolName'))]",
"properties": {
"parameterGroup": {
"parameterGroupResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/production-parameters",
"applyMethod": "Immediate"
}
}
}
]
}
Associate a HorizonDB pool with a parameter group pending reboot.
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"clusterName": {
"type": "string",
"defaultValue": "example-cluster",
"metadata": {
"description": "The name of the HorizonDB cluster"
}
},
"poolName": {
"type": "string",
"defaultValue": "example-pool-01",
"metadata": {
"description": "The name of the HorizonDB pool"
}
}
},
"resources": [
{
"type": "Microsoft.HorizonDb/clusters/pools",
"apiVersion": "2026-10-01-preview",
"name": "[format('{0}/{1}', parameters('clusterName'), parameters('poolName'))]",
"properties": {
"parameterGroup": {
"parameterGroupResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/maintenance-window-parameters",
"applyMethod": "PendingReboot"
}
}
}
]
}
Resource format
To create a Microsoft.HorizonDb/clusters/pools resource, add the following JSON to your template.
{
"type": "Microsoft.HorizonDb/clusters/pools",
"apiVersion": "2026-10-01-preview",
"name": "string",
"properties": {
"computeModel": {
"computeGeneration": "int",
"computeProcessor": "string",
"type": "string",
"vCores": "int"
},
"highAvailability": {
"mode": "string"
},
"nodeCount": "int",
"parameterGroup": {
"applyMethod": "string",
"parameterGroupResourceId": "string"
},
"scheduledMaintenance": {
"maintenanceManagementType": "string"
// For remaining properties, see ScheduledMaintenanceProperties objects
}
},
"tags": {
"{customized property}": "string"
}
}
ScheduledMaintenanceProperties objects
Set the maintenanceManagementType property to specify the type of object.
For System, use:
{
"maintenanceManagementType": "System"
}
Property Values
Microsoft.HorizonDb/clusters/pools
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-10-01-preview' |
| name | The resource name | string Constraints: Min length = 1 Max length = 63 Pattern = ^[a-z0-9](?:[-a-z0-9]*[a-z0-9])?$ (required) |
| properties | The resource-specific properties for this resource. | PoolProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.HorizonDb/clusters/pools' |
PoolComputeModel
| Name | Description | Value |
|---|---|---|
| computeGeneration | The compute generation for the compute model. | int Constraints: Min value = 1 (required) |
| computeProcessor | The processor type for the compute model. | 'AMD' 'Intel' (required) |
| type | The type of compute model. | 'Provisioned' (required) |
| vCores | The number of vCores. Allowed values are 1 through 192. | int Constraints: Min value = 2 Max value = 192 (required) |
PoolHighAvailability
| Name | Description | Value |
|---|---|---|
| mode | The high-availability mode. Disabled is required when nodeCount is 1. AnyZone or ZoneRedundant is required when nodeCount is 2 through 16. | 'AnyZone' 'Disabled' 'ZoneRedundant' (required) |
PoolParameterGroupReference
| Name | Description | Value |
|---|---|---|
| applyMethod | Determines when dynamic parameter changes from the associated parameter group become effective. Static parameter changes always require a customer-initiated pool Restart, regardless of this value. Stop followed by Start and scheduled maintenance do not apply pending parameter changes. | 'Immediate' 'PendingReboot' (required) |
| parameterGroupResourceId | The Azure resource ID of the associated parameter group. Initial pool creation in this API version requires the corresponding Microsoft.HorizonDb/locations/parameterGroups resource. For an existing pool, PUT can specify either the corresponding default group or a customer-created Microsoft.HorizonDb/parameterGroups resource. | string (required) |
PoolProperties
| Name | Description | Value |
|---|---|---|
| computeModel | The required compute model for the HorizonDB pool. | PoolComputeModel (required) |
| highAvailability | The required high-availability configuration for the pool. mode must be Disabled when nodeCount is 1, and must be AnyZone or ZoneRedundant when nodeCount is 2 through 16. | PoolHighAvailability (required) |
| nodeCount | The required number of nodes to allocate and assign to the pool. Allowed values are 1 through 16. To deallocate runtime compute without changing the configured node count, stop the pool. | int Constraints: Min value = 1 Max value = 16 (required) |
| parameterGroup | The required parameter group associated with the pool. When creating a new pool in this API version, the caller must supply the corresponding default parameter group; customer-created parameter groups are not accepted during creation. For an existing pool, PUT or PATCH can associate either the corresponding default parameter group or a customer-created parameter group. The create-visible shape intentionally supports both resource ID forms so a future API version can allow customer-created parameter groups during creation without a breaking schema change. | PoolParameterGroupReference (required) |
| scheduledMaintenance | The scheduled maintenance configuration for the pool. The properties available depend on the selected maintenance management type. | ScheduledMaintenanceProperties |
PoolTags
| Name | Description | Value |
|---|
ScheduledMaintenanceProperties
| Name | Description | Value |
|---|---|---|
| maintenanceManagementType | Set to 'System' for type SystemScheduledMaintenanceProperties. | 'System' (required) |
SystemScheduledMaintenanceProperties
| Name | Description | Value |
|---|---|---|
| maintenanceManagementType | Specifies whether scheduled maintenance is managed by the system or by the user. | 'System' (required) |
Terraform (AzAPI provider) resource definition
The clusters/pools resource type can be deployed with operations that target:
- Resource groups For a list of changed properties in each API version, see change log.
Usage Examples
Terraform Samples
Create a minimum provisioned HorizonDB pool.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "cluster_name" {
type = string
default = "example-cluster"
description = "The name of the HorizonDB cluster"
}
variable "pool_name" {
type = string
default = "example-pool-01"
description = "The name of the HorizonDB pool"
}
data "azapi_client_config" "current" {
}
resource "azapi_resource" "pools" {
type = "Microsoft.HorizonDb/clusters/pools@2026-10-01-preview"
name = var.pool_name
parent_id = "/subscriptions/${data.azapi_client_config.current.subscription_id}/resourceGroups/${data.azapi_client_config.current.resource_group_name}/providers/Microsoft.HorizonDb/clusters/${var.cluster_name}"
body = {
properties = {
computeModel = {
type = "Provisioned"
computeProcessor = "AMD"
computeGeneration = 3
vCores = 2
}
parameterGroup = {
parameterGroupResourceId = "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/parameterGroups/default-postgresql-17-provisioned"
applyMethod = "Immediate"
}
scheduledMaintenance = {
maintenanceManagementType = "System"
}
nodeCount = 1
highAvailability = {
mode = "Disabled"
}
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Update a single HorizonDB pool compute property.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "cluster_name" {
type = string
default = "example-cluster"
description = "The name of the HorizonDB cluster"
}
variable "pool_name" {
type = string
default = "example-pool-01"
description = "The name of the HorizonDB pool"
}
data "azapi_client_config" "current" {
}
resource "azapi_update_resource" "pools" {
type = "Microsoft.HorizonDb/clusters/pools@2026-10-01-preview"
name = var.pool_name
parent_id = "/subscriptions/${data.azapi_client_config.current.subscription_id}/resourceGroups/${data.azapi_client_config.current.resource_group_name}/providers/Microsoft.HorizonDb/clusters/${var.cluster_name}"
body = {
properties = {
computeModel = {
vCores = 16
}
scheduledMaintenance = {
maintenanceManagementType = "System"
}
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Require zone-redundant placement for a HorizonDB pool.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "cluster_name" {
type = string
default = "example-cluster"
description = "The name of the HorizonDB cluster"
}
variable "pool_name" {
type = string
default = "example-pool-01"
description = "The name of the HorizonDB pool"
}
data "azapi_client_config" "current" {
}
resource "azapi_resource" "pools" {
type = "Microsoft.HorizonDb/clusters/pools@2026-10-01-preview"
name = var.pool_name
parent_id = "/subscriptions/${data.azapi_client_config.current.subscription_id}/resourceGroups/${data.azapi_client_config.current.resource_group_name}/providers/Microsoft.HorizonDb/clusters/${var.cluster_name}"
body = {
properties = {
highAvailability = {
mode = "ZoneRedundant"
}
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Switch a HorizonDB pool back to its corresponding default parameter group.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "cluster_name" {
type = string
default = "example-cluster"
description = "The name of the HorizonDB cluster"
}
variable "pool_name" {
type = string
default = "example-pool-01"
description = "The name of the HorizonDB pool"
}
data "azapi_client_config" "current" {
}
resource "azapi_resource" "pools" {
type = "Microsoft.HorizonDb/clusters/pools@2026-10-01-preview"
name = var.pool_name
parent_id = "/subscriptions/${data.azapi_client_config.current.subscription_id}/resourceGroups/${data.azapi_client_config.current.resource_group_name}/providers/Microsoft.HorizonDb/clusters/${var.cluster_name}"
body = {
properties = {
parameterGroup = {
parameterGroupResourceId = "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.HorizonDb/locations/eastus2/parameterGroups/default-postgresql-17-provisioned"
applyMethod = "Immediate"
}
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Associate a HorizonDB pool with a parameter group immediately.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "cluster_name" {
type = string
default = "example-cluster"
description = "The name of the HorizonDB cluster"
}
variable "pool_name" {
type = string
default = "example-pool-01"
description = "The name of the HorizonDB pool"
}
data "azapi_client_config" "current" {
}
resource "azapi_resource" "pools" {
type = "Microsoft.HorizonDb/clusters/pools@2026-10-01-preview"
name = var.pool_name
parent_id = "/subscriptions/${data.azapi_client_config.current.subscription_id}/resourceGroups/${data.azapi_client_config.current.resource_group_name}/providers/Microsoft.HorizonDb/clusters/${var.cluster_name}"
body = {
properties = {
parameterGroup = {
parameterGroupResourceId = "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/production-parameters"
applyMethod = "Immediate"
}
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Associate a HorizonDB pool with a parameter group pending reboot.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "cluster_name" {
type = string
default = "example-cluster"
description = "The name of the HorizonDB cluster"
}
variable "pool_name" {
type = string
default = "example-pool-01"
description = "The name of the HorizonDB pool"
}
data "azapi_client_config" "current" {
}
resource "azapi_resource" "pools" {
type = "Microsoft.HorizonDb/clusters/pools@2026-10-01-preview"
name = var.pool_name
parent_id = "/subscriptions/${data.azapi_client_config.current.subscription_id}/resourceGroups/${data.azapi_client_config.current.resource_group_name}/providers/Microsoft.HorizonDb/clusters/${var.cluster_name}"
body = {
properties = {
parameterGroup = {
parameterGroupResourceId = "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/example-resource-group/providers/Microsoft.HorizonDb/parameterGroups/maintenance-window-parameters"
applyMethod = "PendingReboot"
}
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Resource format
To create a Microsoft.HorizonDb/clusters/pools resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.HorizonDb/clusters/pools@2026-10-01-preview"
name = "string"
parent_id = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
computeModel = {
computeGeneration = int
computeProcessor = "string"
type = "string"
vCores = int
}
highAvailability = {
mode = "string"
}
nodeCount = int
parameterGroup = {
applyMethod = "string"
parameterGroupResourceId = "string"
}
scheduledMaintenance = {
maintenanceManagementType = "string"
// For remaining properties, see ScheduledMaintenanceProperties objects
}
}
}
}
ScheduledMaintenanceProperties objects
Set the maintenanceManagementType property to specify the type of object.
For System, use:
{
maintenanceManagementType = "System"
}
Property Values
Microsoft.HorizonDb/clusters/pools
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 1 Max length = 63 Pattern = ^[a-z0-9](?:[-a-z0-9]*[a-z0-9])?$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: clusters |
| properties | The resource-specific properties for this resource. | PoolProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.HorizonDb/clusters/pools@2026-10-01-preview" |
PoolComputeModel
| Name | Description | Value |
|---|---|---|
| computeGeneration | The compute generation for the compute model. | int Constraints: Min value = 1 (required) |
| computeProcessor | The processor type for the compute model. | 'AMD' 'Intel' (required) |
| type | The type of compute model. | 'Provisioned' (required) |
| vCores | The number of vCores. Allowed values are 1 through 192. | int Constraints: Min value = 2 Max value = 192 (required) |
PoolHighAvailability
| Name | Description | Value |
|---|---|---|
| mode | The high-availability mode. Disabled is required when nodeCount is 1. AnyZone or ZoneRedundant is required when nodeCount is 2 through 16. | 'AnyZone' 'Disabled' 'ZoneRedundant' (required) |
PoolParameterGroupReference
| Name | Description | Value |
|---|---|---|
| applyMethod | Determines when dynamic parameter changes from the associated parameter group become effective. Static parameter changes always require a customer-initiated pool Restart, regardless of this value. Stop followed by Start and scheduled maintenance do not apply pending parameter changes. | 'Immediate' 'PendingReboot' (required) |
| parameterGroupResourceId | The Azure resource ID of the associated parameter group. Initial pool creation in this API version requires the corresponding Microsoft.HorizonDb/locations/parameterGroups resource. For an existing pool, PUT can specify either the corresponding default group or a customer-created Microsoft.HorizonDb/parameterGroups resource. | string (required) |
PoolProperties
| Name | Description | Value |
|---|---|---|
| computeModel | The required compute model for the HorizonDB pool. | PoolComputeModel (required) |
| highAvailability | The required high-availability configuration for the pool. mode must be Disabled when nodeCount is 1, and must be AnyZone or ZoneRedundant when nodeCount is 2 through 16. | PoolHighAvailability (required) |
| nodeCount | The required number of nodes to allocate and assign to the pool. Allowed values are 1 through 16. To deallocate runtime compute without changing the configured node count, stop the pool. | int Constraints: Min value = 1 Max value = 16 (required) |
| parameterGroup | The required parameter group associated with the pool. When creating a new pool in this API version, the caller must supply the corresponding default parameter group; customer-created parameter groups are not accepted during creation. For an existing pool, PUT or PATCH can associate either the corresponding default parameter group or a customer-created parameter group. The create-visible shape intentionally supports both resource ID forms so a future API version can allow customer-created parameter groups during creation without a breaking schema change. | PoolParameterGroupReference (required) |
| scheduledMaintenance | The scheduled maintenance configuration for the pool. The properties available depend on the selected maintenance management type. | ScheduledMaintenanceProperties |
PoolTags
| Name | Description | Value |
|---|
ScheduledMaintenanceProperties
| Name | Description | Value |
|---|---|---|
| maintenanceManagementType | Set to 'System' for type SystemScheduledMaintenanceProperties. | 'System' (required) |
SystemScheduledMaintenanceProperties
| Name | Description | Value |
|---|---|---|
| maintenanceManagementType | Specifies whether scheduled maintenance is managed by the system or by the user. | 'System' (required) |