1. Packages
  2. Azure Classic
  3. API Docs
  4. cosmosdb
  5. SqlDatabase

We recommend using Azure Native.

Azure Classic v5.78.0 published on Wednesday, May 22, 2024 by Pulumi

azure.cosmosdb.SqlDatabase

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.78.0 published on Wednesday, May 22, 2024 by Pulumi

    Manages a SQL Database within a Cosmos DB Account.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = azure.cosmosdb.getAccount({
        name: "tfex-cosmosdb-account",
        resourceGroupName: "tfex-cosmosdb-account-rg",
    });
    const exampleSqlDatabase = new azure.cosmosdb.SqlDatabase("example", {
        name: "tfex-cosmos-sql-db",
        resourceGroupName: example.then(example => example.resourceGroupName),
        accountName: example.then(example => example.name),
        throughput: 400,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.cosmosdb.get_account(name="tfex-cosmosdb-account",
        resource_group_name="tfex-cosmosdb-account-rg")
    example_sql_database = azure.cosmosdb.SqlDatabase("example",
        name="tfex-cosmos-sql-db",
        resource_group_name=example.resource_group_name,
        account_name=example.name,
        throughput=400)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/cosmosdb"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := cosmosdb.LookupAccount(ctx, &cosmosdb.LookupAccountArgs{
    			Name:              "tfex-cosmosdb-account",
    			ResourceGroupName: "tfex-cosmosdb-account-rg",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = cosmosdb.NewSqlDatabase(ctx, "example", &cosmosdb.SqlDatabaseArgs{
    			Name:              pulumi.String("tfex-cosmos-sql-db"),
    			ResourceGroupName: pulumi.String(example.ResourceGroupName),
    			AccountName:       pulumi.String(example.Name),
    			Throughput:        pulumi.Int(400),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Azure.CosmosDB.GetAccount.Invoke(new()
        {
            Name = "tfex-cosmosdb-account",
            ResourceGroupName = "tfex-cosmosdb-account-rg",
        });
    
        var exampleSqlDatabase = new Azure.CosmosDB.SqlDatabase("example", new()
        {
            Name = "tfex-cosmos-sql-db",
            ResourceGroupName = example.Apply(getAccountResult => getAccountResult.ResourceGroupName),
            AccountName = example.Apply(getAccountResult => getAccountResult.Name),
            Throughput = 400,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.cosmosdb.CosmosdbFunctions;
    import com.pulumi.azure.cosmosdb.inputs.GetAccountArgs;
    import com.pulumi.azure.cosmosdb.SqlDatabase;
    import com.pulumi.azure.cosmosdb.SqlDatabaseArgs;
    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 = CosmosdbFunctions.getAccount(GetAccountArgs.builder()
                .name("tfex-cosmosdb-account")
                .resourceGroupName("tfex-cosmosdb-account-rg")
                .build());
    
            var exampleSqlDatabase = new SqlDatabase("exampleSqlDatabase", SqlDatabaseArgs.builder()        
                .name("tfex-cosmos-sql-db")
                .resourceGroupName(example.applyValue(getAccountResult -> getAccountResult.resourceGroupName()))
                .accountName(example.applyValue(getAccountResult -> getAccountResult.name()))
                .throughput(400)
                .build());
    
        }
    }
    
    resources:
      exampleSqlDatabase:
        type: azure:cosmosdb:SqlDatabase
        name: example
        properties:
          name: tfex-cosmos-sql-db
          resourceGroupName: ${example.resourceGroupName}
          accountName: ${example.name}
          throughput: 400
    variables:
      example:
        fn::invoke:
          Function: azure:cosmosdb:getAccount
          Arguments:
            name: tfex-cosmosdb-account
            resourceGroupName: tfex-cosmosdb-account-rg
    

    Create SqlDatabase Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SqlDatabase(name: string, args: SqlDatabaseArgs, opts?: CustomResourceOptions);
    @overload
    def SqlDatabase(resource_name: str,
                    args: SqlDatabaseArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def SqlDatabase(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    account_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    autoscale_settings: Optional[SqlDatabaseAutoscaleSettingsArgs] = None,
                    name: Optional[str] = None,
                    throughput: Optional[int] = None)
    func NewSqlDatabase(ctx *Context, name string, args SqlDatabaseArgs, opts ...ResourceOption) (*SqlDatabase, error)
    public SqlDatabase(string name, SqlDatabaseArgs args, CustomResourceOptions? opts = null)
    public SqlDatabase(String name, SqlDatabaseArgs args)
    public SqlDatabase(String name, SqlDatabaseArgs args, CustomResourceOptions options)
    
    type: azure:cosmosdb:SqlDatabase
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args SqlDatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SqlDatabaseArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SqlDatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SqlDatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SqlDatabaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var sqlDatabaseResource = new Azure.CosmosDB.SqlDatabase("sqlDatabaseResource", new()
    {
        AccountName = "string",
        ResourceGroupName = "string",
        AutoscaleSettings = new Azure.CosmosDB.Inputs.SqlDatabaseAutoscaleSettingsArgs
        {
            MaxThroughput = 0,
        },
        Name = "string",
        Throughput = 0,
    });
    
    example, err := cosmosdb.NewSqlDatabase(ctx, "sqlDatabaseResource", &cosmosdb.SqlDatabaseArgs{
    	AccountName:       pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	AutoscaleSettings: &cosmosdb.SqlDatabaseAutoscaleSettingsArgs{
    		MaxThroughput: pulumi.Int(0),
    	},
    	Name:       pulumi.String("string"),
    	Throughput: pulumi.Int(0),
    })
    
    var sqlDatabaseResource = new SqlDatabase("sqlDatabaseResource", SqlDatabaseArgs.builder()        
        .accountName("string")
        .resourceGroupName("string")
        .autoscaleSettings(SqlDatabaseAutoscaleSettingsArgs.builder()
            .maxThroughput(0)
            .build())
        .name("string")
        .throughput(0)
        .build());
    
    sql_database_resource = azure.cosmosdb.SqlDatabase("sqlDatabaseResource",
        account_name="string",
        resource_group_name="string",
        autoscale_settings=azure.cosmosdb.SqlDatabaseAutoscaleSettingsArgs(
            max_throughput=0,
        ),
        name="string",
        throughput=0)
    
    const sqlDatabaseResource = new azure.cosmosdb.SqlDatabase("sqlDatabaseResource", {
        accountName: "string",
        resourceGroupName: "string",
        autoscaleSettings: {
            maxThroughput: 0,
        },
        name: "string",
        throughput: 0,
    });
    
    type: azure:cosmosdb:SqlDatabase
    properties:
        accountName: string
        autoscaleSettings:
            maxThroughput: 0
        name: string
        resourceGroupName: string
        throughput: 0
    

    SqlDatabase Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The SqlDatabase resource accepts the following input properties:

    AccountName string
    The name of the Cosmos DB SQL Database to create the table within. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
    AutoscaleSettings SqlDatabaseAutoscaleSettings

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.

    Note: Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.

    Name string
    Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
    Throughput int
    AccountName string
    The name of the Cosmos DB SQL Database to create the table within. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
    AutoscaleSettings SqlDatabaseAutoscaleSettingsArgs

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.

    Note: Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.

    Name string
    Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
    Throughput int
    accountName String
    The name of the Cosmos DB SQL Database to create the table within. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
    autoscaleSettings SqlDatabaseAutoscaleSettings

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.

    Note: Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.

    name String
    Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
    throughput Integer
    accountName string
    The name of the Cosmos DB SQL Database to create the table within. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
    autoscaleSettings SqlDatabaseAutoscaleSettings

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.

    Note: Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.

    name string
    Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
    throughput number
    account_name str
    The name of the Cosmos DB SQL Database to create the table within. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
    autoscale_settings SqlDatabaseAutoscaleSettingsArgs

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.

    Note: Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.

    name str
    Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
    throughput int
    accountName String
    The name of the Cosmos DB SQL Database to create the table within. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
    autoscaleSettings Property Map

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.

    Note: Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.

    name String
    Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
    throughput Number

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SqlDatabase resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SqlDatabase Resource

    Get an existing SqlDatabase resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SqlDatabaseState, opts?: CustomResourceOptions): SqlDatabase
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_name: Optional[str] = None,
            autoscale_settings: Optional[SqlDatabaseAutoscaleSettingsArgs] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            throughput: Optional[int] = None) -> SqlDatabase
    func GetSqlDatabase(ctx *Context, name string, id IDInput, state *SqlDatabaseState, opts ...ResourceOption) (*SqlDatabase, error)
    public static SqlDatabase Get(string name, Input<string> id, SqlDatabaseState? state, CustomResourceOptions? opts = null)
    public static SqlDatabase get(String name, Output<String> id, SqlDatabaseState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountName string
    The name of the Cosmos DB SQL Database to create the table within. Changing this forces a new resource to be created.
    AutoscaleSettings SqlDatabaseAutoscaleSettings

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.

    Note: Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.

    Name string
    Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
    Throughput int
    AccountName string
    The name of the Cosmos DB SQL Database to create the table within. Changing this forces a new resource to be created.
    AutoscaleSettings SqlDatabaseAutoscaleSettingsArgs

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.

    Note: Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.

    Name string
    Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
    Throughput int
    accountName String
    The name of the Cosmos DB SQL Database to create the table within. Changing this forces a new resource to be created.
    autoscaleSettings SqlDatabaseAutoscaleSettings

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.

    Note: Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.

    name String
    Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
    throughput Integer
    accountName string
    The name of the Cosmos DB SQL Database to create the table within. Changing this forces a new resource to be created.
    autoscaleSettings SqlDatabaseAutoscaleSettings

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.

    Note: Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.

    name string
    Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
    throughput number
    account_name str
    The name of the Cosmos DB SQL Database to create the table within. Changing this forces a new resource to be created.
    autoscale_settings SqlDatabaseAutoscaleSettingsArgs

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.

    Note: Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.

    name str
    Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
    throughput int
    accountName String
    The name of the Cosmos DB SQL Database to create the table within. Changing this forces a new resource to be created.
    autoscaleSettings Property Map

    An autoscale_settings block as defined below. This must be set upon database creation otherwise it cannot be updated without a manual destroy-apply.

    Note: Switching between autoscale and manual throughput is not supported via this provider and must be completed via the Azure Portal and refreshed.

    name String
    Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
    throughput Number

    Supporting Types

    SqlDatabaseAutoscaleSettings, SqlDatabaseAutoscaleSettingsArgs

    MaxThroughput int
    The maximum throughput of the SQL database (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.
    MaxThroughput int
    The maximum throughput of the SQL database (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.
    maxThroughput Integer
    The maximum throughput of the SQL database (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.
    maxThroughput number
    The maximum throughput of the SQL database (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.
    max_throughput int
    The maximum throughput of the SQL database (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.
    maxThroughput Number
    The maximum throughput of the SQL database (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.

    Import

    Cosmos SQL Database can be imported using the resource id, e.g.

    $ pulumi import azure:cosmosdb/sqlDatabase:SqlDatabase db1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/account1/sqlDatabases/db1
    

    To learn more about importing existing cloud resources, see Importing resources.

    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.

    Azure Classic v5.78.0 published on Wednesday, May 22, 2024 by Pulumi