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/microsoftEntraAdministrators 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 Microsoft Entra administrator for a HorizonDB cluster.
@description('The name of the HorizonDB cluster')
param clusterName string = 'example-cluster'
@description('The object ID of the Microsoft Entra administrator')
param objectId string = '11111111-1111-1111-1111-111111111111'
resource horizonDbResource 'Microsoft.HorizonDb/clusters/microsoftEntraAdministrators@2026-10-01-preview' = {
name: '${clusterName}/${objectId}'
properties: {
principalName: 'database.administrators@contoso.com'
principalType: 'Group'
tenantId: '22222222-2222-2222-2222-222222222222'
}
}
Resource format
To create a Microsoft.HorizonDb/clusters/microsoftEntraAdministrators resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.HorizonDb/clusters/microsoftEntraAdministrators@2026-10-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
principalName: 'string'
principalType: 'string'
tenantId: 'string'
}
}
Property Values
Microsoft.HorizonDb/clusters/microsoftEntraAdministrators
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (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 PostgreSQL role and Microsoft Entra principal mapping properties. | MicrosoftEntraAdministratorPropertiesForAddOrMicrosoftEntraAdministratorProperties (required) |
MicrosoftEntraAdministratorPropertiesForAddOrMicrosoftEntraAdministratorProperties
| Name | Description | Value |
|---|---|---|
| principalName | The display name or user principal name of the Microsoft Entra principal to map to the PostgreSQL role. For users, this is typically the user principal name, such as admin@contoso.com. For groups, this is the group display name. For service principals, this is the application display name. | string Constraints: Max length = 256 (required) |
| principalType | The type of Microsoft Entra principal to map to the PostgreSQL role. | 'Group' 'ServicePrincipal' 'Unknown' 'User' (required) |
| tenantId | The identifier of the Microsoft Entra tenant containing the principal to map, represented as an RFC 4122 GUID. If omitted, this value defaults to the tenant of the subscription. | string |
ARM template resource definition
The clusters/microsoftEntraAdministrators 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 Microsoft Entra administrator for a HorizonDB cluster.
{
"$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"
}
},
"objectId": {
"type": "string",
"defaultValue": "11111111-1111-1111-1111-111111111111",
"metadata": {
"description": "The object ID of the Microsoft Entra administrator"
}
}
},
"resources": [
{
"type": "Microsoft.HorizonDb/clusters/microsoftEntraAdministrators",
"apiVersion": "2026-10-01-preview",
"name": "[format('{0}/{1}', parameters('clusterName'), parameters('objectId'))]",
"properties": {
"principalName": "database.administrators@contoso.com",
"principalType": "Group",
"tenantId": "22222222-2222-2222-2222-222222222222"
}
}
]
}
Resource format
To create a Microsoft.HorizonDb/clusters/microsoftEntraAdministrators resource, add the following JSON to your template.
{
"type": "Microsoft.HorizonDb/clusters/microsoftEntraAdministrators",
"apiVersion": "2026-10-01-preview",
"name": "string",
"properties": {
"principalName": "string",
"principalType": "string",
"tenantId": "string"
}
}
Property Values
Microsoft.HorizonDb/clusters/microsoftEntraAdministrators
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-10-01-preview' |
| name | The resource name | string Constraints: Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (required) |
| properties | The PostgreSQL role and Microsoft Entra principal mapping properties. | MicrosoftEntraAdministratorPropertiesForAddOrMicrosoftEntraAdministratorProperties (required) |
| type | The resource type | 'Microsoft.HorizonDb/clusters/microsoftEntraAdministrators' |
MicrosoftEntraAdministratorPropertiesForAddOrMicrosoftEntraAdministratorProperties
| Name | Description | Value |
|---|---|---|
| principalName | The display name or user principal name of the Microsoft Entra principal to map to the PostgreSQL role. For users, this is typically the user principal name, such as admin@contoso.com. For groups, this is the group display name. For service principals, this is the application display name. | string Constraints: Max length = 256 (required) |
| principalType | The type of Microsoft Entra principal to map to the PostgreSQL role. | 'Group' 'ServicePrincipal' 'Unknown' 'User' (required) |
| tenantId | The identifier of the Microsoft Entra tenant containing the principal to map, represented as an RFC 4122 GUID. If omitted, this value defaults to the tenant of the subscription. | string |
Terraform (AzAPI provider) resource definition
The clusters/microsoftEntraAdministrators 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 Microsoft Entra administrator for a HorizonDB cluster.
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 "object_id" {
type = string
default = "11111111-1111-1111-1111-111111111111"
description = "The object ID of the Microsoft Entra administrator"
}
data "azapi_client_config" "current" {
}
resource "azapi_resource" "microsoft_entra_administrators" {
type = "Microsoft.HorizonDb/clusters/microsoftEntraAdministrators@2026-10-01-preview"
name = var.object_id
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 = {
principalName = "database.administrators@contoso.com"
principalType = "Group"
tenantId = "22222222-2222-2222-2222-222222222222"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Resource format
To create a Microsoft.HorizonDb/clusters/microsoftEntraAdministrators resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.HorizonDb/clusters/microsoftEntraAdministrators@2026-10-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
principalName = "string"
principalType = "string"
tenantId = "string"
}
}
}
Property Values
Microsoft.HorizonDb/clusters/microsoftEntraAdministrators
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: clusters |
| properties | The PostgreSQL role and Microsoft Entra principal mapping properties. | MicrosoftEntraAdministratorPropertiesForAddOrMicrosoftEntraAdministratorProperties (required) |
| type | The resource type | "Microsoft.HorizonDb/clusters/microsoftEntraAdministrators@2026-10-01-preview" |
MicrosoftEntraAdministratorPropertiesForAddOrMicrosoftEntraAdministratorProperties
| Name | Description | Value |
|---|---|---|
| principalName | The display name or user principal name of the Microsoft Entra principal to map to the PostgreSQL role. For users, this is typically the user principal name, such as admin@contoso.com. For groups, this is the group display name. For service principals, this is the application display name. | string Constraints: Max length = 256 (required) |
| principalType | The type of Microsoft Entra principal to map to the PostgreSQL role. | 'Group' 'ServicePrincipal' 'Unknown' 'User' (required) |
| tenantId | The identifier of the Microsoft Entra tenant containing the principal to map, represented as an RFC 4122 GUID. If omitted, this value defaults to the tenant of the subscription. | string |