Mongo DBResource Mongo DBCollection Args
An Azure Cosmos DB MongoDB collection. Uses Azure REST API version 2023-04-15. In version 1.x of the Azure Native provider, it used API version 2021-03-15. Other available API versions: 2023-03-15-preview, 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15, 2024-05-15-preview, 2024-08-15, 2024-09-01-preview, 2024-11-15, 2024-12-01-preview.
Example Usage
CosmosDBMongoDBCollectionCreateUpdate
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var mongoDBResourceMongoDBCollection = new AzureNative.DocumentDB.MongoDBResourceMongoDBCollection("mongoDBResourceMongoDBCollection", new()
{
AccountName = "ddb1",
CollectionName = "collectionName",
DatabaseName = "databaseName",
Location = "West US",
Options = null,
Resource = new AzureNative.DocumentDB.Inputs.MongoDBCollectionResourceArgs
{
Id = "collectionName",
Indexes = new[]
{
new AzureNative.DocumentDB.Inputs.MongoIndexArgs
{
Key = new AzureNative.DocumentDB.Inputs.MongoIndexKeysArgs
{
Keys = new[]
{
"_ts",
},
},
Options = new AzureNative.DocumentDB.Inputs.MongoIndexOptionsArgs
{
ExpireAfterSeconds = 100,
Unique = true,
},
},
new AzureNative.DocumentDB.Inputs.MongoIndexArgs
{
Key = new AzureNative.DocumentDB.Inputs.MongoIndexKeysArgs
{
Keys = new[]
{
"_id",
},
},
},
},
ShardKey =
{
{ "testKey", "Hash" },
},
},
ResourceGroupName = "rg1",
Tags = null,
});
});
package main
import (
documentdb "github.com/pulumi/pulumi-azure-native-sdk/documentdb/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := documentdb.NewMongoDBResourceMongoDBCollection(ctx, "mongoDBResourceMongoDBCollection", &documentdb.MongoDBResourceMongoDBCollectionArgs{
AccountName: pulumi.String("ddb1"),
CollectionName: pulumi.String("collectionName"),
DatabaseName: pulumi.String("databaseName"),
Location: pulumi.String("West US"),
Options: &documentdb.CreateUpdateOptionsArgs{},
Resource: &documentdb.MongoDBCollectionResourceArgs{
Id: pulumi.String("collectionName"),
Indexes: documentdb.MongoIndexArray{
&documentdb.MongoIndexArgs{
Key: &documentdb.MongoIndexKeysArgs{
Keys: pulumi.StringArray{
pulumi.String("_ts"),
},
},
Options: &documentdb.MongoIndexOptionsArgs{
ExpireAfterSeconds: pulumi.Int(100),
Unique: pulumi.Bool(true),
},
},
&documentdb.MongoIndexArgs{
Key: &documentdb.MongoIndexKeysArgs{
Keys: pulumi.StringArray{
pulumi.String("_id"),
},
},
},
},
ShardKey: pulumi.StringMap{
"testKey": pulumi.String("Hash"),
},
},
ResourceGroupName: pulumi.String("rg1"),
Tags: pulumi.StringMap{},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.documentdb.MongoDBResourceMongoDBCollection;
import com.pulumi.azurenative.documentdb.MongoDBResourceMongoDBCollectionArgs;
import com.pulumi.azurenative.documentdb.inputs.CreateUpdateOptionsArgs;
import com.pulumi.azurenative.documentdb.inputs.MongoDBCollectionResourceArgs;
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) {
var mongoDBResourceMongoDBCollection = new MongoDBResourceMongoDBCollection("mongoDBResourceMongoDBCollection", MongoDBResourceMongoDBCollectionArgs.builder()
.accountName("ddb1")
.collectionName("collectionName")
.databaseName("databaseName")
.location("West US")
.options()
.resource(MongoDBCollectionResourceArgs.builder()
.id("collectionName")
.indexes(
MongoIndexArgs.builder()
.key(MongoIndexKeysArgs.builder()
.keys("_ts")
.build())
.options(MongoIndexOptionsArgs.builder()
.expireAfterSeconds(100)
.unique(true)
.build())
.build(),
MongoIndexArgs.builder()
.key(MongoIndexKeysArgs.builder()
.keys("_id")
.build())
.build())
.shardKey(Map.of("testKey", "Hash"))
.build())
.resourceGroupName("rg1")
.tags()
.build());
}
}
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:documentdb:MongoDBResourceMongoDBCollection collectionName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}
Constructors
Properties
Cosmos DB database account name.
Cosmos DB collection name.
Cosmos DB database name.
A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
The standard JSON format of a MongoDB collection
The name of the resource group. The name is case insensitive.
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".