Microsoft.HorizonDb clusters/pools/firewallRules

Bicep resource definition

The clusters/pools/firewallRules resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Usage Examples

Bicep Samples

Create or replace a firewall rule on 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'
@description('The name of the firewall rule')
param firewallRuleName string = 'example-firewall-rule-01'

resource horizonDbResource 'Microsoft.HorizonDb/clusters/pools/firewallRules@2026-10-01-preview' = {
  name: '${clusterName}/${poolName}/${firewallRuleName}'
  properties: {
    startIpAddress: '10.0.0.1'
    endIpAddress: '10.0.0.254'
    description: 'Allow access from the corporate network'
  }
}

Resource format

To create a Microsoft.HorizonDb/clusters/pools/firewallRules resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.HorizonDb/clusters/pools/firewallRules@2026-10-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    endIpAddress: 'string'
    startIpAddress: 'string'
  }
}

Property Values

Microsoft.HorizonDb/clusters/pools/firewallRules

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 128
Pattern = ^[a-zA-Z0-9][-a-zA-Z0-9]*[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: clusters/pools
properties The resource-specific properties for this resource. FirewallRuleProperties

FirewallRuleProperties

Name Description Value
description The description of the HorizonDB firewall rule. The maximum length is 1024 characters. string

Constraints:
Max length = 1024
endIpAddress The end IPv4 address of the firewall rule in dotted-decimal notation. This address must be numerically greater than or equal to startIpAddress. string

Constraints:
Pattern = ^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])[.]){3}(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$ (required)
startIpAddress The start IPv4 address of the firewall rule in dotted-decimal notation. string

Constraints:
Pattern = ^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])[.]){3}(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$ (required)

ARM template resource definition

The clusters/pools/firewallRules resource type can be deployed with operations that target:

Usage Examples

ARM Template Samples

Create or replace a firewall rule on 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"
      }
    },
    "firewallRuleName": {
      "type": "string",
      "defaultValue": "example-firewall-rule-01",
      "metadata": {
        "description": "The name of the firewall rule"
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.HorizonDb/clusters/pools/firewallRules",
      "apiVersion": "2026-10-01-preview",
      "name": "[format('{0}/{1}/{2}', parameters('clusterName'), parameters('poolName'), parameters('firewallRuleName'))]",
      "properties": {
        "startIpAddress": "10.0.0.1",
        "endIpAddress": "10.0.0.254",
        "description": "Allow access from the corporate network"
      }
    }
  ]
}

Resource format

To create a Microsoft.HorizonDb/clusters/pools/firewallRules resource, add the following JSON to your template.

{
  "type": "Microsoft.HorizonDb/clusters/pools/firewallRules",
  "apiVersion": "2026-10-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "endIpAddress": "string",
    "startIpAddress": "string"
  }
}

Property Values

Microsoft.HorizonDb/clusters/pools/firewallRules

Name Description Value
apiVersion The api version '2026-10-01-preview'
name The resource name string

Constraints:
Min length = 1
Max length = 128
Pattern = ^[a-zA-Z0-9][-a-zA-Z0-9]*[a-zA-Z0-9]$ (required)
properties The resource-specific properties for this resource. FirewallRuleProperties
type The resource type 'Microsoft.HorizonDb/clusters/pools/firewallRules'

FirewallRuleProperties

Name Description Value
description The description of the HorizonDB firewall rule. The maximum length is 1024 characters. string

Constraints:
Max length = 1024
endIpAddress The end IPv4 address of the firewall rule in dotted-decimal notation. This address must be numerically greater than or equal to startIpAddress. string

Constraints:
Pattern = ^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])[.]){3}(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$ (required)
startIpAddress The start IPv4 address of the firewall rule in dotted-decimal notation. string

Constraints:
Pattern = ^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])[.]){3}(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$ (required)

Terraform (AzAPI provider) resource definition

The clusters/pools/firewallRules 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 firewall rule on 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"
}

variable "firewall_rule_name" {
  type        = string
  default     = "example-firewall-rule-01"
  description = "The name of the firewall rule"
}

data "azapi_client_config" "current" {
}

resource "azapi_resource" "firewall_rules" {
  type      = "Microsoft.HorizonDb/clusters/pools/firewallRules@2026-10-01-preview"
  name      = var.firewall_rule_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}/pools/${var.pool_name}"

  body = {
    properties = {
      startIpAddress = "10.0.0.1"
      endIpAddress = "10.0.0.254"
      description = "Allow access from the corporate network"
    }
  }

  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Resource format

To create a Microsoft.HorizonDb/clusters/pools/firewallRules resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HorizonDb/clusters/pools/firewallRules@2026-10-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      description = "string"
      endIpAddress = "string"
      startIpAddress = "string"
    }
  }
}

Property Values

Microsoft.HorizonDb/clusters/pools/firewallRules

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 128
Pattern = ^[a-zA-Z0-9][-a-zA-Z0-9]*[a-zA-Z0-9]$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: clusters/pools
properties The resource-specific properties for this resource. FirewallRuleProperties
type The resource type "Microsoft.HorizonDb/clusters/pools/firewallRules@2026-10-01-preview"

FirewallRuleProperties

Name Description Value
description The description of the HorizonDB firewall rule. The maximum length is 1024 characters. string

Constraints:
Max length = 1024
endIpAddress The end IPv4 address of the firewall rule in dotted-decimal notation. This address must be numerically greater than or equal to startIpAddress. string

Constraints:
Pattern = ^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])[.]){3}(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$ (required)
startIpAddress The start IPv4 address of the firewall rule in dotted-decimal notation. string

Constraints:
Pattern = ^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])[.]){3}(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$ (required)