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/authentications 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
Disable Microsoft Entra authentication declaratively.
@description('The name of the HorizonDB cluster')
param clusterName string = 'example-cluster'
resource horizonDbResource 'Microsoft.HorizonDb/clusters/authentications@2026-10-01-preview' = {
name: '${clusterName}/microsoftEntra'
properties: {
state: 'Disabled'
}
}
Enable Microsoft Entra authentication declaratively.
@description('The name of the HorizonDB cluster')
param clusterName string = 'example-cluster'
resource horizonDbResource 'Microsoft.HorizonDb/clusters/authentications@2026-10-01-preview' = {
name: '${clusterName}/microsoftEntra'
properties: {
state: 'Enabled'
}
}
Enable password authentication and set the administrator login and password during initial setup.
@description('The name of the HorizonDB cluster')
param clusterName string = 'example-cluster'
@secure()
@description('The administrator login password')
param administratorLoginPassword string
resource horizonDbResource 'Microsoft.HorizonDb/clusters/authentications@2026-10-01-preview' = {
name: '${clusterName}/passwordMethod'
properties: {
state: 'Enabled'
administratorLogin: 'adminlogin1'
administratorLoginPassword: administratorLoginPassword
}
}
Resource format
To create a Microsoft.HorizonDb/clusters/authentications resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.HorizonDb/clusters/authentications@2026-10-01-preview' = {
name: 'string'
// For remaining properties, see microsoft.horizondb/clusters/authentications objects
}
microsoft.horizondb/clusters/authentications objects
Set the name property to specify the type of object.
For microsoftEntra, use:
{
name: 'microsoftEntra'
properties: {
state: 'string'
}
}
For passwordMethod, use:
{
name: 'passwordMethod'
properties: {
administratorLogin: 'string'
administratorLoginPassword: 'string'
state: 'string'
}
}
Property Values
Microsoft.HorizonDb/clusters/authentications
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'microsoftEntra' (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. | MicrosoftEntraAuthenticationProperties |
Microsoft.HorizonDb/clusters/authentications
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'passwordMethod' (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. | PasswordAuthenticationProperties |
microsoft.horizondb/clusters/authentications
| Name | Description | Value |
|---|---|---|
| name | Set to 'microsoftEntra' for type Microsoft.HorizonDb/clusters/authentications. Set to 'passwordMethod' for type Microsoft.HorizonDb/clusters/authentications. | 'microsoftEntra' 'passwordMethod' (required) |
MicrosoftEntraAuthenticationProperties
| Name | Description | Value |
|---|---|---|
| state | The state of Microsoft Entra authentication. | 'Disabled' 'Enabled' (required) |
PasswordAuthenticationProperties
| Name | Description | Value |
|---|---|---|
| administratorLogin | The PostgreSQL administrator login name. This value is not returned in responses. After it is set, renaming is not supported. Setting the login requires password authentication state to be Enabled in the same request. | string Constraints: Min length = 1 Max length = 63 Sensitive value. Pass in as a secure parameter. |
| administratorLoginPassword | The PostgreSQL administrator password. Setting the password requires password authentication state to be Enabled in the same request. | string Constraints: Min length = 8 Max length = 128 Sensitive value. Pass in as a secure parameter. |
| state | The state of PostgreSQL username-and-password authentication. | 'Disabled' 'Enabled' (required) |
ARM template resource definition
The clusters/authentications 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
Disable Microsoft Entra authentication declaratively.
{
"$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"
}
}
},
"resources": [
{
"type": "Microsoft.HorizonDb/clusters/authentications",
"apiVersion": "2026-10-01-preview",
"name": "[format('{0}/{1}', parameters('clusterName'), 'microsoftEntra')]",
"properties": {
"state": "Disabled"
}
}
]
}
Enable Microsoft Entra authentication declaratively.
{
"$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"
}
}
},
"resources": [
{
"type": "Microsoft.HorizonDb/clusters/authentications",
"apiVersion": "2026-10-01-preview",
"name": "[format('{0}/{1}', parameters('clusterName'), 'microsoftEntra')]",
"properties": {
"state": "Enabled"
}
}
]
}
Enable password authentication and set the administrator login and password during initial setup.
{
"$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"
}
},
"administratorLoginPassword": {
"type": "secureString",
"metadata": {
"description": "The administrator login password"
}
}
},
"resources": [
{
"type": "Microsoft.HorizonDb/clusters/authentications",
"apiVersion": "2026-10-01-preview",
"name": "[format('{0}/{1}', parameters('clusterName'), 'passwordMethod')]",
"properties": {
"state": "Enabled",
"administratorLogin": "adminlogin1",
"administratorLoginPassword": "[parameters('administratorLoginPassword')]"
}
}
]
}
Resource format
To create a Microsoft.HorizonDb/clusters/authentications resource, add the following JSON to your template.
{
"name": "string"
// For remaining properties, see microsoft.horizondb/clusters/authentications objects
}
microsoft.horizondb/clusters/authentications objects
Set the name property to specify the type of object.
For microsoftEntra, use:
{
"name": "microsoftEntra",
"properties": {
"state": "string"
}
}
For passwordMethod, use:
{
"name": "passwordMethod",
"properties": {
"administratorLogin": "string",
"administratorLoginPassword": "string",
"state": "string"
}
}
Property Values
Microsoft.HorizonDb/clusters/authentications
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-10-01-preview' |
| name | The resource name | 'microsoftEntra' (required) |
| properties | The resource-specific properties for this resource. | MicrosoftEntraAuthenticationProperties |
| type | The resource type | 'Microsoft.HorizonDb/clusters/authentications' |
Microsoft.HorizonDb/clusters/authentications
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-10-01-preview' |
| name | The resource name | 'passwordMethod' (required) |
| properties | The resource-specific properties for this resource. | PasswordAuthenticationProperties |
| type | The resource type | 'Microsoft.HorizonDb/clusters/authentications' |
microsoft.horizondb/clusters/authentications
| Name | Description | Value |
|---|---|---|
| name | Set to 'microsoftEntra' for type Microsoft.HorizonDb/clusters/authentications. Set to 'passwordMethod' for type Microsoft.HorizonDb/clusters/authentications. | 'microsoftEntra' 'passwordMethod' (required) |
MicrosoftEntraAuthenticationProperties
| Name | Description | Value |
|---|---|---|
| state | The state of Microsoft Entra authentication. | 'Disabled' 'Enabled' (required) |
PasswordAuthenticationProperties
| Name | Description | Value |
|---|---|---|
| administratorLogin | The PostgreSQL administrator login name. This value is not returned in responses. After it is set, renaming is not supported. Setting the login requires password authentication state to be Enabled in the same request. | string Constraints: Min length = 1 Max length = 63 Sensitive value. Pass in as a secure parameter. |
| administratorLoginPassword | The PostgreSQL administrator password. Setting the password requires password authentication state to be Enabled in the same request. | string Constraints: Min length = 8 Max length = 128 Sensitive value. Pass in as a secure parameter. |
| state | The state of PostgreSQL username-and-password authentication. | 'Disabled' 'Enabled' (required) |
Terraform (AzAPI provider) resource definition
The clusters/authentications 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
Disable Microsoft Entra authentication declaratively.
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"
}
data "azapi_client_config" "current" {
}
resource "azapi_resource" "authentications" {
type = "Microsoft.HorizonDb/clusters/authentications@2026-10-01-preview"
name = "microsoftEntra"
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 = {
state = "Disabled"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Enable Microsoft Entra authentication declaratively.
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"
}
data "azapi_client_config" "current" {
}
resource "azapi_resource" "authentications" {
type = "Microsoft.HorizonDb/clusters/authentications@2026-10-01-preview"
name = "microsoftEntra"
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 = {
state = "Enabled"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Enable password authentication and set the administrator login and password during initial setup.
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 "administrator_login_password" {
type = string
description = "The administrator login password"
sensitive = true
}
data "azapi_client_config" "current" {
}
resource "azapi_resource" "authentications" {
type = "Microsoft.HorizonDb/clusters/authentications@2026-10-01-preview"
name = "passwordMethod"
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 = {
state = "Enabled"
administratorLogin = "adminlogin1"
administratorLoginPassword = var.administrator_login_password
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Resource format
To create a Microsoft.HorizonDb/clusters/authentications resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
name = "string"
// For remaining properties, see microsoft.horizondb/clusters/authentications objects
}
microsoft.horizondb/clusters/authentications objects
Set the name property to specify the type of object.
For microsoftEntra, use:
{
name = "microsoftEntra"
properties = {
state = "string"
}
}
For passwordMethod, use:
{
name = "passwordMethod"
properties = {
administratorLogin = "string"
administratorLoginPassword = "string"
state = "string"
}
}
Property Values
Microsoft.HorizonDb/clusters/authentications
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'microsoftEntra' (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. | MicrosoftEntraAuthenticationProperties |
| type | The resource type | "Microsoft.HorizonDb/clusters/authentications@2026-10-01-preview" |
Microsoft.HorizonDb/clusters/authentications
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'passwordMethod' (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. | PasswordAuthenticationProperties |
| type | The resource type | "Microsoft.HorizonDb/clusters/authentications@2026-10-01-preview" |
microsoft.horizondb/clusters/authentications
| Name | Description | Value |
|---|---|---|
| name | Set to 'microsoftEntra' for type Microsoft.HorizonDb/clusters/authentications. Set to 'passwordMethod' for type Microsoft.HorizonDb/clusters/authentications. | 'microsoftEntra' 'passwordMethod' (required) |
MicrosoftEntraAuthenticationProperties
| Name | Description | Value |
|---|---|---|
| state | The state of Microsoft Entra authentication. | 'Disabled' 'Enabled' (required) |
PasswordAuthenticationProperties
| Name | Description | Value |
|---|---|---|
| administratorLogin | The PostgreSQL administrator login name. This value is not returned in responses. After it is set, renaming is not supported. Setting the login requires password authentication state to be Enabled in the same request. | string Constraints: Min length = 1 Max length = 63 Sensitive value. Pass in as a secure parameter. |
| administratorLoginPassword | The PostgreSQL administrator password. Setting the password requires password authentication state to be Enabled in the same request. | string Constraints: Min length = 8 Max length = 128 Sensitive value. Pass in as a secure parameter. |
| state | The state of PostgreSQL username-and-password authentication. | 'Disabled' 'Enabled' (required) |