1. Packages
  2. Azure Classic
  3. API Docs
  4. sql
  5. getServer

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.sql.getServer

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    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/v4/go/azure/sql"
	"github.com/pulumi/pulumi/sdk/v3/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
	})
}

    Example coming soon!

    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);

    import pulumi
import pulumi_azure as azure

example = azure.sql.get_server(name="examplesqlservername",
    resource_group_name="example-resources")
pulumi.export("sqlServerId", example.id)

    Example coming soon!

    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 GetServer(ctx *Context, args *GetServerArgs, opts ...InvokeOption) (*GetServerResult, error)
func GetServerOutput(ctx *Context, args *GetServerOutputArgs, opts ...InvokeOption) GetServerResultOutput

    > Note: This function is named GetServer 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)
public static Output<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)

    fn::invoke:
  function: azure:sql/getServer:getServer
  arguments:
    # arguments dictionary

    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 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.
    name String
    The name of the SQL Server.
    resourceGroupName String
    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 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 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 Sequence[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 Mapping[str, str]
    A mapping of tags assigned to the resource.
    version str
    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 List<Property Map>
    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>
    A mapping of tags assigned to the resource.
    version String
    The version of the SQL Server.

    Supporting Types

    GetServerIdentity

    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.
    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.
    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.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.