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/administrators 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.
Resource format
To create a Microsoft.HorizonDb/clusters/administrators resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.HorizonDb/clusters/administrators@2026-05-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
principalName: 'string'
principalType: 'string'
tenantId: 'string'
}
}
Property Values
Microsoft.HorizonDb/clusters/administrators
| 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 properties for adding a HorizonDB administrator. | HorizonDbAdministratorPropertiesForAddOrHorizonDbAdministratorProperties (required) |
HorizonDbAdministratorPropertiesForAddOrHorizonDbAdministratorProperties
| Name | Description | Value |
|---|---|---|
| principalName | The display name or UPN of the Entra ID principal. For users, typically the User Principal Name (e.g., admin@contoso.com). For groups, the group display name. For service principals, the application display name. | string Constraints: Max length = 256 (required) |
| principalType | The type of the Entra ID principal. | 'Group' 'ServicePrincipal' 'Unknown' 'User' (required) |
| tenantId | The Entra ID tenant identifier (an RFC 4122 GUID). If omitted, defaults to the tenant of the subscription. | string |
ARM template resource definition
The clusters/administrators 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
Resource format
To create a Microsoft.HorizonDb/clusters/administrators resource, add the following JSON to your template.
{
"type": "Microsoft.HorizonDb/clusters/administrators",
"apiVersion": "2026-05-01-preview",
"name": "string",
"properties": {
"principalName": "string",
"principalType": "string",
"tenantId": "string"
}
}
Property Values
Microsoft.HorizonDb/clusters/administrators
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-05-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 properties for adding a HorizonDB administrator. | HorizonDbAdministratorPropertiesForAddOrHorizonDbAdministratorProperties (required) |
| type | The resource type | 'Microsoft.HorizonDb/clusters/administrators' |
HorizonDbAdministratorPropertiesForAddOrHorizonDbAdministratorProperties
| Name | Description | Value |
|---|---|---|
| principalName | The display name or UPN of the Entra ID principal. For users, typically the User Principal Name (e.g., admin@contoso.com). For groups, the group display name. For service principals, the application display name. | string Constraints: Max length = 256 (required) |
| principalType | The type of the Entra ID principal. | 'Group' 'ServicePrincipal' 'Unknown' 'User' (required) |
| tenantId | The Entra ID tenant identifier (an RFC 4122 GUID). If omitted, defaults to the tenant of the subscription. | string |
Terraform (AzAPI provider) resource definition
The clusters/administrators resource type can be deployed with operations that target:
- Resource groups For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.HorizonDb/clusters/administrators resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.HorizonDb/clusters/administrators@2026-05-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
principalName = "string"
principalType = "string"
tenantId = "string"
}
}
}
Property Values
Microsoft.HorizonDb/clusters/administrators
| 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 properties for adding a HorizonDB administrator. | HorizonDbAdministratorPropertiesForAddOrHorizonDbAdministratorProperties (required) |
| type | The resource type | "Microsoft.HorizonDb/clusters/administrators@2026-05-01-preview" |
HorizonDbAdministratorPropertiesForAddOrHorizonDbAdministratorProperties
| Name | Description | Value |
|---|---|---|
| principalName | The display name or UPN of the Entra ID principal. For users, typically the User Principal Name (e.g., admin@contoso.com). For groups, the group display name. For service principals, the application display name. | string Constraints: Max length = 256 (required) |
| principalType | The type of the Entra ID principal. | 'Group' 'ServicePrincipal' 'Unknown' 'User' (required) |
| tenantId | The Entra ID tenant identifier (an RFC 4122 GUID). If omitted, defaults to the tenant of the subscription. | string |