Azure Classic

v5.24.0 published on Wednesday, Nov 9, 2022 by Pulumi

getServer

Use this data source to access information about an existing PostgreSQL Azure Database Server.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.PostgreSql.GetServer.Invoke(new()
    {
        Name = "postgresql-server-1",
        ResourceGroupName = "api-rg-pro",
    });

    return new Dictionary<string, object?>
    {
        ["postgresqlServerId"] = example.Apply(getServerResult => getServerResult.Id),
    };
});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := postgresql.LookupServer(ctx, &postgresql.LookupServerArgs{
			Name:              "postgresql-server-1",
			ResourceGroupName: "api-rg-pro",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("postgresqlServerId", example.Id)
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.postgresql.PostgresqlFunctions;
import com.pulumi.azure.mssql.inputs.GetServerArgs;
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 example = PostgresqlFunctions.getServer(GetServerArgs.builder()
            .name("postgresql-server-1")
            .resourceGroupName("api-rg-pro")
            .build());

        ctx.export("postgresqlServerId", example.applyValue(getServerResult -> getServerResult.id()));
    }
}
import pulumi
import pulumi_azure as azure

example = azure.postgresql.get_server(name="postgresql-server-1",
    resource_group_name="api-rg-pro")
pulumi.export("postgresqlServerId", example.id)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.postgresql.getServer({
    name: "postgresql-server-1",
    resourceGroupName: "api-rg-pro",
});
export const postgresqlServerId = example.then(example => example.id);
variables:
  example:
    Fn::Invoke:
      Function: azure:postgresql:getServer
      Arguments:
        name: postgresql-server-1
        resourceGroupName: api-rg-pro
outputs:
  postgresqlServerId: ${example.id}

Using getServer

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 getServer(args: GetServerArgs, opts?: InvokeOptions): Promise<GetServerResult>
function getServerOutput(args: GetServerOutputArgs, opts?: InvokeOptions): Output<GetServerResult>
def get_server(name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetServerResult
def get_server_output(name: Optional[pulumi.Input[str]] = None,
               resource_group_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetServerResult]
func LookupServer(ctx *Context, args *LookupServerArgs, opts ...InvokeOption) (*LookupServerResult, error)
func LookupServerOutput(ctx *Context, args *LookupServerOutputArgs, opts ...InvokeOption) LookupServerResultOutput

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

public static class GetServer 
{
    public static Task<GetServerResult> InvokeAsync(GetServerArgs args, InvokeOptions? opts = null)
    public static Output<GetServerResult> Invoke(GetServerInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure:postgresql/getServer:getServer
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string

The name of the PostgreSQL Server.

ResourceGroupName string

Specifies the name of the Resource Group where the PostgreSQL Server exists.

Name string

The name of the PostgreSQL Server.

ResourceGroupName string

Specifies the name of the Resource Group where the PostgreSQL Server exists.

name String

The name of the PostgreSQL Server.

resourceGroupName String

Specifies the name of the Resource Group where the PostgreSQL Server exists.

name string

The name of the PostgreSQL Server.

resourceGroupName string

Specifies the name of the Resource Group where the PostgreSQL Server exists.

name str

The name of the PostgreSQL Server.

resource_group_name str

Specifies the name of the Resource Group where the PostgreSQL Server exists.

name String

The name of the PostgreSQL Server.

resourceGroupName String

Specifies the name of the Resource Group where the PostgreSQL Server exists.

getServer Result

The following output properties are available:

AdministratorLogin string

The administrator username of the PostgreSQL Server.

Fqdn string

The fully qualified domain name of the PostgreSQL Server.

Id string

The provider-assigned unique ID for this managed resource.

Identities List<GetServerIdentity>

An identity block as defined below.

Location string

The location of the Resource Group in which the PostgreSQL Server exists.

Name string
ResourceGroupName string
SkuName string

The SKU name of the PostgreSQL Server.

Tags Dictionary<string, string>

A mapping of tags assigned to the resource.

Version string

The version of the PostgreSQL Server.

AdministratorLogin string

The administrator username of the PostgreSQL Server.

Fqdn string

The fully qualified domain name of the PostgreSQL Server.

Id string

The provider-assigned unique ID for this managed resource.

Identities []GetServerIdentity

An identity block as defined below.

Location string

The location of the Resource Group in which the PostgreSQL Server exists.

Name string
ResourceGroupName string
SkuName string

The SKU name of the PostgreSQL Server.

Tags map[string]string

A mapping of tags assigned to the resource.

Version string

The version of the PostgreSQL Server.

administratorLogin String

The administrator username of the PostgreSQL Server.

fqdn String

The fully qualified domain name of the PostgreSQL Server.

id String

The provider-assigned unique ID for this managed resource.

identities List<GetServerIdentity>

An identity block as defined below.

location String

The location of the Resource Group in which the PostgreSQL Server exists.

name String
resourceGroupName String
skuName String

The SKU name of the PostgreSQL Server.

tags Map<String,String>

A mapping of tags assigned to the resource.

version String

The version of the PostgreSQL Server.

administratorLogin string

The administrator username of the PostgreSQL Server.

fqdn string

The fully qualified domain name of the PostgreSQL Server.

id string

The provider-assigned unique ID for this managed resource.

identities GetServerIdentity[]

An identity block as defined below.

location string

The location of the Resource Group in which the PostgreSQL Server exists.

name string
resourceGroupName string
skuName string

The SKU name of the PostgreSQL Server.

tags {[key: string]: string}

A mapping of tags assigned to the resource.

version string

The version of the PostgreSQL Server.

administrator_login str

The administrator username of the PostgreSQL Server.

fqdn str

The fully qualified domain name of the PostgreSQL Server.

id str

The provider-assigned unique ID for this managed resource.

identities Sequence[GetServerIdentity]

An identity block as defined below.

location str

The location of the Resource Group in which the PostgreSQL Server exists.

name str
resource_group_name str
sku_name str

The SKU name of the PostgreSQL Server.

tags Mapping[str, str]

A mapping of tags assigned to the resource.

version str

The version of the PostgreSQL Server.

administratorLogin String

The administrator username of the PostgreSQL Server.

fqdn String

The fully qualified domain name of the PostgreSQL Server.

id String

The provider-assigned unique ID for this managed resource.

identities List<Property Map>

An identity block as defined below.

location String

The location of the Resource Group in which the PostgreSQL Server exists.

name String
resourceGroupName String
skuName String

The SKU name of the PostgreSQL Server.

tags Map<String>

A mapping of tags assigned to the resource.

version String

The version of the PostgreSQL Server.

Supporting Types

GetServerIdentity

PrincipalId string

The ID of the System Managed Service Principal assigned to the PostgreSQL Server.

TenantId string

The ID of the Tenant of the System Managed Service Principal assigned to the PostgreSQL Server.

Type string

The identity type of the Managed Identity assigned to the PostgreSQL Server.

PrincipalId string

The ID of the System Managed Service Principal assigned to the PostgreSQL Server.

TenantId string

The ID of the Tenant of the System Managed Service Principal assigned to the PostgreSQL Server.

Type string

The identity type of the Managed Identity assigned to the PostgreSQL Server.

principalId String

The ID of the System Managed Service Principal assigned to the PostgreSQL Server.

tenantId String

The ID of the Tenant of the System Managed Service Principal assigned to the PostgreSQL Server.

type String

The identity type of the Managed Identity assigned to the PostgreSQL Server.

principalId string

The ID of the System Managed Service Principal assigned to the PostgreSQL Server.

tenantId string

The ID of the Tenant of the System Managed Service Principal assigned to the PostgreSQL Server.

type string

The identity type of the Managed Identity assigned to the PostgreSQL Server.

principal_id str

The ID of the System Managed Service Principal assigned to the PostgreSQL Server.

tenant_id str

The ID of the Tenant of the System Managed Service Principal assigned to the PostgreSQL Server.

type str

The identity type of the Managed Identity assigned to the PostgreSQL Server.

principalId String

The ID of the System Managed Service Principal assigned to the PostgreSQL Server.

tenantId String

The ID of the Tenant of the System Managed Service Principal assigned to the PostgreSQL Server.

type String

The identity type of the Managed Identity assigned to the PostgreSQL Server.

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.