MicrosoftEntraAdministratorPropertiesForAdd interface

Package:

@azure/arm-horizondb

Properties for creating or updating a PostgreSQL role that is a member of azure_pg_admin and mapped to a Microsoft Entra principal.

Properties

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.
principalType	The type of Microsoft Entra principal to map to the PostgreSQL role.
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.

Property Details

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.

principalName: string

Property Value

string

principalType

The type of Microsoft Entra principal to map to the PostgreSQL role.

principalType: string

Property Value

string

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.

tenantId?: string

Property Value

string