MicrosoftEntraAdministratorProperties interface

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

Properties

objectId

The Microsoft Entra object identifier of the principal mapped to the PostgreSQL role, represented as an RFC 4122 GUID. On PUT requests, this value comes from the URI path parameter.

principalName

The display name or user principal name of the Microsoft Entra principal mapped 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 mapped to the PostgreSQL role.

provisioningState

The provisioning state of the PostgreSQL role and Microsoft Entra principal mapping.

tenantId

The identifier of the Microsoft Entra tenant containing the mapped principal, represented as an RFC 4122 GUID. If omitted, this value defaults to the tenant of the subscription.

Property Details

objectId

The Microsoft Entra object identifier of the principal mapped to the PostgreSQL role, represented as 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 user principal name of the Microsoft Entra principal mapped 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 mapped to the PostgreSQL role.

principalType: string

Property Value

string

provisioningState

The provisioning state of the PostgreSQL role and Microsoft Entra principal mapping.

provisioningState?: string

Property Value

string

tenantId

The identifier of the Microsoft Entra tenant containing the mapped principal, represented as an RFC 4122 GUID. If omitted, this value defaults to the tenant of the subscription.

tenantId?: string

Property Value

string