azure-native.dbforpostgresql.Administrator
Explore with Pulumi AI
Represents an Active Directory administrator. Azure REST API version: 2022-12-01.
Other available API versions: 2023-03-01-preview, 2023-06-01-preview, 2023-12-01-preview.
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 = AzureNative.DBforPostgreSQL.PrincipalType.User,
ResourceGroupName = "testrg",
ServerName = "testserver",
TenantId = "tttttttt-tttt-tttt-tttt-tttttttttttt",
});
});
package main
import (
dbforpostgresql "github.com/pulumi/pulumi-azure-native-sdk/dbforpostgresql/v2"
"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(dbforpostgresql.PrincipalTypeUser),
ResourceGroupName: pulumi.String("testrg"),
ServerName: pulumi.String("testserver"),
TenantId: pulumi.String("tttttttt-tttt-tttt-tttt-tttttttttttt"),
})
if err != nil {
return err
}
return nil
})
}
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());
}
}
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=azure_native.dbforpostgresql.PrincipalType.USER,
resource_group_name="testrg",
server_name="testserver",
tenant_id="tttttttt-tttt-tttt-tttt-tttttttttttt")
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: azure_native.dbforpostgresql.PrincipalType.User,
resourceGroupName: "testrg",
serverName: "testserver",
tenantId: "tttttttt-tttt-tttt-tttt-tttttttttttt",
});
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
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 string
- The unique name of the resource.
- args AdministratorArgs
- 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 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 string
- The unique name of the resource.
- args AdministratorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AdministratorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
});
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"),
})
var administratorResource = new Administrator("administratorResource", AdministratorArgs.builder()
.resourceGroupName("string")
.serverName("string")
.objectId("string")
.principalName("string")
.principalType("string")
.tenantId("string")
.build());
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")
const administratorResource = new azure_native.dbforpostgresql.Administrator("administratorResource", {
resourceGroupName: "string",
serverName: "string",
objectId: "string",
principalName: "string",
principalType: "string",
tenantId: "string",
});
type: azure-native:dbforpostgresql:Administrator
properties:
objectId: string
principalName: string
principalType: string
resourceGroupName: string
serverName: string
tenantId: string
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
The Administrator resource accepts the following input properties:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Server
Name string - The name of the server.
- Object
Id string - Guid of the objectId for the administrator.
- Principal
Name string - Active Directory administrator principal name.
- Principal
Type string | Pulumi.Azure Native. DBfor Postgre SQL. Principal Type - The principal type used to represent the type of Active Directory Administrator.
- Tenant
Id string - The tenantId of the Active Directory administrator.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Server
Name string - The name of the server.
- Object
Id string - Guid of the objectId for the administrator.
- Principal
Name string - Active Directory administrator principal name.
- Principal
Type string | PrincipalType - The principal type used to represent the type of Active Directory Administrator.
- Tenant
Id string - The tenantId of the Active Directory administrator.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- server
Name String - The name of the server.
- object
Id String - Guid of the objectId for the administrator.
- principal
Name String - Active Directory administrator principal name.
- principal
Type String | PrincipalType - The principal type used to represent the type of Active Directory Administrator.
- tenant
Id String - The tenantId of the Active Directory administrator.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- server
Name string - The name of the server.
- object
Id string - Guid of the objectId for the administrator.
- principal
Name string - Active Directory administrator principal name.
- principal
Type string | PrincipalType - The principal type used to represent the type of Active Directory Administrator.
- tenant
Id string - The tenantId of the Active Directory administrator.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- server_
name str - The name of the server.
- object_
id 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.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- server
Name String - The name of the server.
- object
Id String - Guid of the objectId for the administrator.
- principal
Name String - Active Directory administrator principal name.
- principal
Type String | "Unknown" | "User" | "Group" | "ServicePrincipal" - The principal type used to represent the type of Active Directory Administrator.
- tenant
Id 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:
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data Pulumi.Azure Native. DBfor Postgre SQL. Outputs. System Data Response - 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"
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data SystemData Response - 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"
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data SystemData Response - 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"
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- system
Data SystemData Response - 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"
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- system_
data SystemData Response - 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"
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data 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
- Unknown
- Unknown
- User
- User
- Group
- Group
- Service
Principal - ServicePrincipal
- Principal
Type Unknown - Unknown
- Principal
Type User - User
- Principal
Type Group - Group
- Principal
Type Service Principal - ServicePrincipal
- Unknown
- Unknown
- User
- User
- Group
- Group
- Service
Principal - ServicePrincipal
- Unknown
- Unknown
- User
- User
- Group
- Group
- Service
Principal - ServicePrincipal
- UNKNOWN
- Unknown
- USER
- User
- GROUP
- Group
- SERVICE_PRINCIPAL
- ServicePrincipal
- "Unknown"
- Unknown
- "User"
- User
- "Group"
- Group
- "Service
Principal" - ServicePrincipal
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - 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}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0