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 parameterGroups 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 or replace a HorizonDB parameter group for a PostgreSQL version.
@description('The name of the parameter group')
param parameterGroupName string = 'production-parameters'
resource horizonDbResource 'Microsoft.HorizonDb/parameterGroups@2026-10-01-preview' = {
name: parameterGroupName
location: 'eastus2'
tags: {
environment: 'production'
}
properties: {
postgreSqlVersion: '17'
parameters: [
{
name: 'application_name'
value: 'horizondb-production'
}
{
name: 'autovacuum'
value: 'off'
}
{
name: 'wal_receiver_timeout'
value: '45000'
}
{
name: 'work_mem'
value: '8192'
}
{
name: 'xmlbinary'
value: 'base64'
}
]
description: 'Parameters for production transactional workloads'
}
}
Update a HorizonDB parameter group.
@description('The name of the parameter group')
param parameterGroupName string = 'production-parameters'
resource horizonDbResource 'Microsoft.HorizonDb/parameterGroups@2026-10-01-preview' = {
name: parameterGroupName
tags: {
environment: 'production'
team: 'data-platform'
}
properties: {
parameters: [
{
name: 'application_name'
value: 'horizondb-production'
}
{
name: 'autovacuum'
value: 'off'
}
{
name: 'wal_receiver_timeout'
value: '45000'
}
{
name: 'work_mem'
value: '8192'
}
{
name: 'xmlbinary'
value: 'base64'
}
]
description: 'Updated parameters for production transactional workloads'
}
}
Resource format
To create a Microsoft.HorizonDb/parameterGroups resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.HorizonDb/parameterGroups@2026-10-01-preview' = {
location: 'string'
name: 'string'
properties: {
description: 'string'
parameters: [
{
name: 'string'
value: 'string'
}
]
postgreSqlVersion: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.HorizonDb/parameterGroups
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 63 Pattern = ^[a-zA-Z0-9][-a-zA-Z0-9]*[a-zA-Z0-9]$ (required) |
| properties | The resource-specific properties for this resource. | ParameterGroupProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ParameterGroupProperties
| Name | Description | Value |
|---|---|---|
| description | Description of the parameter group. The maximum length is 1024 characters. | string Constraints: Max length = 1024 |
| parameters | Parameters in the parameter group. | ParameterProperties[] |
| postgreSqlVersion | The PostgreSQL major version for the parameter group. This property is required during creation and is immutable thereafter. The service selects the unique location-scoped default parameter group for this version in the resource location. The DefaultParameterGroups APIs return at most one default parameter group for each PostgreSQL version in a location, so this selection is unambiguous. | '17' '18' (required) |
ParameterProperties
| Name | Description | Value |
|---|---|---|
| name | The name of the parameter. | string |
| value | The value of the configuration. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The parameterGroups 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 or replace a HorizonDB parameter group for a PostgreSQL version.
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"parameterGroupName": {
"type": "string",
"defaultValue": "production-parameters",
"metadata": {
"description": "The name of the parameter group"
}
}
},
"resources": [
{
"type": "Microsoft.HorizonDb/parameterGroups",
"apiVersion": "2026-10-01-preview",
"name": "[parameters('parameterGroupName')]",
"location": "eastus2",
"tags": {
"environment": "production"
},
"properties": {
"postgreSqlVersion": "17",
"parameters": [
{
"name": "application_name",
"value": "horizondb-production"
},
{
"name": "autovacuum",
"value": "off"
},
{
"name": "wal_receiver_timeout",
"value": "45000"
},
{
"name": "work_mem",
"value": "8192"
},
{
"name": "xmlbinary",
"value": "base64"
}
],
"description": "Parameters for production transactional workloads"
}
}
]
}
Update a HorizonDB parameter group.
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"parameterGroupName": {
"type": "string",
"defaultValue": "production-parameters",
"metadata": {
"description": "The name of the parameter group"
}
}
},
"resources": [
{
"type": "Microsoft.HorizonDb/parameterGroups",
"apiVersion": "2026-10-01-preview",
"name": "[parameters('parameterGroupName')]",
"tags": {
"environment": "production",
"team": "data-platform"
},
"properties": {
"parameters": [
{
"name": "application_name",
"value": "horizondb-production"
},
{
"name": "autovacuum",
"value": "off"
},
{
"name": "wal_receiver_timeout",
"value": "45000"
},
{
"name": "work_mem",
"value": "8192"
},
{
"name": "xmlbinary",
"value": "base64"
}
],
"description": "Updated parameters for production transactional workloads"
}
}
]
}
Resource format
To create a Microsoft.HorizonDb/parameterGroups resource, add the following JSON to your template.
{
"type": "Microsoft.HorizonDb/parameterGroups",
"apiVersion": "2026-10-01-preview",
"name": "string",
"location": "string",
"properties": {
"description": "string",
"parameters": [
{
"name": "string",
"value": "string"
}
],
"postgreSqlVersion": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.HorizonDb/parameterGroups
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-10-01-preview' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 63 Pattern = ^[a-zA-Z0-9][-a-zA-Z0-9]*[a-zA-Z0-9]$ (required) |
| properties | The resource-specific properties for this resource. | ParameterGroupProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.HorizonDb/parameterGroups' |
ParameterGroupProperties
| Name | Description | Value |
|---|---|---|
| description | Description of the parameter group. The maximum length is 1024 characters. | string Constraints: Max length = 1024 |
| parameters | Parameters in the parameter group. | ParameterProperties[] |
| postgreSqlVersion | The PostgreSQL major version for the parameter group. This property is required during creation and is immutable thereafter. The service selects the unique location-scoped default parameter group for this version in the resource location. The DefaultParameterGroups APIs return at most one default parameter group for each PostgreSQL version in a location, so this selection is unambiguous. | '17' '18' (required) |
ParameterProperties
| Name | Description | Value |
|---|---|---|
| name | The name of the parameter. | string |
| value | The value of the configuration. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
Terraform (AzAPI provider) resource definition
The parameterGroups 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 or replace a HorizonDB parameter group for a PostgreSQL version.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "parameter_group_name" {
type = string
default = "production-parameters"
description = "The name of the parameter group"
}
data "azapi_client_config" "current" {
}
resource "azapi_resource" "parameter_groups" {
type = "Microsoft.HorizonDb/parameterGroups@2026-10-01-preview"
name = var.parameter_group_name
parent_id = "/subscriptions/${data.azapi_client_config.current.subscription_id}/resourceGroups/${data.azapi_client_config.current.resource_group_name}/providers/Microsoft.HorizonDb"
location = "eastus2"
body = {
tags = {
environment = "production"
}
properties = {
postgreSqlVersion = "17"
parameters = [
{
name = "application_name"
value = "horizondb-production"
},
{
name = "autovacuum"
value = "off"
},
{
name = "wal_receiver_timeout"
value = "45000"
},
{
name = "work_mem"
value = "8192"
},
{
name = "xmlbinary"
value = "base64"
},
]
description = "Parameters for production transactional workloads"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Update a HorizonDB parameter group.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "parameter_group_name" {
type = string
default = "production-parameters"
description = "The name of the parameter group"
}
data "azapi_client_config" "current" {
}
resource "azapi_update_resource" "parameter_groups" {
type = "Microsoft.HorizonDb/parameterGroups@2026-10-01-preview"
name = var.parameter_group_name
parent_id = "/subscriptions/${data.azapi_client_config.current.subscription_id}/resourceGroups/${data.azapi_client_config.current.resource_group_name}/providers/Microsoft.HorizonDb"
body = {
tags = {
environment = "production"
team = "data-platform"
}
properties = {
parameters = [
{
name = "application_name"
value = "horizondb-production"
},
{
name = "autovacuum"
value = "off"
},
{
name = "wal_receiver_timeout"
value = "45000"
},
{
name = "work_mem"
value = "8192"
},
{
name = "xmlbinary"
value = "base64"
},
]
description = "Updated parameters for production transactional workloads"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Resource format
To create a Microsoft.HorizonDb/parameterGroups resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.HorizonDb/parameterGroups@2026-10-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
description = "string"
parameters = [
{
name = "string"
value = "string"
}
]
postgreSqlVersion = "string"
}
}
}
Property Values
Microsoft.HorizonDb/parameterGroups
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 63 Pattern = ^[a-zA-Z0-9][-a-zA-Z0-9]*[a-zA-Z0-9]$ (required) |
| properties | The resource-specific properties for this resource. | ParameterGroupProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.HorizonDb/parameterGroups@2026-10-01-preview" |
ParameterGroupProperties
| Name | Description | Value |
|---|---|---|
| description | Description of the parameter group. The maximum length is 1024 characters. | string Constraints: Max length = 1024 |
| parameters | Parameters in the parameter group. | ParameterProperties[] |
| postgreSqlVersion | The PostgreSQL major version for the parameter group. This property is required during creation and is immutable thereafter. The service selects the unique location-scoped default parameter group for this version in the resource location. The DefaultParameterGroups APIs return at most one default parameter group for each PostgreSQL version in a location, so this selection is unambiguous. | '17' '18' (required) |
ParameterProperties
| Name | Description | Value |
|---|---|---|
| name | The name of the parameter. | string |
| value | The value of the configuration. | string |
TrackedResourceTags
| Name | Description | Value |
|---|