We recommend using Azure Native.
Azure v6.31.0 published on Monday, Dec 29, 2025 by Pulumi
Allows you to set a user or group as the AD administrator for a PostgreSQL Flexible Server.
Create FlexibleServerActiveDirectoryAdministrator Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FlexibleServerActiveDirectoryAdministrator(name: string, args: FlexibleServerActiveDirectoryAdministratorArgs, opts?: CustomResourceOptions);@overload
def FlexibleServerActiveDirectoryAdministrator(resource_name: str,
args: FlexibleServerActiveDirectoryAdministratorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def FlexibleServerActiveDirectoryAdministrator(resource_name: str,
opts: Optional[ResourceOptions] = None,
object_id: Optional[str] = None,
principal_name: Optional[str] = None,
principal_type: Optional[str] = None,
resource_group_name: Optional[str] = None,
server_name: Optional[str] = None,
tenant_id: Optional[str] = None)func NewFlexibleServerActiveDirectoryAdministrator(ctx *Context, name string, args FlexibleServerActiveDirectoryAdministratorArgs, opts ...ResourceOption) (*FlexibleServerActiveDirectoryAdministrator, error)public FlexibleServerActiveDirectoryAdministrator(string name, FlexibleServerActiveDirectoryAdministratorArgs args, CustomResourceOptions? opts = null)
public FlexibleServerActiveDirectoryAdministrator(String name, FlexibleServerActiveDirectoryAdministratorArgs args)
public FlexibleServerActiveDirectoryAdministrator(String name, FlexibleServerActiveDirectoryAdministratorArgs args, CustomResourceOptions options)
type: azure:postgresql:FlexibleServerActiveDirectoryAdministrator
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args FlexibleServerActiveDirectoryAdministratorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FlexibleServerActiveDirectoryAdministratorArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FlexibleServerActiveDirectoryAdministratorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FlexibleServerActiveDirectoryAdministratorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FlexibleServerActiveDirectoryAdministratorArgs
- 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 flexibleServerActiveDirectoryAdministratorResource = new Azure.PostgreSql.FlexibleServerActiveDirectoryAdministrator("flexibleServerActiveDirectoryAdministratorResource", new()
{
ObjectId = "string",
PrincipalName = "string",
PrincipalType = "string",
ResourceGroupName = "string",
ServerName = "string",
TenantId = "string",
});
example, err := postgresql.NewFlexibleServerActiveDirectoryAdministrator(ctx, "flexibleServerActiveDirectoryAdministratorResource", &postgresql.FlexibleServerActiveDirectoryAdministratorArgs{
ObjectId: pulumi.String("string"),
PrincipalName: pulumi.String("string"),
PrincipalType: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
ServerName: pulumi.String("string"),
TenantId: pulumi.String("string"),
})
var flexibleServerActiveDirectoryAdministratorResource = new FlexibleServerActiveDirectoryAdministrator("flexibleServerActiveDirectoryAdministratorResource", FlexibleServerActiveDirectoryAdministratorArgs.builder()
.objectId("string")
.principalName("string")
.principalType("string")
.resourceGroupName("string")
.serverName("string")
.tenantId("string")
.build());
flexible_server_active_directory_administrator_resource = azure.postgresql.FlexibleServerActiveDirectoryAdministrator("flexibleServerActiveDirectoryAdministratorResource",
object_id="string",
principal_name="string",
principal_type="string",
resource_group_name="string",
server_name="string",
tenant_id="string")
const flexibleServerActiveDirectoryAdministratorResource = new azure.postgresql.FlexibleServerActiveDirectoryAdministrator("flexibleServerActiveDirectoryAdministratorResource", {
objectId: "string",
principalName: "string",
principalType: "string",
resourceGroupName: "string",
serverName: "string",
tenantId: "string",
});
type: azure:postgresql:FlexibleServerActiveDirectoryAdministrator
properties:
objectId: string
principalName: string
principalType: string
resourceGroupName: string
serverName: string
tenantId: string
FlexibleServerActiveDirectoryAdministrator 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 FlexibleServerActiveDirectoryAdministrator resource accepts the following input properties:
- Object
Id string - The object ID of a user, service principal or security group in the Azure Active Directory tenant set as the Flexible Server Admin. Changing this forces a new resource to be created.
- Principal
Name string - The name of Azure Active Directory principal. Changing this forces a new resource to be created.
- Principal
Type string - The type of Azure Active Directory principal. Possible values are
Group,ServicePrincipalandUser. Changing this forces a new resource to be created. - Resource
Group stringName - The name of the resource group for the PostgreSQL Server. Changing this forces a new resource to be created.
- Server
Name string - The name of the PostgreSQL Flexible Server on which to set the administrator. Changing this forces a new resource to be created.
- Tenant
Id string - The Azure Tenant ID. Changing this forces a new resource to be created.
- Object
Id string - The object ID of a user, service principal or security group in the Azure Active Directory tenant set as the Flexible Server Admin. Changing this forces a new resource to be created.
- Principal
Name string - The name of Azure Active Directory principal. Changing this forces a new resource to be created.
- Principal
Type string - The type of Azure Active Directory principal. Possible values are
Group,ServicePrincipalandUser. Changing this forces a new resource to be created. - Resource
Group stringName - The name of the resource group for the PostgreSQL Server. Changing this forces a new resource to be created.
- Server
Name string - The name of the PostgreSQL Flexible Server on which to set the administrator. Changing this forces a new resource to be created.
- Tenant
Id string - The Azure Tenant ID. Changing this forces a new resource to be created.
- object
Id String - The object ID of a user, service principal or security group in the Azure Active Directory tenant set as the Flexible Server Admin. Changing this forces a new resource to be created.
- principal
Name String - The name of Azure Active Directory principal. Changing this forces a new resource to be created.
- principal
Type String - The type of Azure Active Directory principal. Possible values are
Group,ServicePrincipalandUser. Changing this forces a new resource to be created. - resource
Group StringName - The name of the resource group for the PostgreSQL Server. Changing this forces a new resource to be created.
- server
Name String - The name of the PostgreSQL Flexible Server on which to set the administrator. Changing this forces a new resource to be created.
- tenant
Id String - The Azure Tenant ID. Changing this forces a new resource to be created.
- object
Id string - The object ID of a user, service principal or security group in the Azure Active Directory tenant set as the Flexible Server Admin. Changing this forces a new resource to be created.
- principal
Name string - The name of Azure Active Directory principal. Changing this forces a new resource to be created.
- principal
Type string - The type of Azure Active Directory principal. Possible values are
Group,ServicePrincipalandUser. Changing this forces a new resource to be created. - resource
Group stringName - The name of the resource group for the PostgreSQL Server. Changing this forces a new resource to be created.
- server
Name string - The name of the PostgreSQL Flexible Server on which to set the administrator. Changing this forces a new resource to be created.
- tenant
Id string - The Azure Tenant ID. Changing this forces a new resource to be created.
- object_
id str - The object ID of a user, service principal or security group in the Azure Active Directory tenant set as the Flexible Server Admin. Changing this forces a new resource to be created.
- principal_
name str - The name of Azure Active Directory principal. Changing this forces a new resource to be created.
- principal_
type str - The type of Azure Active Directory principal. Possible values are
Group,ServicePrincipalandUser. Changing this forces a new resource to be created. - resource_
group_ strname - The name of the resource group for the PostgreSQL Server. Changing this forces a new resource to be created.
- server_
name str - The name of the PostgreSQL Flexible Server on which to set the administrator. Changing this forces a new resource to be created.
- tenant_
id str - The Azure Tenant ID. Changing this forces a new resource to be created.
- object
Id String - The object ID of a user, service principal or security group in the Azure Active Directory tenant set as the Flexible Server Admin. Changing this forces a new resource to be created.
- principal
Name String - The name of Azure Active Directory principal. Changing this forces a new resource to be created.
- principal
Type String - The type of Azure Active Directory principal. Possible values are
Group,ServicePrincipalandUser. Changing this forces a new resource to be created. - resource
Group StringName - The name of the resource group for the PostgreSQL Server. Changing this forces a new resource to be created.
- server
Name String - The name of the PostgreSQL Flexible Server on which to set the administrator. Changing this forces a new resource to be created.
- tenant
Id String - The Azure Tenant ID. Changing this forces a new resource to be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the FlexibleServerActiveDirectoryAdministrator 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 FlexibleServerActiveDirectoryAdministrator Resource
Get an existing FlexibleServerActiveDirectoryAdministrator 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?: FlexibleServerActiveDirectoryAdministratorState, opts?: CustomResourceOptions): FlexibleServerActiveDirectoryAdministrator@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
object_id: Optional[str] = None,
principal_name: Optional[str] = None,
principal_type: Optional[str] = None,
resource_group_name: Optional[str] = None,
server_name: Optional[str] = None,
tenant_id: Optional[str] = None) -> FlexibleServerActiveDirectoryAdministratorfunc GetFlexibleServerActiveDirectoryAdministrator(ctx *Context, name string, id IDInput, state *FlexibleServerActiveDirectoryAdministratorState, opts ...ResourceOption) (*FlexibleServerActiveDirectoryAdministrator, error)public static FlexibleServerActiveDirectoryAdministrator Get(string name, Input<string> id, FlexibleServerActiveDirectoryAdministratorState? state, CustomResourceOptions? opts = null)public static FlexibleServerActiveDirectoryAdministrator get(String name, Output<String> id, FlexibleServerActiveDirectoryAdministratorState state, CustomResourceOptions options)resources: _: type: azure:postgresql:FlexibleServerActiveDirectoryAdministrator get: id: ${id}- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Object
Id string - The object ID of a user, service principal or security group in the Azure Active Directory tenant set as the Flexible Server Admin. Changing this forces a new resource to be created.
- Principal
Name string - The name of Azure Active Directory principal. Changing this forces a new resource to be created.
- Principal
Type string - The type of Azure Active Directory principal. Possible values are
Group,ServicePrincipalandUser. Changing this forces a new resource to be created. - Resource
Group stringName - The name of the resource group for the PostgreSQL Server. Changing this forces a new resource to be created.
- Server
Name string - The name of the PostgreSQL Flexible Server on which to set the administrator. Changing this forces a new resource to be created.
- Tenant
Id string - The Azure Tenant ID. Changing this forces a new resource to be created.
- Object
Id string - The object ID of a user, service principal or security group in the Azure Active Directory tenant set as the Flexible Server Admin. Changing this forces a new resource to be created.
- Principal
Name string - The name of Azure Active Directory principal. Changing this forces a new resource to be created.
- Principal
Type string - The type of Azure Active Directory principal. Possible values are
Group,ServicePrincipalandUser. Changing this forces a new resource to be created. - Resource
Group stringName - The name of the resource group for the PostgreSQL Server. Changing this forces a new resource to be created.
- Server
Name string - The name of the PostgreSQL Flexible Server on which to set the administrator. Changing this forces a new resource to be created.
- Tenant
Id string - The Azure Tenant ID. Changing this forces a new resource to be created.
- object
Id String - The object ID of a user, service principal or security group in the Azure Active Directory tenant set as the Flexible Server Admin. Changing this forces a new resource to be created.
- principal
Name String - The name of Azure Active Directory principal. Changing this forces a new resource to be created.
- principal
Type String - The type of Azure Active Directory principal. Possible values are
Group,ServicePrincipalandUser. Changing this forces a new resource to be created. - resource
Group StringName - The name of the resource group for the PostgreSQL Server. Changing this forces a new resource to be created.
- server
Name String - The name of the PostgreSQL Flexible Server on which to set the administrator. Changing this forces a new resource to be created.
- tenant
Id String - The Azure Tenant ID. Changing this forces a new resource to be created.
- object
Id string - The object ID of a user, service principal or security group in the Azure Active Directory tenant set as the Flexible Server Admin. Changing this forces a new resource to be created.
- principal
Name string - The name of Azure Active Directory principal. Changing this forces a new resource to be created.
- principal
Type string - The type of Azure Active Directory principal. Possible values are
Group,ServicePrincipalandUser. Changing this forces a new resource to be created. - resource
Group stringName - The name of the resource group for the PostgreSQL Server. Changing this forces a new resource to be created.
- server
Name string - The name of the PostgreSQL Flexible Server on which to set the administrator. Changing this forces a new resource to be created.
- tenant
Id string - The Azure Tenant ID. Changing this forces a new resource to be created.
- object_
id str - The object ID of a user, service principal or security group in the Azure Active Directory tenant set as the Flexible Server Admin. Changing this forces a new resource to be created.
- principal_
name str - The name of Azure Active Directory principal. Changing this forces a new resource to be created.
- principal_
type str - The type of Azure Active Directory principal. Possible values are
Group,ServicePrincipalandUser. Changing this forces a new resource to be created. - resource_
group_ strname - The name of the resource group for the PostgreSQL Server. Changing this forces a new resource to be created.
- server_
name str - The name of the PostgreSQL Flexible Server on which to set the administrator. Changing this forces a new resource to be created.
- tenant_
id str - The Azure Tenant ID. Changing this forces a new resource to be created.
- object
Id String - The object ID of a user, service principal or security group in the Azure Active Directory tenant set as the Flexible Server Admin. Changing this forces a new resource to be created.
- principal
Name String - The name of Azure Active Directory principal. Changing this forces a new resource to be created.
- principal
Type String - The type of Azure Active Directory principal. Possible values are
Group,ServicePrincipalandUser. Changing this forces a new resource to be created. - resource
Group StringName - The name of the resource group for the PostgreSQL Server. Changing this forces a new resource to be created.
- server
Name String - The name of the PostgreSQL Flexible Server on which to set the administrator. Changing this forces a new resource to be created.
- tenant
Id String - The Azure Tenant ID. Changing this forces a new resource to be created.
Import
A PostgreSQL Flexible Server Active Directory Administrator can be imported using the resource id, e.g.
$ pulumi import azure:postgresql/flexibleServerActiveDirectoryAdministrator:FlexibleServerActiveDirectoryAdministrator example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/myserver/administrators/objectId
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
azurermTerraform Provider.
