Administrators Microsoft Entra - Create Or Update

Service:

PostgreSQL

API Version:

2025-08-01

Creates a new server administrator associated to a Microsoft Entra principal.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/administrators/{objectId}?api-version=2025-08-01

URI Parameters

Name	In	Required	Type	Description
objectId	path	True	string	Object identifier of the Microsoft Entra principal.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*	The name of the server.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
properties.principalName	string	Name of the Microsoft Entra principal.
properties.principalType	PrincipalType	Type of Microsoft Entra principal to which the server administrator is associated.
properties.tenantId	string	Identifier of the tenant in which the Microsoft Entra principal exists.

Responses

Name	Type	Description
202 Accepted		Accepted. Headers Location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Microsoft Entra OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Add a server administrator associated to a Microsoft Entra principal.

Sample request

HTTP

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver/administrators/oooooooo-oooo-oooo-oooo-oooooooooooo?api-version=2025-08-01

{
  "properties": {
    "tenantId": "tttttttt-tttt-tttt-tttt-tttttttttttt",
    "principalType": "User",
    "principalName": "exampleuser@contoso.com"
  }
}

Java

import com.azure.resourcemanager.postgresqlflexibleserver.models.PrincipalType;

/**
 * Samples for AdministratorsMicrosoftEntra CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/
     * AdministratorsMicrosoftEntraAdd.json
     */
    /**
     * Sample code: Add a server administrator associated to a Microsoft Entra principal.
     * 
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void addAServerAdministratorAssociatedToAMicrosoftEntraPrincipal(
        com.azure.resourcemanager.postgresqlflexibleserver.PostgreSqlManager manager) {
        manager.administratorsMicrosoftEntras().define("oooooooo-oooo-oooo-oooo-oooooooooooo")
            .withExistingFlexibleServer("exampleresourcegroup", "exampleserver").withPrincipalType(PrincipalType.USER)
            .withPrincipalName("exampleuser@contoso.com").withTenantId("tttttttt-tttt-tttt-tttt-tttttttttttt").create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python administrators_microsoft_entra_add.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PostgreSQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.administrators_microsoft_entra.begin_create_or_update(
        resource_group_name="exampleresourcegroup",
        server_name="exampleserver",
        object_id="oooooooo-oooo-oooo-oooo-oooooooooooo",
        parameters={
            "properties": {
                "principalName": "exampleuser@contoso.com",
                "principalType": "User",
                "tenantId": "tttttttt-tttt-tttt-tttt-tttttttttttt",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/AdministratorsMicrosoftEntraAdd.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { PostgreSQLManagementFlexibleServerClient } = require("@azure/arm-postgresql-flexible");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Creates a new server administrator associated to a Microsoft Entra principal.
 *
 * @summary Creates a new server administrator associated to a Microsoft Entra principal.
 * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/AdministratorsMicrosoftEntraAdd.json
 */
async function addAServerAdministratorAssociatedToAMicrosoftEntraPrincipal() {
  const subscriptionId =
    process.env["POSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["POSTGRESQL_RESOURCE_GROUP"] || "exampleresourcegroup";
  const serverName = "exampleserver";
  const objectId = "oooooooo-oooo-oooo-oooo-oooooooooooo";
  const parameters = {
    principalName: "exampleuser@contoso.com",
    principalType: "User",
    tenantId: "tttttttt-tttt-tttt-tttt-tttttttttttt",
  };
  const credential = new DefaultAzureCredential();
  const client = new PostgreSQLManagementFlexibleServerClient(credential, subscriptionId);
  const result = await client.administratorsMicrosoftEntra.beginCreateOrUpdateAndWait(
    resourceGroupName,
    serverName,
    objectId,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview

Definitions

Name	Description
AdministratorMicrosoftEntraAdd	Server administrator associated to a Microsoft Entra principal.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
PrincipalType	Type of Microsoft Entra principal to which the server administrator is associated.

AdministratorMicrosoftEntraAdd

Object

Server administrator associated to a Microsoft Entra principal.

Name	Type	Description
properties.principalName	string	Name of the Microsoft Entra principal.
properties.principalType	PrincipalType	Type of Microsoft Entra principal to which the server administrator is associated.
properties.tenantId	string	Identifier of the tenant in which the Microsoft Entra principal exists.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

PrincipalType

Enumeration

Type of Microsoft Entra principal to which the server administrator is associated.

Value	Description
Unknown	The principal type is not known or not specified.
User	A Microsoft Entra user.
Group	A Microsoft Entra group.
ServicePrincipal	A Microsoft Entra service principal, typically representing an application or service identity