Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. dbforpostgresql
  5. Administrator
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.dbforpostgresql.Administrator

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Represents an Active Directory administrator.

Uses Azure REST API version 2024-08-01. In version 2.x of the Azure Native provider, it used API version 2022-12-01.

Other available API versions: 2022-12-01, 2023-03-01-preview, 2023-06-01-preview, 2023-12-01-preview, 2024-03-01-preview, 2024-11-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native dbforpostgresql [ApiVersion]. See the version guide for details.

Example Usage

Adds an Active DIrectory Administrator for the server

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var administrator = new AzureNative.DBforPostgreSQL.Administrator("administrator", new()
    {
        ObjectId = "oooooooo-oooo-oooo-oooo-oooooooooooo",
        PrincipalName = "testuser1@microsoft.com",
        PrincipalType = "User",
        ResourceGroupName = "testrg",
        ServerName = "testserver",
        TenantId = "tttttttt-tttt-tttt-tttt-tttttttttttt",
    });

});
Copy
package main

import (
	dbforpostgresql "github.com/pulumi/pulumi-azure-native-sdk/dbforpostgresql/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dbforpostgresql.NewAdministrator(ctx, "administrator", &dbforpostgresql.AdministratorArgs{
			ObjectId:          pulumi.String("oooooooo-oooo-oooo-oooo-oooooooooooo"),
			PrincipalName:     pulumi.String("testuser1@microsoft.com"),
			PrincipalType:     pulumi.String("User"),
			ResourceGroupName: pulumi.String("testrg"),
			ServerName:        pulumi.String("testserver"),
			TenantId:          pulumi.String("tttttttt-tttt-tttt-tttt-tttttttttttt"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.dbforpostgresql.Administrator;
import com.pulumi.azurenative.dbforpostgresql.AdministratorArgs;
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) {
        var administrator = new Administrator("administrator", AdministratorArgs.builder()
            .objectId("oooooooo-oooo-oooo-oooo-oooooooooooo")
            .principalName("testuser1@microsoft.com")
            .principalType("User")
            .resourceGroupName("testrg")
            .serverName("testserver")
            .tenantId("tttttttt-tttt-tttt-tttt-tttttttttttt")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const administrator = new azure_native.dbforpostgresql.Administrator("administrator", {
    objectId: "oooooooo-oooo-oooo-oooo-oooooooooooo",
    principalName: "testuser1@microsoft.com",
    principalType: "User",
    resourceGroupName: "testrg",
    serverName: "testserver",
    tenantId: "tttttttt-tttt-tttt-tttt-tttttttttttt",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

administrator = azure_native.dbforpostgresql.Administrator("administrator",
    object_id="oooooooo-oooo-oooo-oooo-oooooooooooo",
    principal_name="testuser1@microsoft.com",
    principal_type="User",
    resource_group_name="testrg",
    server_name="testserver",
    tenant_id="tttttttt-tttt-tttt-tttt-tttttttttttt")
Copy
resources:
  administrator:
    type: azure-native:dbforpostgresql:Administrator
    properties:
      objectId: oooooooo-oooo-oooo-oooo-oooooooooooo
      principalName: testuser1@microsoft.com
      principalType: User
      resourceGroupName: testrg
      serverName: testserver
      tenantId: tttttttt-tttt-tttt-tttt-tttttttttttt
Copy

Create Administrator Resource

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

Constructor syntax

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

@overload
def Administrator(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  resource_group_name: Optional[str] = None,
                  server_name: Optional[str] = None,
                  object_id: Optional[str] = None,
                  principal_name: Optional[str] = None,
                  principal_type: Optional[Union[str, PrincipalType]] = None,
                  tenant_id: Optional[str] = None)
func NewAdministrator(ctx *Context, name string, args AdministratorArgs, opts ...ResourceOption) (*Administrator, error)
public Administrator(string name, AdministratorArgs args, CustomResourceOptions? opts = null)
public Administrator(String name, AdministratorArgs args)
public Administrator(String name, AdministratorArgs args, CustomResourceOptions options)

type: azure-native:dbforpostgresql:Administrator
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. AdministratorArgs
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. AdministratorArgs
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. AdministratorArgs
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. AdministratorArgs
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. AdministratorArgs
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 administratorResource = new AzureNative.DBforPostgreSQL.Administrator("administratorResource", new()
{
    ResourceGroupName = "string",
    ServerName = "string",
    ObjectId = "string",
    PrincipalName = "string",
    PrincipalType = "string",
    TenantId = "string",
});
Copy
example, err := dbforpostgresql.NewAdministrator(ctx, "administratorResource", &dbforpostgresql.AdministratorArgs{
	ResourceGroupName: pulumi.String("string"),
	ServerName:        pulumi.String("string"),
	ObjectId:          pulumi.String("string"),
	PrincipalName:     pulumi.String("string"),
	PrincipalType:     pulumi.String("string"),
	TenantId:          pulumi.String("string"),
})
Copy
var administratorResource = new Administrator("administratorResource", AdministratorArgs.builder()
    .resourceGroupName("string")
    .serverName("string")
    .objectId("string")
    .principalName("string")
    .principalType("string")
    .tenantId("string")
    .build());
Copy
administrator_resource = azure_native.dbforpostgresql.Administrator("administratorResource",
    resource_group_name="string",
    server_name="string",
    object_id="string",
    principal_name="string",
    principal_type="string",
    tenant_id="string")
Copy
const administratorResource = new azure_native.dbforpostgresql.Administrator("administratorResource", {
    resourceGroupName: "string",
    serverName: "string",
    objectId: "string",
    principalName: "string",
    principalType: "string",
    tenantId: "string",
});
Copy
type: azure-native:dbforpostgresql:Administrator
properties:
    objectId: string
    principalName: string
    principalType: string
    resourceGroupName: string
    serverName: string
    tenantId: string
Copy

Administrator 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 Administrator resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
ObjectId Changes to this property will trigger replacement. string
Guid of the objectId for the administrator.
PrincipalName string
Active Directory administrator principal name.
PrincipalType string | Pulumi.AzureNative.DBforPostgreSQL.PrincipalType
The principal type used to represent the type of Active Directory Administrator.
TenantId string
The tenantId of the Active Directory administrator.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
ObjectId Changes to this property will trigger replacement. string
Guid of the objectId for the administrator.
PrincipalName string
Active Directory administrator principal name.
PrincipalType string | PrincipalType
The principal type used to represent the type of Active Directory Administrator.
TenantId string
The tenantId of the Active Directory administrator.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
objectId Changes to this property will trigger replacement. String
Guid of the objectId for the administrator.
principalName String
Active Directory administrator principal name.
principalType String | PrincipalType
The principal type used to represent the type of Active Directory Administrator.
tenantId String
The tenantId of the Active Directory administrator.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
objectId Changes to this property will trigger replacement. string
Guid of the objectId for the administrator.
principalName string
Active Directory administrator principal name.
principalType string | PrincipalType
The principal type used to represent the type of Active Directory Administrator.
tenantId string
The tenantId of the Active Directory administrator.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
server_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the server.
object_id Changes to this property will trigger replacement. str
Guid of the objectId for the administrator.
principal_name str
Active Directory administrator principal name.
principal_type str | PrincipalType
The principal type used to represent the type of Active Directory Administrator.
tenant_id str
The tenantId of the Active Directory administrator.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
objectId Changes to this property will trigger replacement. String
Guid of the objectId for the administrator.
principalName String
Active Directory administrator principal name.
principalType String | "user" | "servicePrincipal" | "group"
The principal type used to represent the type of Active Directory Administrator.
tenantId String
The tenantId of the Active Directory administrator.

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
SystemData Pulumi.AzureNative.DBforPostgreSQL.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

PrincipalType
, PrincipalTypeArgs

User
user
ServicePrincipal
servicePrincipal
@Group
group
PrincipalTypeUser
user
PrincipalTypeServicePrincipal
servicePrincipal
PrincipalTypeGroup
group
User
user
ServicePrincipal
servicePrincipal
Group
group
User
user
ServicePrincipal
servicePrincipal
Group
group
USER
user
SERVICE_PRINCIPAL
servicePrincipal
GROUP
group
"user"
user
"servicePrincipal"
servicePrincipal
"group"
group

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:dbforpostgresql:Administrator testuser1@microsoft.com /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/administrators/{objectId}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native