Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. cosmosdb
  5. MongoDatabase

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.cosmosdb.MongoDatabase

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Mongo 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 exampleMongoDatabase = new azure.cosmosdb.MongoDatabase("example", {
    name: "tfex-cosmos-mongo-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_mongo_database = azure.cosmosdb.MongoDatabase("example",
    name="tfex-cosmos-mongo-db",
    resource_group_name=example.resource_group_name,
    account_name=example.name,
    throughput=400)

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/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.NewMongoDatabase(ctx, "example", &cosmosdb.MongoDatabaseArgs{
			Name:              pulumi.String("tfex-cosmos-mongo-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 exampleMongoDatabase = new Azure.CosmosDB.MongoDatabase("example", new()
    {
        Name = "tfex-cosmos-mongo-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.MongoDatabase;
import com.pulumi.azure.cosmosdb.MongoDatabaseArgs;
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 exampleMongoDatabase = new MongoDatabase("exampleMongoDatabase", MongoDatabaseArgs.builder()
            .name("tfex-cosmos-mongo-db")
            .resourceGroupName(example.applyValue(getAccountResult -> getAccountResult.resourceGroupName()))
            .accountName(example.applyValue(getAccountResult -> getAccountResult.name()))
            .throughput(400)
            .build());

    }
}

    resources:
  exampleMongoDatabase:
    type: azure:cosmosdb:MongoDatabase
    name: example
    properties:
      name: tfex-cosmos-mongo-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 MongoDatabase Resource

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

    Constructor syntax

    new MongoDatabase(name: string, args: MongoDatabaseArgs, opts?: CustomResourceOptions);
    @overload
def MongoDatabase(resource_name: str,
                  args: MongoDatabaseArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def MongoDatabase(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  account_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  autoscale_settings: Optional[MongoDatabaseAutoscaleSettingsArgs] = None,
                  name: Optional[str] = None,
                  throughput: Optional[int] = None)
    func NewMongoDatabase(ctx *Context, name string, args MongoDatabaseArgs, opts ...ResourceOption) (*MongoDatabase, error)
    public MongoDatabase(string name, MongoDatabaseArgs args, CustomResourceOptions? opts = null)
    public MongoDatabase(String name, MongoDatabaseArgs args)
public MongoDatabase(String name, MongoDatabaseArgs args, CustomResourceOptions options)

    type: azure:cosmosdb:MongoDatabase
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 MongoDatabaseArgs
    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 MongoDatabaseArgs
    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 MongoDatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MongoDatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MongoDatabaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var mongoDatabaseResource = new Azure.CosmosDB.MongoDatabase("mongoDatabaseResource", new()
{
    AccountName = "string",
    ResourceGroupName = "string",
    AutoscaleSettings = new Azure.CosmosDB.Inputs.MongoDatabaseAutoscaleSettingsArgs
    {
        MaxThroughput = 0,
    },
    Name = "string",
    Throughput = 0,
});

    example, err := cosmosdb.NewMongoDatabase(ctx, "mongoDatabaseResource", &cosmosdb.MongoDatabaseArgs{
	AccountName:       pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	AutoscaleSettings: &cosmosdb.MongoDatabaseAutoscaleSettingsArgs{
		MaxThroughput: pulumi.Int(0),
	},
	Name:       pulumi.String("string"),
	Throughput: pulumi.Int(0),
})

    var mongoDatabaseResource = new MongoDatabase("mongoDatabaseResource", MongoDatabaseArgs.builder()
    .accountName("string")
    .resourceGroupName("string")
    .autoscaleSettings(MongoDatabaseAutoscaleSettingsArgs.builder()
        .maxThroughput(0)
        .build())
    .name("string")
    .throughput(0)
    .build());

    mongo_database_resource = azure.cosmosdb.MongoDatabase("mongoDatabaseResource",
    account_name="string",
    resource_group_name="string",
    autoscale_settings={
        "max_throughput": 0,
    },
    name="string",
    throughput=0)

    const mongoDatabaseResource = new azure.cosmosdb.MongoDatabase("mongoDatabaseResource", {
    accountName: "string",
    resourceGroupName: "string",
    autoscaleSettings: {
        maxThroughput: 0,
    },
    name: "string",
    throughput: 0,
});

    type: azure:cosmosdb:MongoDatabase
properties:
    accountName: string
    autoscaleSettings:
        maxThroughput: 0
    name: string
    resourceGroupName: string
    throughput: 0

    MongoDatabase Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The MongoDatabase resource accepts the following input properties:

    AccountName string
    The name of the Cosmos DB Mongo 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 Mongo Database is created. Changing this forces a new resource to be created.
    AutoscaleSettings MongoDatabaseAutoscaleSettings

    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 Mongo Database. Changing this forces a new resource to be created.
    Throughput int

    The throughput of the MongoDB collection (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon database creation otherwise it cannot be updated without a manual resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support.

    AccountName string
    The name of the Cosmos DB Mongo 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 Mongo Database is created. Changing this forces a new resource to be created.
    AutoscaleSettings MongoDatabaseAutoscaleSettingsArgs

    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 Mongo Database. Changing this forces a new resource to be created.
    Throughput int

    The throughput of the MongoDB collection (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon database creation otherwise it cannot be updated without a manual resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support.

    accountName String
    The name of the Cosmos DB Mongo 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 Mongo Database is created. Changing this forces a new resource to be created.
    autoscaleSettings MongoDatabaseAutoscaleSettings

    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 Mongo Database. Changing this forces a new resource to be created.
    throughput Integer

    The throughput of the MongoDB collection (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon database creation otherwise it cannot be updated without a manual resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support.

    accountName string
    The name of the Cosmos DB Mongo 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 Mongo Database is created. Changing this forces a new resource to be created.
    autoscaleSettings MongoDatabaseAutoscaleSettings

    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 Mongo Database. Changing this forces a new resource to be created.
    throughput number

    The throughput of the MongoDB collection (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon database creation otherwise it cannot be updated without a manual resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support.

    account_name str
    The name of the Cosmos DB Mongo 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 Mongo Database is created. Changing this forces a new resource to be created.
    autoscale_settings MongoDatabaseAutoscaleSettingsArgs

    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 Mongo Database. Changing this forces a new resource to be created.
    throughput int

    The throughput of the MongoDB collection (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon database creation otherwise it cannot be updated without a manual resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support.

    accountName String
    The name of the Cosmos DB Mongo 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 Mongo 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 Mongo Database. Changing this forces a new resource to be created.
    throughput Number

    The throughput of the MongoDB collection (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon database creation otherwise it cannot be updated without a manual resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MongoDatabase 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 MongoDatabase Resource

    Get an existing MongoDatabase 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?: MongoDatabaseState, opts?: CustomResourceOptions): MongoDatabase
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_name: Optional[str] = None,
        autoscale_settings: Optional[MongoDatabaseAutoscaleSettingsArgs] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        throughput: Optional[int] = None) -> MongoDatabase
    func GetMongoDatabase(ctx *Context, name string, id IDInput, state *MongoDatabaseState, opts ...ResourceOption) (*MongoDatabase, error)
    public static MongoDatabase Get(string name, Input<string> id, MongoDatabaseState? state, CustomResourceOptions? opts = null)
    public static MongoDatabase get(String name, Output<String> id, MongoDatabaseState 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 Mongo Database to create the table within. Changing this forces a new resource to be created.
    AutoscaleSettings MongoDatabaseAutoscaleSettings

    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 Mongo Database. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the Cosmos DB Mongo Database is created. Changing this forces a new resource to be created.
    Throughput int

    The throughput of the MongoDB collection (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon database creation otherwise it cannot be updated without a manual resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support.

    AccountName string
    The name of the Cosmos DB Mongo Database to create the table within. Changing this forces a new resource to be created.
    AutoscaleSettings MongoDatabaseAutoscaleSettingsArgs

    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 Mongo Database. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the Cosmos DB Mongo Database is created. Changing this forces a new resource to be created.
    Throughput int

    The throughput of the MongoDB collection (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon database creation otherwise it cannot be updated without a manual resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support.

    accountName String
    The name of the Cosmos DB Mongo Database to create the table within. Changing this forces a new resource to be created.
    autoscaleSettings MongoDatabaseAutoscaleSettings

    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 Mongo Database. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the Cosmos DB Mongo Database is created. Changing this forces a new resource to be created.
    throughput Integer

    The throughput of the MongoDB collection (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon database creation otherwise it cannot be updated without a manual resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support.

    accountName string
    The name of the Cosmos DB Mongo Database to create the table within. Changing this forces a new resource to be created.
    autoscaleSettings MongoDatabaseAutoscaleSettings

    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 Mongo Database. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which the Cosmos DB Mongo Database is created. Changing this forces a new resource to be created.
    throughput number

    The throughput of the MongoDB collection (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon database creation otherwise it cannot be updated without a manual resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support.

    account_name str
    The name of the Cosmos DB Mongo Database to create the table within. Changing this forces a new resource to be created.
    autoscale_settings MongoDatabaseAutoscaleSettingsArgs

    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 Mongo 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 Mongo Database is created. Changing this forces a new resource to be created.
    throughput int

    The throughput of the MongoDB collection (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon database creation otherwise it cannot be updated without a manual resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support.

    accountName String
    The name of the Cosmos DB Mongo 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 Mongo Database. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the Cosmos DB Mongo Database is created. Changing this forces a new resource to be created.
    throughput Number

    The throughput of the MongoDB collection (RU/s). Must be set in increments of 100. The minimum value is 400. This must be set upon database creation otherwise it cannot be updated without a manual resource destroy-apply.

    Note: throughput has a maximum value of 1000000 unless a higher limit is requested via Azure Support.

    Supporting Types

    MongoDatabaseAutoscaleSettings, MongoDatabaseAutoscaleSettingsArgs

    MaxThroughput int
    The maximum throughput of the MongoDB 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 MongoDB 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 MongoDB 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 MongoDB 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 MongoDB 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 MongoDB 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 Mongo Database can be imported using the resource id, e.g.

    $ pulumi import azure:cosmosdb/mongoDatabase:MongoDatabase db1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/account1/mongodbDatabases/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 v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure