← All packages

Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Friday, Jun 10, 2022 by Pulumi
Source code
  1. Pulumi Registry
  2. Azure Classic
  3. Azure Classic
  4. cosmosdb
  5. MongoCollection

MongoCollection

Manages a Mongo Collection within a Cosmos DB Account.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleAccount = Output.Create(Azure.CosmosDB.GetAccount.InvokeAsync(new Azure.CosmosDB.GetAccountArgs
        {
            Name = "tfex-cosmosdb-account",
            ResourceGroupName = "tfex-cosmosdb-account-rg",
        }));
        var exampleMongoDatabase = new Azure.CosmosDB.MongoDatabase("exampleMongoDatabase", new Azure.CosmosDB.MongoDatabaseArgs
        {
            ResourceGroupName = exampleAccount.Apply(exampleAccount => exampleAccount.ResourceGroupName),
            AccountName = exampleAccount.Apply(exampleAccount => exampleAccount.Name),
        });
        var exampleMongoCollection = new Azure.CosmosDB.MongoCollection("exampleMongoCollection", new Azure.CosmosDB.MongoCollectionArgs
        {
            ResourceGroupName = exampleAccount.Apply(exampleAccount => exampleAccount.ResourceGroupName),
            AccountName = exampleAccount.Apply(exampleAccount => exampleAccount.Name),
            DatabaseName = exampleMongoDatabase.Name,
            DefaultTtlSeconds = 777,
            ShardKey = "uniqueKey",
            Throughput = 400,
            Indices = 
            {
                new Azure.CosmosDB.Inputs.MongoCollectionIndexArgs
                {
                    Keys = 
                    {
                        "_id",
                    },
                    Unique = true,
                },
            },
        });
    }

}

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 {
		exampleAccount, err := cosmosdb.LookupAccount(ctx, &cosmosdb.LookupAccountArgs{
			Name:              "tfex-cosmosdb-account",
			ResourceGroupName: "tfex-cosmosdb-account-rg",
		}, nil)
		if err != nil {
			return err
		}
		exampleMongoDatabase, err := cosmosdb.NewMongoDatabase(ctx, "exampleMongoDatabase", &cosmosdb.MongoDatabaseArgs{
			ResourceGroupName: pulumi.String(exampleAccount.ResourceGroupName),
			AccountName:       pulumi.String(exampleAccount.Name),
		})
		if err != nil {
			return err
		}
		_, err = cosmosdb.NewMongoCollection(ctx, "exampleMongoCollection", &cosmosdb.MongoCollectionArgs{
			ResourceGroupName: pulumi.String(exampleAccount.ResourceGroupName),
			AccountName:       pulumi.String(exampleAccount.Name),
			DatabaseName:      exampleMongoDatabase.Name,
			DefaultTtlSeconds: pulumi.Int(777),
			ShardKey:          pulumi.String("uniqueKey"),
			Throughput:        pulumi.Int(400),
			Indices: cosmosdb.MongoCollectionIndexArray{
				&cosmosdb.MongoCollectionIndexArgs{
					Keys: pulumi.StringArray{
						pulumi.String("_id"),
					},
					Unique: pulumi.Bool(true),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleAccount = Output.of(CosmosdbFunctions.getAccount(GetAccountArgs.builder()
            .name("tfex-cosmosdb-account")
            .resourceGroupName("tfex-cosmosdb-account-rg")
            .build()));

        var exampleMongoDatabase = new MongoDatabase("exampleMongoDatabase", MongoDatabaseArgs.builder()        
            .resourceGroupName(exampleAccount.apply(getAccountResult -> getAccountResult.resourceGroupName()))
            .accountName(exampleAccount.apply(getAccountResult -> getAccountResult.name()))
            .build());

        var exampleMongoCollection = new MongoCollection("exampleMongoCollection", MongoCollectionArgs.builder()        
            .resourceGroupName(exampleAccount.apply(getAccountResult -> getAccountResult.resourceGroupName()))
            .accountName(exampleAccount.apply(getAccountResult -> getAccountResult.name()))
            .databaseName(exampleMongoDatabase.name())
            .defaultTtlSeconds("777")
            .shardKey("uniqueKey")
            .throughput(400)
            .indices(MongoCollectionIndexArgs.builder()
                .keys("_id")
                .unique(true)
                .build())
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example_account = azure.cosmosdb.get_account(name="tfex-cosmosdb-account",
    resource_group_name="tfex-cosmosdb-account-rg")
example_mongo_database = azure.cosmosdb.MongoDatabase("exampleMongoDatabase",
    resource_group_name=example_account.resource_group_name,
    account_name=example_account.name)
example_mongo_collection = azure.cosmosdb.MongoCollection("exampleMongoCollection",
    resource_group_name=example_account.resource_group_name,
    account_name=example_account.name,
    database_name=example_mongo_database.name,
    default_ttl_seconds=777,
    shard_key="uniqueKey",
    throughput=400,
    indices=[azure.cosmosdb.MongoCollectionIndexArgs(
        keys=["_id"],
        unique=True,
    )])

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

const exampleAccount = azure.cosmosdb.getAccount({
    name: "tfex-cosmosdb-account",
    resourceGroupName: "tfex-cosmosdb-account-rg",
});
const exampleMongoDatabase = new azure.cosmosdb.MongoDatabase("exampleMongoDatabase", {
    resourceGroupName: exampleAccount.then(exampleAccount => exampleAccount.resourceGroupName),
    accountName: exampleAccount.then(exampleAccount => exampleAccount.name),
});
const exampleMongoCollection = new azure.cosmosdb.MongoCollection("exampleMongoCollection", {
    resourceGroupName: exampleAccount.then(exampleAccount => exampleAccount.resourceGroupName),
    accountName: exampleAccount.then(exampleAccount => exampleAccount.name),
    databaseName: exampleMongoDatabase.name,
    defaultTtlSeconds: 777,
    shardKey: "uniqueKey",
    throughput: 400,
    indices: [{
        keys: ["_id"],
        unique: true,
    }],
});

resources:
  exampleMongoDatabase:
    type: azure:cosmosdb:MongoDatabase
    properties:
      resourceGroupName: ${exampleAccount.resourceGroupName}
      accountName: ${exampleAccount.name}
  exampleMongoCollection:
    type: azure:cosmosdb:MongoCollection
    properties:
      resourceGroupName: ${exampleAccount.resourceGroupName}
      accountName: ${exampleAccount.name}
      databaseName: ${exampleMongoDatabase.name}
      defaultTtlSeconds: 777
      shardKey: uniqueKey
      throughput: 400
      indices:
        - keys:
            - _id
          unique: true
variables:
  exampleAccount:
    Fn::Invoke:
      Function: azure:cosmosdb:getAccount
      Arguments:
        name: tfex-cosmosdb-account
        resourceGroupName: tfex-cosmosdb-account-rg

Create a MongoCollection Resource

new MongoCollection(name: string, args: MongoCollectionArgs, opts?: CustomResourceOptions);
@overload
def MongoCollection(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    account_name: Optional[str] = None,
                    analytical_storage_ttl: Optional[int] = None,
                    autoscale_settings: Optional[MongoCollectionAutoscaleSettingsArgs] = None,
                    database_name: Optional[str] = None,
                    default_ttl_seconds: Optional[int] = None,
                    indices: Optional[Sequence[MongoCollectionIndexArgs]] = None,
                    name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    shard_key: Optional[str] = None,
                    throughput: Optional[int] = None)
@overload
def MongoCollection(resource_name: str,
                    args: MongoCollectionArgs,
                    opts: Optional[ResourceOptions] = None)
func NewMongoCollection(ctx *Context, name string, args MongoCollectionArgs, opts ...ResourceOption) (*MongoCollection, error)
public MongoCollection(string name, MongoCollectionArgs args, CustomResourceOptions? opts = null)
public MongoCollection(String name, MongoCollectionArgs args)
public MongoCollection(String name, MongoCollectionArgs args, CustomResourceOptions options)

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

MongoCollection 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 MongoCollection resource accepts the following input properties:

AccountName string
DatabaseName string

The name of the Cosmos DB Mongo Database in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the resource group in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

AnalyticalStorageTtl int

The default time to live of Analytical Storage for this Mongo Collection. If present and the value is set to -1, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number n – items will expire n seconds after their last modified time.

AutoscaleSettings MongoCollectionAutoscaleSettingsArgs
DefaultTtlSeconds int

The default Time To Live in seconds. If the value is -1, items are not automatically expired.

  • index - (Optional) One or more index blocks as defined below.

Indices List<MongoCollectionIndexArgs>
Name string

Specifies the name of the Cosmos DB Mongo Collection. Changing this forces a new resource to be created.

ShardKey string

The name of the key to partition on for sharding. There must not be any other unique index keys.

Throughput int
AccountName string
DatabaseName string

The name of the Cosmos DB Mongo Database in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the resource group in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

AnalyticalStorageTtl int

The default time to live of Analytical Storage for this Mongo Collection. If present and the value is set to -1, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number n – items will expire n seconds after their last modified time.

AutoscaleSettings MongoCollectionAutoscaleSettingsArgs
DefaultTtlSeconds int

The default Time To Live in seconds. If the value is -1, items are not automatically expired.

  • index - (Optional) One or more index blocks as defined below.

Indices []MongoCollectionIndexArgs
Name string

Specifies the name of the Cosmos DB Mongo Collection. Changing this forces a new resource to be created.

ShardKey string

The name of the key to partition on for sharding. There must not be any other unique index keys.

Throughput int
accountName String
databaseName String

The name of the Cosmos DB Mongo Database in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

resourceGroupName String

The name of the resource group in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

analyticalStorageTtl Integer

The default time to live of Analytical Storage for this Mongo Collection. If present and the value is set to -1, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number n – items will expire n seconds after their last modified time.

autoscaleSettings MongoCollectionAutoscaleSettingsArgs
defaultTtlSeconds Integer

The default Time To Live in seconds. If the value is -1, items are not automatically expired.

  • index - (Optional) One or more index blocks as defined below.

indices List<MongoCollectionIndexArgs>
name String

Specifies the name of the Cosmos DB Mongo Collection. Changing this forces a new resource to be created.

shardKey String

The name of the key to partition on for sharding. There must not be any other unique index keys.

throughput Integer
accountName string
databaseName string

The name of the Cosmos DB Mongo Database in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

resourceGroupName string

The name of the resource group in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

analyticalStorageTtl number

The default time to live of Analytical Storage for this Mongo Collection. If present and the value is set to -1, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number n – items will expire n seconds after their last modified time.

autoscaleSettings MongoCollectionAutoscaleSettingsArgs
defaultTtlSeconds number

The default Time To Live in seconds. If the value is -1, items are not automatically expired.

  • index - (Optional) One or more index blocks as defined below.

indices MongoCollectionIndexArgs[]
name string

Specifies the name of the Cosmos DB Mongo Collection. Changing this forces a new resource to be created.

shardKey string

The name of the key to partition on for sharding. There must not be any other unique index keys.

throughput number
account_name str
database_name str

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

analytical_storage_ttl int

The default time to live of Analytical Storage for this Mongo Collection. If present and the value is set to -1, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number n – items will expire n seconds after their last modified time.

autoscale_settings MongoCollectionAutoscaleSettingsArgs
default_ttl_seconds int

The default Time To Live in seconds. If the value is -1, items are not automatically expired.

  • index - (Optional) One or more index blocks as defined below.

indices Sequence[MongoCollectionIndexArgs]
name str

Specifies the name of the Cosmos DB Mongo Collection. Changing this forces a new resource to be created.

shard_key str

The name of the key to partition on for sharding. There must not be any other unique index keys.

throughput int
accountName String
databaseName String

The name of the Cosmos DB Mongo Database in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

resourceGroupName String

The name of the resource group in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

analyticalStorageTtl Number

The default time to live of Analytical Storage for this Mongo Collection. If present and the value is set to -1, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number n – items will expire n seconds after their last modified time.

autoscaleSettings Property Map
defaultTtlSeconds Number

The default Time To Live in seconds. If the value is -1, items are not automatically expired.

  • index - (Optional) One or more index blocks as defined below.

indices List<Property Map>
name String

Specifies the name of the Cosmos DB Mongo Collection. Changing this forces a new resource to be created.

shardKey String

The name of the key to partition on for sharding. There must not be any other unique index keys.

throughput Number

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

SystemIndexes List<MongoCollectionSystemIndex>

One or more system_indexes blocks as defined below.

Id string

The provider-assigned unique ID for this managed resource.

SystemIndexes []MongoCollectionSystemIndex

One or more system_indexes blocks as defined below.

id String

The provider-assigned unique ID for this managed resource.

systemIndexes List<MongoCollectionSystemIndex>

One or more system_indexes blocks as defined below.

id string

The provider-assigned unique ID for this managed resource.

systemIndexes MongoCollectionSystemIndex[]

One or more system_indexes blocks as defined below.

id str

The provider-assigned unique ID for this managed resource.

system_indexes Sequence[MongoCollectionSystemIndex]

One or more system_indexes blocks as defined below.

id String

The provider-assigned unique ID for this managed resource.

systemIndexes List<Property Map>

One or more system_indexes blocks as defined below.

Look up an Existing MongoCollection Resource

Get an existing MongoCollection 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?: MongoCollectionState, opts?: CustomResourceOptions): MongoCollection
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_name: Optional[str] = None,
        analytical_storage_ttl: Optional[int] = None,
        autoscale_settings: Optional[MongoCollectionAutoscaleSettingsArgs] = None,
        database_name: Optional[str] = None,
        default_ttl_seconds: Optional[int] = None,
        indices: Optional[Sequence[MongoCollectionIndexArgs]] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        shard_key: Optional[str] = None,
        system_indexes: Optional[Sequence[MongoCollectionSystemIndexArgs]] = None,
        throughput: Optional[int] = None) -> MongoCollection
func GetMongoCollection(ctx *Context, name string, id IDInput, state *MongoCollectionState, opts ...ResourceOption) (*MongoCollection, error)
public static MongoCollection Get(string name, Input<string> id, MongoCollectionState? state, CustomResourceOptions? opts = null)
public static MongoCollection get(String name, Output<String> id, MongoCollectionState 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
AnalyticalStorageTtl int

The default time to live of Analytical Storage for this Mongo Collection. If present and the value is set to -1, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number n – items will expire n seconds after their last modified time.

AutoscaleSettings MongoCollectionAutoscaleSettingsArgs
DatabaseName string

The name of the Cosmos DB Mongo Database in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

DefaultTtlSeconds int

The default Time To Live in seconds. If the value is -1, items are not automatically expired.

  • index - (Optional) One or more index blocks as defined below.

Indices List<MongoCollectionIndexArgs>
Name string

Specifies the name of the Cosmos DB Mongo Collection. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the resource group in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

ShardKey string

The name of the key to partition on for sharding. There must not be any other unique index keys.

SystemIndexes List<MongoCollectionSystemIndexArgs>

One or more system_indexes blocks as defined below.

Throughput int
AccountName string
AnalyticalStorageTtl int

The default time to live of Analytical Storage for this Mongo Collection. If present and the value is set to -1, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number n – items will expire n seconds after their last modified time.

AutoscaleSettings MongoCollectionAutoscaleSettingsArgs
DatabaseName string

The name of the Cosmos DB Mongo Database in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

DefaultTtlSeconds int

The default Time To Live in seconds. If the value is -1, items are not automatically expired.

  • index - (Optional) One or more index blocks as defined below.

Indices []MongoCollectionIndexArgs
Name string

Specifies the name of the Cosmos DB Mongo Collection. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the resource group in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

ShardKey string

The name of the key to partition on for sharding. There must not be any other unique index keys.

SystemIndexes []MongoCollectionSystemIndexArgs

One or more system_indexes blocks as defined below.

Throughput int
accountName String
analyticalStorageTtl Integer

The default time to live of Analytical Storage for this Mongo Collection. If present and the value is set to -1, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number n – items will expire n seconds after their last modified time.

autoscaleSettings MongoCollectionAutoscaleSettingsArgs
databaseName String

The name of the Cosmos DB Mongo Database in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

defaultTtlSeconds Integer

The default Time To Live in seconds. If the value is -1, items are not automatically expired.

  • index - (Optional) One or more index blocks as defined below.

indices List<MongoCollectionIndexArgs>
name String

Specifies the name of the Cosmos DB Mongo Collection. Changing this forces a new resource to be created.

resourceGroupName String

The name of the resource group in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

shardKey String

The name of the key to partition on for sharding. There must not be any other unique index keys.

systemIndexes List<MongoCollectionSystemIndexArgs>

One or more system_indexes blocks as defined below.

throughput Integer
accountName string
analyticalStorageTtl number

The default time to live of Analytical Storage for this Mongo Collection. If present and the value is set to -1, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number n – items will expire n seconds after their last modified time.

autoscaleSettings MongoCollectionAutoscaleSettingsArgs
databaseName string

The name of the Cosmos DB Mongo Database in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

defaultTtlSeconds number

The default Time To Live in seconds. If the value is -1, items are not automatically expired.

  • index - (Optional) One or more index blocks as defined below.

indices MongoCollectionIndexArgs[]
name string

Specifies the name of the Cosmos DB Mongo Collection. Changing this forces a new resource to be created.

resourceGroupName string

The name of the resource group in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

shardKey string

The name of the key to partition on for sharding. There must not be any other unique index keys.

systemIndexes MongoCollectionSystemIndexArgs[]

One or more system_indexes blocks as defined below.

throughput number
account_name str
analytical_storage_ttl int

The default time to live of Analytical Storage for this Mongo Collection. If present and the value is set to -1, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number n – items will expire n seconds after their last modified time.

autoscale_settings MongoCollectionAutoscaleSettingsArgs
database_name str

The name of the Cosmos DB Mongo Database in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

default_ttl_seconds int

The default Time To Live in seconds. If the value is -1, items are not automatically expired.

  • index - (Optional) One or more index blocks as defined below.

indices Sequence[MongoCollectionIndexArgs]
name str

Specifies the name of the Cosmos DB Mongo Collection. 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 Collection is created. Changing this forces a new resource to be created.

shard_key str

The name of the key to partition on for sharding. There must not be any other unique index keys.

system_indexes Sequence[MongoCollectionSystemIndexArgs]

One or more system_indexes blocks as defined below.

throughput int
accountName String
analyticalStorageTtl Number

The default time to live of Analytical Storage for this Mongo Collection. If present and the value is set to -1, it is equal to infinity, and items don’t expire by default. If present and the value is set to some number n – items will expire n seconds after their last modified time.

autoscaleSettings Property Map
databaseName String

The name of the Cosmos DB Mongo Database in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

defaultTtlSeconds Number

The default Time To Live in seconds. If the value is -1, items are not automatically expired.

  • index - (Optional) One or more index blocks as defined below.

indices List<Property Map>
name String

Specifies the name of the Cosmos DB Mongo Collection. Changing this forces a new resource to be created.

resourceGroupName String

The name of the resource group in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

shardKey String

The name of the key to partition on for sharding. There must not be any other unique index keys.

systemIndexes List<Property Map>

One or more system_indexes blocks as defined below.

throughput Number

Supporting Types

MongoCollectionAutoscaleSettings

MaxThroughput int

The maximum throughput of the MongoDB collection (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 collection (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 collection (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 collection (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 collection (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 collection (RU/s). Must be between 1,000 and 1,000,000. Must be set in increments of 1,000. Conflicts with throughput.

MongoCollectionIndex

Keys List<string>

Specifies the list of user settable keys for each Cosmos DB Mongo Collection.

Unique bool

Is the index unique or not? Defaults to false.

Keys []string

Specifies the list of user settable keys for each Cosmos DB Mongo Collection.

Unique bool

Is the index unique or not? Defaults to false.

keys List<String>

Specifies the list of user settable keys for each Cosmos DB Mongo Collection.

unique Boolean

Is the index unique or not? Defaults to false.

keys string[]

Specifies the list of user settable keys for each Cosmos DB Mongo Collection.

unique boolean

Is the index unique or not? Defaults to false.

keys Sequence[str]

Specifies the list of user settable keys for each Cosmos DB Mongo Collection.

unique bool

Is the index unique or not? Defaults to false.

keys List<String>

Specifies the list of user settable keys for each Cosmos DB Mongo Collection.

unique Boolean

Is the index unique or not? Defaults to false.

MongoCollectionSystemIndex

Keys List<string>

Specifies the list of user settable keys for each Cosmos DB Mongo Collection.

Unique bool

Is the index unique or not? Defaults to false.

Keys []string

Specifies the list of user settable keys for each Cosmos DB Mongo Collection.

Unique bool

Is the index unique or not? Defaults to false.

keys List<String>

Specifies the list of user settable keys for each Cosmos DB Mongo Collection.

unique Boolean

Is the index unique or not? Defaults to false.

keys string[]

Specifies the list of user settable keys for each Cosmos DB Mongo Collection.

unique boolean

Is the index unique or not? Defaults to false.

keys Sequence[str]

Specifies the list of user settable keys for each Cosmos DB Mongo Collection.

unique bool

Is the index unique or not? Defaults to false.

keys List<String>

Specifies the list of user settable keys for each Cosmos DB Mongo Collection.

unique Boolean

Is the index unique or not? Defaults to false.

Import

CosmosDB Mongo Collection can be imported using the resource id, e.g.

 $ pulumi import azure:cosmosdb/mongoCollection:MongoCollection collection1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/account1/mongodbDatabases/db1/collections/collection1

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.