HorizonDbAdministratorProperties interface

Properties of a HorizonDB administrator.

Properties

objectId

The Entra ID object identifier of the principal (an RFC 4122 GUID). On PUT requests, this value comes from the URI path parameter.

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.

principalType

The type of the Entra ID principal.

provisioningState

The provisioning state of the administrator.

tenantId

The Entra ID tenant identifier (an RFC 4122 GUID). If omitted, defaults to the tenant of the subscription.

Property Details

objectId

The Entra ID object identifier of the principal (an RFC 4122 GUID). On PUT requests, this value comes from the URI path parameter.

objectId?: string

Property Value

string

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.

principalName: string

Property Value

string

principalType

The type of the Entra ID principal.

principalType: string

Property Value

string

provisioningState

The provisioning state of the administrator.

provisioningState?: string

Property Value

string

tenantId

The Entra ID tenant identifier (an RFC 4122 GUID). If omitted, defaults to the tenant of the subscription.

tenantId?: string

Property Value

string