1. Packages
  2. Azure Native
  3. API Docs
  4. dbforpostgresql
  5. getAdministrator
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.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.dbforpostgresql.getAdministrator

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.2.0 published on Monday, Apr 14, 2025 by Pulumi

Gets information about a server.

Uses Azure REST API version 2024-08-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.

Using getAdministrator

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAdministrator(args: GetAdministratorArgs, opts?: InvokeOptions): Promise<GetAdministratorResult>
function getAdministratorOutput(args: GetAdministratorOutputArgs, opts?: InvokeOptions): Output<GetAdministratorResult>
Copy
def get_administrator(object_id: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      server_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetAdministratorResult
def get_administrator_output(object_id: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      server_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetAdministratorResult]
Copy
func LookupAdministrator(ctx *Context, args *LookupAdministratorArgs, opts ...InvokeOption) (*LookupAdministratorResult, error)
func LookupAdministratorOutput(ctx *Context, args *LookupAdministratorOutputArgs, opts ...InvokeOption) LookupAdministratorResultOutput
Copy

> Note: This function is named LookupAdministrator in the Go SDK.

public static class GetAdministrator 
{
    public static Task<GetAdministratorResult> InvokeAsync(GetAdministratorArgs args, InvokeOptions? opts = null)
    public static Output<GetAdministratorResult> Invoke(GetAdministratorInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAdministratorResult> getAdministrator(GetAdministratorArgs args, InvokeOptions options)
public static Output<GetAdministratorResult> getAdministrator(GetAdministratorArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:dbforpostgresql:getAdministrator
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ObjectId
This property is required.
Changes to this property will trigger replacement.
string
Guid of the objectId for the 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
This property is required.
Changes to this property will trigger replacement.
string
Guid of the objectId for the 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
This property is required.
Changes to this property will trigger replacement.
String
Guid of the objectId for the 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
This property is required.
Changes to this property will trigger replacement.
string
Guid of the objectId for the 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.
object_id
This property is required.
Changes to this property will trigger replacement.
str
Guid of the objectId for the 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.
objectId
This property is required.
Changes to this property will trigger replacement.
String
Guid of the objectId for the 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.

getAdministrator Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
ObjectId string
The objectId of the Active Directory administrator.
PrincipalName string
Active Directory administrator principal name.
PrincipalType string
The principal type used to represent the type of Active Directory Administrator.
TenantId string
The tenantId of the Active Directory administrator.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
ObjectId string
The objectId of the Active Directory administrator.
PrincipalName string
Active Directory administrator principal name.
PrincipalType string
The principal type used to represent the type of Active Directory Administrator.
TenantId string
The tenantId of the Active Directory administrator.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
objectId String
The objectId of the Active Directory administrator.
principalName String
Active Directory administrator principal name.
principalType String
The principal type used to represent the type of Active Directory Administrator.
tenantId String
The tenantId of the Active Directory administrator.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
objectId string
The objectId of the Active Directory administrator.
principalName string
Active Directory administrator principal name.
principalType string
The principal type used to represent the type of Active Directory Administrator.
tenantId string
The tenantId of the Active Directory administrator.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
object_id str
The objectId of the Active Directory administrator.
principal_name str
Active Directory administrator principal name.
principal_type str
The principal type used to represent the type of Active Directory Administrator.
tenant_id str
The tenantId of the Active Directory administrator.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
objectId String
The objectId of the Active Directory administrator.
principalName String
Active Directory administrator principal name.
principalType String
The principal type used to represent the type of Active Directory Administrator.
tenantId String
The tenantId of the Active Directory administrator.

Supporting Types

SystemDataResponse

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.

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.2.0 published on Monday, Apr 14, 2025 by Pulumi