1. Docs
  2. Reference
  3. API
  4. Azure
  5. sql
  6. GetServer

GetServer

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

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.Sql.GetServer.InvokeAsync(new Azure.Sql.GetServerArgs
        {
            Name = "examplesqlservername",
            ResourceGroupName = "example-resources",
        }));
        this.SqlServerId = example.Apply(example => example.Id);
    }

    [Output("sqlServerId")]
    public Output<string> SqlServerId { get; set; }
}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/sql"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        example, err := sql.GetServer(ctx, &sql.GetServerArgs{
            Name:              "examplesqlservername",
            ResourceGroupName: "example-resources",
        }, nil)
        if err != nil {
            return err
        }
        ctx.Export("sqlServerId", example.Id)
        return nil
    })
}
import pulumi
import pulumi_azure as azure

example = azure.sql.get_server(name="examplesqlservername",
    resource_group_name="example-resources")
pulumi.export("sqlServerId", example.id)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.sql.getServer({
    name: "examplesqlservername",
    resourceGroupName: "example-resources",
});
export const sqlServerId = example.then(example => example.id);

Using GetServer

function getServer(args: GetServerArgs, opts?: InvokeOptions): Promise<GetServerResult>
function  get_server(name=None, resource_group_name=None, opts=None)
func GetServer(ctx *Context, args *GetServerArgs, opts ...InvokeOption) (*GetServerResult, error)
public static class GetServer {
    public static Task<GetServerResult> InvokeAsync(GetServerArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string

The name of the SQL Server.

ResourceGroupName string

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

Name string

The name of the SQL Server.

ResourceGroupName string

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

name string

The name of the SQL Server.

resourceGroupName string

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

name str

The name of the SQL Server.

resource_group_name str

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

GetServer Result

The following output properties are available:

AdministratorLogin string

The administrator username of the SQL Server.

Fqdn string

The fully qualified domain name of the SQL 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 SQL Server exists.

Name string
ResourceGroupName string
Tags Dictionary<string, string>

A mapping of tags assigned to the resource.

Version string

The version of the SQL Server.

AdministratorLogin string

The administrator username of the SQL Server.

Fqdn string

The fully qualified domain name of the SQL 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 SQL Server exists.

Name string
ResourceGroupName string
Tags map[string]string

A mapping of tags assigned to the resource.

Version string

The version of the SQL Server.

administratorLogin string

The administrator username of the SQL Server.

fqdn string

The fully qualified domain name of the SQL 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 SQL Server exists.

name string
resourceGroupName string
tags {[key: string]: string}

A mapping of tags assigned to the resource.

version string

The version of the SQL Server.

administrator_login str

The administrator username of the SQL Server.

fqdn str

The fully qualified domain name of the SQL Server.

id str

The provider-assigned unique ID for this managed resource.

identities List[GetServerIdentity]

An identity block as defined below.

location str

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

name str
resource_group_name str
tags Dict[str, str]

A mapping of tags assigned to the resource.

version str

The version of the SQL Server.

Supporting Types

GetServerIdentity

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

PrincipalId string

The ID of the Principal (Client) in Azure Active Directory.

TenantId string

The ID of the Azure Active Directory Tenant.

Type string

The identity type of the SQL Server.

PrincipalId string

The ID of the Principal (Client) in Azure Active Directory.

TenantId string

The ID of the Azure Active Directory Tenant.

Type string

The identity type of the SQL Server.

principalId string

The ID of the Principal (Client) in Azure Active Directory.

tenantId string

The ID of the Azure Active Directory Tenant.

type string

The identity type of the SQL Server.

principal_id str

The ID of the Principal (Client) in Azure Active Directory.

tenant_id str

The ID of the Azure Active Directory Tenant.

type str

The identity type of the SQL 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.