GetDatabase

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

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.Sql.GetDatabase.InvokeAsync(new Azure.Sql.GetDatabaseArgs
        {
            Name = "example_db",
            ServerName = "example_db_server",
            ResourceGroupName = "example-resources",
        }));
        this.SqlDatabaseId = example.Apply(example => example.Id);
    }

    [Output("sqlDatabaseId")]
    public Output<string> SqlDatabaseId { 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.LookupDatabase(ctx, &sql.LookupDatabaseArgs{
            Name:              "example_db",
            ServerName:        "example_db_server",
            ResourceGroupName: "example-resources",
        }, nil)
        if err != nil {
            return err
        }
        ctx.Export("sqlDatabaseId", example.Id)
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example = azure.sql.get_database(name="example_db",
    server_name="example_db_server",
    resource_group_name="example-resources")
pulumi.export("sqlDatabaseId", example.id)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.sql.getDatabase({
    name: "example_db",
    serverName: "example_db_server",
    resourceGroupName: "example-resources",
});
export const sqlDatabaseId = example.then(example => example.id);

Using GetDatabase

function getDatabase(args: GetDatabaseArgs, opts?: InvokeOptions): Promise<GetDatabaseResult>

function  get_database(name=None, resource_group_name=None, server_name=None, tags=None, opts=None)

func LookupDatabase(ctx *Context, args *LookupDatabaseArgs, opts ...InvokeOption) (*LookupDatabaseResult, error)

Note: This function is named LookupDatabase in the Go SDK.

public static class GetDatabase {
    public static Task<GetDatabaseResult> InvokeAsync(GetDatabaseArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string: The name of the SQL Database.
ResourceGroupName string: Specifies the name of the Resource Group where the Azure SQL Database exists.
ServerName string: The name of the SQL Server.
Tags Dictionary<string, string>: A mapping of tags assigned to the resource.

Name string: The name of the SQL Database.
ResourceGroupName string: Specifies the name of the Resource Group where the Azure SQL Database exists.
ServerName string: The name of the SQL Server.
Tags map[string]string: A mapping of tags assigned to the resource.

name string: The name of the SQL Database.
resourceGroupName string: Specifies the name of the Resource Group where the Azure SQL Database exists.
serverName string: The name of the SQL Server.
tags {[key: string]: string}: A mapping of tags assigned to the resource.

name str: The name of the SQL Database.
resource_group_name str: Specifies the name of the Resource Group where the Azure SQL Database exists.
server_name str: The name of the SQL Server.
tags Dict[str, str]: A mapping of tags assigned to the resource.

GetDatabase Result

The following output properties are available:

Collation string: The name of the collation.
DefaultSecondaryLocation string: The default secondary location of the SQL Database.
Edition string: The edition of the database.
ElasticPoolName string: The name of the elastic database pool the database belongs to.
FailoverGroupId string: The ID of the failover group the database belongs to.
Id string: The provider-assigned unique ID for this managed resource.
Location string: The location of the Resource Group in which the SQL Server exists.
Name string: The name of the database.
ReadScale bool: Indicate if read-only connections will be redirected to a high-available replica.
ResourceGroupName string: The name of the resource group in which the database resides. This will always be the same resource group as the Database Server.
ServerName string: The name of the SQL Server on which to create the database.
Tags Dictionary<string, string>: A mapping of tags assigned to the resource.

Collation string: The name of the collation.
DefaultSecondaryLocation string: The default secondary location of the SQL Database.
Edition string: The edition of the database.
ElasticPoolName string: The name of the elastic database pool the database belongs to.
FailoverGroupId string: The ID of the failover group the database belongs to.
Id string: The provider-assigned unique ID for this managed resource.
Location string: The location of the Resource Group in which the SQL Server exists.
Name string: The name of the database.
ReadScale bool: Indicate if read-only connections will be redirected to a high-available replica.
ResourceGroupName string: The name of the resource group in which the database resides. This will always be the same resource group as the Database Server.
ServerName string: The name of the SQL Server on which to create the database.
Tags map[string]string: A mapping of tags assigned to the resource.

collation string: The name of the collation.
defaultSecondaryLocation string: The default secondary location of the SQL Database.
edition string: The edition of the database.
elasticPoolName string: The name of the elastic database pool the database belongs to.
failoverGroupId string: The ID of the failover group the database belongs to.
id string: The provider-assigned unique ID for this managed resource.
location string: The location of the Resource Group in which the SQL Server exists.
name string: The name of the database.
readScale boolean: Indicate if read-only connections will be redirected to a high-available replica.
resourceGroupName string: The name of the resource group in which the database resides. This will always be the same resource group as the Database Server.
serverName string: The name of the SQL Server on which to create the database.
tags {[key: string]: string}: A mapping of tags assigned to the resource.

collation str: The name of the collation.
default_secondary_location str: The default secondary location of the SQL Database.
edition str: The edition of the database.
elastic_pool_name str: The name of the elastic database pool the database belongs to.
failover_group_id str: The ID of the failover group the database belongs to.
id str: The provider-assigned unique ID for this managed resource.
location str: The location of the Resource Group in which the SQL Server exists.
name str: The name of the database.
read_scale bool: Indicate if read-only connections will be redirected to a high-available replica.
resource_group_name str: The name of the resource group in which the database resides. This will always be the same resource group as the Database Server.
server_name str: The name of the SQL Server on which to create the database.
tags Dict[str, str]: A mapping of tags assigned to the resource.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetDatabase

Example Usage

Using GetDatabase

GetDatabase Result

Package Details

On This Page