Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. postgresql
  5. ActiveDirectoryAdministrator

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.postgresql.ActiveDirectoryAdministrator

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Allows you to set a user or group as the AD administrator for an PostgreSQL server in Azure

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const current = azure.core.getClientConfig({});
const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleServer = new azure.postgresql.Server("example", {
    name: "example-psqlserver",
    resourceGroupName: example.name,
    location: example.location,
    version: "9.6",
    administratorLogin: "4dm1n157r470r",
    administratorLoginPassword: "4-v3ry-53cr37-p455w0rd",
    skuName: "GP_Gen5_2",
    sslEnforcementEnabled: true,
});
const exampleActiveDirectoryAdministrator = new azure.postgresql.ActiveDirectoryAdministrator("example", {
    serverName: exampleServer.name,
    resourceGroupName: example.name,
    login: "sqladmin",
    tenantId: current.then(current => current.tenantId),
    objectId: current.then(current => current.objectId),
});
Copy
import pulumi
import pulumi_azure as azure

current = azure.core.get_client_config()
example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_server = azure.postgresql.Server("example",
    name="example-psqlserver",
    resource_group_name=example.name,
    location=example.location,
    version="9.6",
    administrator_login="4dm1n157r470r",
    administrator_login_password="4-v3ry-53cr37-p455w0rd",
    sku_name="GP_Gen5_2",
    ssl_enforcement_enabled=True)
example_active_directory_administrator = azure.postgresql.ActiveDirectoryAdministrator("example",
    server_name=example_server.name,
    resource_group_name=example.name,
    login="sqladmin",
    tenant_id=current.tenant_id,
    object_id=current.object_id)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/postgresql"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := core.GetClientConfig(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleServer, err := postgresql.NewServer(ctx, "example", &postgresql.ServerArgs{
			Name:                       pulumi.String("example-psqlserver"),
			ResourceGroupName:          example.Name,
			Location:                   example.Location,
			Version:                    pulumi.String("9.6"),
			AdministratorLogin:         pulumi.String("4dm1n157r470r"),
			AdministratorLoginPassword: pulumi.String("4-v3ry-53cr37-p455w0rd"),
			SkuName:                    pulumi.String("GP_Gen5_2"),
			SslEnforcementEnabled:      pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = postgresql.NewActiveDirectoryAdministrator(ctx, "example", &postgresql.ActiveDirectoryAdministratorArgs{
			ServerName:        exampleServer.Name,
			ResourceGroupName: example.Name,
			Login:             pulumi.String("sqladmin"),
			TenantId:          pulumi.String(current.TenantId),
			ObjectId:          pulumi.String(current.ObjectId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var current = Azure.Core.GetClientConfig.Invoke();

    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleServer = new Azure.PostgreSql.Server("example", new()
    {
        Name = "example-psqlserver",
        ResourceGroupName = example.Name,
        Location = example.Location,
        Version = "9.6",
        AdministratorLogin = "4dm1n157r470r",
        AdministratorLoginPassword = "4-v3ry-53cr37-p455w0rd",
        SkuName = "GP_Gen5_2",
        SslEnforcementEnabled = true,
    });

    var exampleActiveDirectoryAdministrator = new Azure.PostgreSql.ActiveDirectoryAdministrator("example", new()
    {
        ServerName = exampleServer.Name,
        ResourceGroupName = example.Name,
        Login = "sqladmin",
        TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
        ObjectId = current.Apply(getClientConfigResult => getClientConfigResult.ObjectId),
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.CoreFunctions;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.postgresql.Server;
import com.pulumi.azure.postgresql.ServerArgs;
import com.pulumi.azure.postgresql.ActiveDirectoryAdministrator;
import com.pulumi.azure.postgresql.ActiveDirectoryAdministratorArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var current = CoreFunctions.getClientConfig();

        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleServer = new Server("exampleServer", ServerArgs.builder()
            .name("example-psqlserver")
            .resourceGroupName(example.name())
            .location(example.location())
            .version("9.6")
            .administratorLogin("4dm1n157r470r")
            .administratorLoginPassword("4-v3ry-53cr37-p455w0rd")
            .skuName("GP_Gen5_2")
            .sslEnforcementEnabled(true)
            .build());

        var exampleActiveDirectoryAdministrator = new ActiveDirectoryAdministrator("exampleActiveDirectoryAdministrator", ActiveDirectoryAdministratorArgs.builder()
            .serverName(exampleServer.name())
            .resourceGroupName(example.name())
            .login("sqladmin")
            .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
            .objectId(current.applyValue(getClientConfigResult -> getClientConfigResult.objectId()))
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleServer:
    type: azure:postgresql:Server
    name: example
    properties:
      name: example-psqlserver
      resourceGroupName: ${example.name}
      location: ${example.location}
      version: '9.6'
      administratorLogin: 4dm1n157r470r
      administratorLoginPassword: 4-v3ry-53cr37-p455w0rd
      skuName: GP_Gen5_2
      sslEnforcementEnabled: true
  exampleActiveDirectoryAdministrator:
    type: azure:postgresql:ActiveDirectoryAdministrator
    name: example
    properties:
      serverName: ${exampleServer.name}
      resourceGroupName: ${example.name}
      login: sqladmin
      tenantId: ${current.tenantId}
      objectId: ${current.objectId}
variables:
  current:
    fn::invoke:
      function: azure:core:getClientConfig
      arguments: {}
Copy

Create ActiveDirectoryAdministrator Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ActiveDirectoryAdministrator(name: string, args: ActiveDirectoryAdministratorArgs, opts?: CustomResourceOptions);
@overload
def ActiveDirectoryAdministrator(resource_name: str,
                                 args: ActiveDirectoryAdministratorArgs,
                                 opts: Optional[ResourceOptions] = None)

@overload
def ActiveDirectoryAdministrator(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 login: Optional[str] = None,
                                 object_id: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 server_name: Optional[str] = None,
                                 tenant_id: Optional[str] = None)
func NewActiveDirectoryAdministrator(ctx *Context, name string, args ActiveDirectoryAdministratorArgs, opts ...ResourceOption) (*ActiveDirectoryAdministrator, error)
public ActiveDirectoryAdministrator(string name, ActiveDirectoryAdministratorArgs args, CustomResourceOptions? opts = null)
public ActiveDirectoryAdministrator(String name, ActiveDirectoryAdministratorArgs args)
public ActiveDirectoryAdministrator(String name, ActiveDirectoryAdministratorArgs args, CustomResourceOptions options)

type: azure:postgresql:ActiveDirectoryAdministrator
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ActiveDirectoryAdministratorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ActiveDirectoryAdministratorArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ActiveDirectoryAdministratorArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ActiveDirectoryAdministratorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ActiveDirectoryAdministratorArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var activeDirectoryAdministratorResource = new Azure.PostgreSql.ActiveDirectoryAdministrator("activeDirectoryAdministratorResource", new()
{
    Login = "string",
    ObjectId = "string",
    ResourceGroupName = "string",
    ServerName = "string",
    TenantId = "string",
});
Copy
example, err := postgresql.NewActiveDirectoryAdministrator(ctx, "activeDirectoryAdministratorResource", &postgresql.ActiveDirectoryAdministratorArgs{
	Login:             pulumi.String("string"),
	ObjectId:          pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ServerName:        pulumi.String("string"),
	TenantId:          pulumi.String("string"),
})
Copy
var activeDirectoryAdministratorResource = new ActiveDirectoryAdministrator("activeDirectoryAdministratorResource", ActiveDirectoryAdministratorArgs.builder()
    .login("string")
    .objectId("string")
    .resourceGroupName("string")
    .serverName("string")
    .tenantId("string")
    .build());
Copy
active_directory_administrator_resource = azure.postgresql.ActiveDirectoryAdministrator("activeDirectoryAdministratorResource",
    login="string",
    object_id="string",
    resource_group_name="string",
    server_name="string",
    tenant_id="string")
Copy
const activeDirectoryAdministratorResource = new azure.postgresql.ActiveDirectoryAdministrator("activeDirectoryAdministratorResource", {
    login: "string",
    objectId: "string",
    resourceGroupName: "string",
    serverName: "string",
    tenantId: "string",
});
Copy
type: azure:postgresql:ActiveDirectoryAdministrator
properties:
    login: string
    objectId: string
    resourceGroupName: string
    serverName: string
    tenantId: string
Copy

ActiveDirectoryAdministrator Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ActiveDirectoryAdministrator resource accepts the following input properties:

Login This property is required. string
The login name of the principal to set as the server administrator
ObjectId This property is required. string
The ID of the principal to set as the server administrator. For a managed identity this should be the Client ID of the identity.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group for the PostgreSQL server. Changing this forces a new resource to be created.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the PostgreSQL Server on which to set the administrator. Changing this forces a new resource to be created.
TenantId This property is required. string
The Azure Tenant ID
Login This property is required. string
The login name of the principal to set as the server administrator
ObjectId This property is required. string
The ID of the principal to set as the server administrator. For a managed identity this should be the Client ID of the identity.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group for the PostgreSQL server. Changing this forces a new resource to be created.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the PostgreSQL Server on which to set the administrator. Changing this forces a new resource to be created.
TenantId This property is required. string
The Azure Tenant ID
login This property is required. String
The login name of the principal to set as the server administrator
objectId This property is required. String
The ID of the principal to set as the server administrator. For a managed identity this should be the Client ID of the identity.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group for the PostgreSQL server. Changing this forces a new resource to be created.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the PostgreSQL Server on which to set the administrator. Changing this forces a new resource to be created.
tenantId This property is required. String
The Azure Tenant ID
login This property is required. string
The login name of the principal to set as the server administrator
objectId This property is required. string
The ID of the principal to set as the server administrator. For a managed identity this should be the Client ID of the identity.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group for the PostgreSQL server. Changing this forces a new resource to be created.
serverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the PostgreSQL Server on which to set the administrator. Changing this forces a new resource to be created.
tenantId This property is required. string
The Azure Tenant ID
login This property is required. str
The login name of the principal to set as the server administrator
object_id This property is required. str
The ID of the principal to set as the server administrator. For a managed identity this should be the Client ID of the identity.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group for the PostgreSQL server. Changing this forces a new resource to be created.
server_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the PostgreSQL Server on which to set the administrator. Changing this forces a new resource to be created.
tenant_id This property is required. str
The Azure Tenant ID
login This property is required. String
The login name of the principal to set as the server administrator
objectId This property is required. String
The ID of the principal to set as the server administrator. For a managed identity this should be the Client ID of the identity.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group for the PostgreSQL server. Changing this forces a new resource to be created.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the PostgreSQL Server on which to set the administrator. Changing this forces a new resource to be created.
tenantId This property is required. String
The Azure Tenant ID

Outputs

All input properties are implicitly available as output properties. Additionally, the ActiveDirectoryAdministrator resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ActiveDirectoryAdministrator Resource

Get an existing ActiveDirectoryAdministrator resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ActiveDirectoryAdministratorState, opts?: CustomResourceOptions): ActiveDirectoryAdministrator
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        login: Optional[str] = None,
        object_id: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        server_name: Optional[str] = None,
        tenant_id: Optional[str] = None) -> ActiveDirectoryAdministrator
func GetActiveDirectoryAdministrator(ctx *Context, name string, id IDInput, state *ActiveDirectoryAdministratorState, opts ...ResourceOption) (*ActiveDirectoryAdministrator, error)
public static ActiveDirectoryAdministrator Get(string name, Input<string> id, ActiveDirectoryAdministratorState? state, CustomResourceOptions? opts = null)
public static ActiveDirectoryAdministrator get(String name, Output<String> id, ActiveDirectoryAdministratorState state, CustomResourceOptions options)
resources:  _:    type: azure:postgresql:ActiveDirectoryAdministrator    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Login string
The login name of the principal to set as the server administrator
ObjectId string
The ID of the principal to set as the server administrator. For a managed identity this should be the Client ID of the identity.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group for the PostgreSQL server. Changing this forces a new resource to be created.
ServerName Changes to this property will trigger replacement. string
The name of the PostgreSQL Server on which to set the administrator. Changing this forces a new resource to be created.
TenantId string
The Azure Tenant ID
Login string
The login name of the principal to set as the server administrator
ObjectId string
The ID of the principal to set as the server administrator. For a managed identity this should be the Client ID of the identity.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group for the PostgreSQL server. Changing this forces a new resource to be created.
ServerName Changes to this property will trigger replacement. string
The name of the PostgreSQL Server on which to set the administrator. Changing this forces a new resource to be created.
TenantId string
The Azure Tenant ID
login String
The login name of the principal to set as the server administrator
objectId String
The ID of the principal to set as the server administrator. For a managed identity this should be the Client ID of the identity.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group for the PostgreSQL server. Changing this forces a new resource to be created.
serverName Changes to this property will trigger replacement. String
The name of the PostgreSQL Server on which to set the administrator. Changing this forces a new resource to be created.
tenantId String
The Azure Tenant ID
login string
The login name of the principal to set as the server administrator
objectId string
The ID of the principal to set as the server administrator. For a managed identity this should be the Client ID of the identity.
resourceGroupName Changes to this property will trigger replacement. string
The name of the resource group for the PostgreSQL server. Changing this forces a new resource to be created.
serverName Changes to this property will trigger replacement. string
The name of the PostgreSQL Server on which to set the administrator. Changing this forces a new resource to be created.
tenantId string
The Azure Tenant ID
login str
The login name of the principal to set as the server administrator
object_id str
The ID of the principal to set as the server administrator. For a managed identity this should be the Client ID of the identity.
resource_group_name Changes to this property will trigger replacement. str
The name of the resource group for the PostgreSQL server. Changing this forces a new resource to be created.
server_name Changes to this property will trigger replacement. str
The name of the PostgreSQL Server on which to set the administrator. Changing this forces a new resource to be created.
tenant_id str
The Azure Tenant ID
login String
The login name of the principal to set as the server administrator
objectId String
The ID of the principal to set as the server administrator. For a managed identity this should be the Client ID of the identity.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group for the PostgreSQL server. Changing this forces a new resource to be created.
serverName Changes to this property will trigger replacement. String
The name of the PostgreSQL Server on which to set the administrator. Changing this forces a new resource to be created.
tenantId String
The Azure Tenant ID

Import

A PostgreSQL Active Directory Administrator can be imported using the resource id, e.g.

$ pulumi import azure:postgresql/activeDirectoryAdministrator:ActiveDirectoryAdministrator administrator /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.DBforPostgreSQL/servers/myserver
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure