1. Packages
  2. Azure Native
  3. API Docs
  4. documentdb
  5. MongoDBResourceMongoDBCollection
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.0 published on Monday, Jun 24, 2024 by Pulumi

azure-native.documentdb.MongoDBResourceMongoDBCollection

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.0 published on Monday, Jun 24, 2024 by Pulumi

    An Azure Cosmos DB MongoDB collection. Azure REST API version: 2023-04-15. Prior API version in Azure Native 1.x: 2021-03-15.

    Other available API versions: 2019-08-01, 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.

    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:        nil,
    			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:              nil,
    		})
    		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 pulumi
    import pulumi_azure_native as azure_native
    
    mongo_db_resource_mongo_db_collection = azure_native.documentdb.MongoDBResourceMongoDBCollection("mongoDBResourceMongoDBCollection",
        account_name="ddb1",
        collection_name="collectionName",
        database_name="databaseName",
        location="West US",
        options=azure_native.documentdb.CreateUpdateOptionsArgs(),
        resource=azure_native.documentdb.MongoDBCollectionResourceArgs(
            id="collectionName",
            indexes=[
                azure_native.documentdb.MongoIndexArgs(
                    key=azure_native.documentdb.MongoIndexKeysArgs(
                        keys=["_ts"],
                    ),
                    options=azure_native.documentdb.MongoIndexOptionsArgs(
                        expire_after_seconds=100,
                        unique=True,
                    ),
                ),
                azure_native.documentdb.MongoIndexArgs(
                    key=azure_native.documentdb.MongoIndexKeysArgs(
                        keys=["_id"],
                    ),
                ),
            ],
            shard_key={
                "testKey": "Hash",
            },
        ),
        resource_group_name="rg1",
        tags={})
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const mongoDBResourceMongoDBCollection = new azure_native.documentdb.MongoDBResourceMongoDBCollection("mongoDBResourceMongoDBCollection", {
        accountName: "ddb1",
        collectionName: "collectionName",
        databaseName: "databaseName",
        location: "West US",
        options: {},
        resource: {
            id: "collectionName",
            indexes: [
                {
                    key: {
                        keys: ["_ts"],
                    },
                    options: {
                        expireAfterSeconds: 100,
                        unique: true,
                    },
                },
                {
                    key: {
                        keys: ["_id"],
                    },
                },
            ],
            shardKey: {
                testKey: "Hash",
            },
        },
        resourceGroupName: "rg1",
        tags: {},
    });
    
    resources:
      mongoDBResourceMongoDBCollection:
        type: azure-native:documentdb:MongoDBResourceMongoDBCollection
        properties:
          accountName: ddb1
          collectionName: collectionName
          databaseName: databaseName
          location: West US
          options: {}
          resource:
            id: collectionName
            indexes:
              - key:
                  keys:
                    - _ts
                options:
                  expireAfterSeconds: 100
                  unique: true
              - key:
                  keys:
                    - _id
            shardKey:
              testKey: Hash
          resourceGroupName: rg1
          tags: {}
    

    Create MongoDBResourceMongoDBCollection Resource

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

    Constructor syntax

    new MongoDBResourceMongoDBCollection(name: string, args: MongoDBResourceMongoDBCollectionArgs, opts?: CustomResourceOptions);
    @overload
    def MongoDBResourceMongoDBCollection(resource_name: str,
                                         args: MongoDBResourceMongoDBCollectionArgs,
                                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def MongoDBResourceMongoDBCollection(resource_name: str,
                                         opts: Optional[ResourceOptions] = None,
                                         account_name: Optional[str] = None,
                                         database_name: Optional[str] = None,
                                         resource: Optional[MongoDBCollectionResourceArgs] = None,
                                         resource_group_name: Optional[str] = None,
                                         collection_name: Optional[str] = None,
                                         location: Optional[str] = None,
                                         options: Optional[CreateUpdateOptionsArgs] = None,
                                         tags: Optional[Mapping[str, str]] = None)
    func NewMongoDBResourceMongoDBCollection(ctx *Context, name string, args MongoDBResourceMongoDBCollectionArgs, opts ...ResourceOption) (*MongoDBResourceMongoDBCollection, error)
    public MongoDBResourceMongoDBCollection(string name, MongoDBResourceMongoDBCollectionArgs args, CustomResourceOptions? opts = null)
    public MongoDBResourceMongoDBCollection(String name, MongoDBResourceMongoDBCollectionArgs args)
    public MongoDBResourceMongoDBCollection(String name, MongoDBResourceMongoDBCollectionArgs args, CustomResourceOptions options)
    
    type: azure-native:documentdb:MongoDBResourceMongoDBCollection
    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 MongoDBResourceMongoDBCollectionArgs
    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 MongoDBResourceMongoDBCollectionArgs
    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 MongoDBResourceMongoDBCollectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MongoDBResourceMongoDBCollectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MongoDBResourceMongoDBCollectionArgs
    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 mongoDBResourceMongoDBCollectionResource = new AzureNative.DocumentDB.MongoDBResourceMongoDBCollection("mongoDBResourceMongoDBCollectionResource", new()
    {
        AccountName = "string",
        DatabaseName = "string",
        Resource = new AzureNative.DocumentDB.Inputs.MongoDBCollectionResourceArgs
        {
            Id = "string",
            AnalyticalStorageTtl = 0,
            Indexes = new[]
            {
                new AzureNative.DocumentDB.Inputs.MongoIndexArgs
                {
                    Key = new AzureNative.DocumentDB.Inputs.MongoIndexKeysArgs
                    {
                        Keys = new[]
                        {
                            "string",
                        },
                    },
                    Options = new AzureNative.DocumentDB.Inputs.MongoIndexOptionsArgs
                    {
                        ExpireAfterSeconds = 0,
                        Unique = false,
                    },
                },
            },
            ShardKey = 
            {
                { "string", "string" },
            },
        },
        ResourceGroupName = "string",
        CollectionName = "string",
        Location = "string",
        Options = new AzureNative.DocumentDB.Inputs.CreateUpdateOptionsArgs
        {
            AutoscaleSettings = new AzureNative.DocumentDB.Inputs.AutoscaleSettingsArgs
            {
                MaxThroughput = 0,
            },
            Throughput = 0,
        },
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := documentdb.NewMongoDBResourceMongoDBCollection(ctx, "mongoDBResourceMongoDBCollectionResource", &documentdb.MongoDBResourceMongoDBCollectionArgs{
    AccountName: pulumi.String("string"),
    DatabaseName: pulumi.String("string"),
    Resource: &documentdb.MongoDBCollectionResourceArgs{
    Id: pulumi.String("string"),
    AnalyticalStorageTtl: pulumi.Int(0),
    Indexes: documentdb.MongoIndexArray{
    &documentdb.MongoIndexArgs{
    Key: &documentdb.MongoIndexKeysArgs{
    Keys: pulumi.StringArray{
    pulumi.String("string"),
    },
    },
    Options: &documentdb.MongoIndexOptionsArgs{
    ExpireAfterSeconds: pulumi.Int(0),
    Unique: pulumi.Bool(false),
    },
    },
    },
    ShardKey: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    },
    ResourceGroupName: pulumi.String("string"),
    CollectionName: pulumi.String("string"),
    Location: pulumi.String("string"),
    Options: &documentdb.CreateUpdateOptionsArgs{
    AutoscaleSettings: &documentdb.AutoscaleSettingsArgs{
    MaxThroughput: pulumi.Int(0),
    },
    Throughput: pulumi.Int(0),
    },
    Tags: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    })
    
    var mongoDBResourceMongoDBCollectionResource = new MongoDBResourceMongoDBCollection("mongoDBResourceMongoDBCollectionResource", MongoDBResourceMongoDBCollectionArgs.builder()
        .accountName("string")
        .databaseName("string")
        .resource(MongoDBCollectionResourceArgs.builder()
            .id("string")
            .analyticalStorageTtl(0)
            .indexes(MongoIndexArgs.builder()
                .key(MongoIndexKeysArgs.builder()
                    .keys("string")
                    .build())
                .options(MongoIndexOptionsArgs.builder()
                    .expireAfterSeconds(0)
                    .unique(false)
                    .build())
                .build())
            .shardKey(Map.of("string", "string"))
            .build())
        .resourceGroupName("string")
        .collectionName("string")
        .location("string")
        .options(CreateUpdateOptionsArgs.builder()
            .autoscaleSettings(AutoscaleSettingsArgs.builder()
                .maxThroughput(0)
                .build())
            .throughput(0)
            .build())
        .tags(Map.of("string", "string"))
        .build());
    
    mongo_db_resource_mongo_db_collection_resource = azure_native.documentdb.MongoDBResourceMongoDBCollection("mongoDBResourceMongoDBCollectionResource",
        account_name="string",
        database_name="string",
        resource=azure_native.documentdb.MongoDBCollectionResourceArgs(
            id="string",
            analytical_storage_ttl=0,
            indexes=[azure_native.documentdb.MongoIndexArgs(
                key=azure_native.documentdb.MongoIndexKeysArgs(
                    keys=["string"],
                ),
                options=azure_native.documentdb.MongoIndexOptionsArgs(
                    expire_after_seconds=0,
                    unique=False,
                ),
            )],
            shard_key={
                "string": "string",
            },
        ),
        resource_group_name="string",
        collection_name="string",
        location="string",
        options=azure_native.documentdb.CreateUpdateOptionsArgs(
            autoscale_settings=azure_native.documentdb.AutoscaleSettingsArgs(
                max_throughput=0,
            ),
            throughput=0,
        ),
        tags={
            "string": "string",
        })
    
    const mongoDBResourceMongoDBCollectionResource = new azure_native.documentdb.MongoDBResourceMongoDBCollection("mongoDBResourceMongoDBCollectionResource", {
        accountName: "string",
        databaseName: "string",
        resource: {
            id: "string",
            analyticalStorageTtl: 0,
            indexes: [{
                key: {
                    keys: ["string"],
                },
                options: {
                    expireAfterSeconds: 0,
                    unique: false,
                },
            }],
            shardKey: {
                string: "string",
            },
        },
        resourceGroupName: "string",
        collectionName: "string",
        location: "string",
        options: {
            autoscaleSettings: {
                maxThroughput: 0,
            },
            throughput: 0,
        },
        tags: {
            string: "string",
        },
    });
    
    type: azure-native:documentdb:MongoDBResourceMongoDBCollection
    properties:
        accountName: string
        collectionName: string
        databaseName: string
        location: string
        options:
            autoscaleSettings:
                maxThroughput: 0
            throughput: 0
        resource:
            analyticalStorageTtl: 0
            id: string
            indexes:
                - key:
                    keys:
                        - string
                  options:
                    expireAfterSeconds: 0
                    unique: false
            shardKey:
                string: string
        resourceGroupName: string
        tags:
            string: string
    

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

    AccountName string
    Cosmos DB database account name.
    DatabaseName string
    Cosmos DB database name.
    Resource Pulumi.AzureNative.DocumentDB.Inputs.MongoDBCollectionResource
    The standard JSON format of a MongoDB collection
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    CollectionName string
    Cosmos DB collection name.
    Location string
    The location of the resource group to which the resource belongs.
    Options Pulumi.AzureNative.DocumentDB.Inputs.CreateUpdateOptions
    A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
    Tags Dictionary<string, string>
    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".
    AccountName string
    Cosmos DB database account name.
    DatabaseName string
    Cosmos DB database name.
    Resource MongoDBCollectionResourceArgs
    The standard JSON format of a MongoDB collection
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    CollectionName string
    Cosmos DB collection name.
    Location string
    The location of the resource group to which the resource belongs.
    Options CreateUpdateOptionsArgs
    A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
    Tags map[string]string
    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".
    accountName String
    Cosmos DB database account name.
    databaseName String
    Cosmos DB database name.
    resource MongoDBCollectionResource
    The standard JSON format of a MongoDB collection
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    collectionName String
    Cosmos DB collection name.
    location String
    The location of the resource group to which the resource belongs.
    options CreateUpdateOptions
    A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
    tags Map<String,String>
    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".
    accountName string
    Cosmos DB database account name.
    databaseName string
    Cosmos DB database name.
    resource MongoDBCollectionResource
    The standard JSON format of a MongoDB collection
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    collectionName string
    Cosmos DB collection name.
    location string
    The location of the resource group to which the resource belongs.
    options CreateUpdateOptions
    A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
    tags {[key: string]: string}
    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".
    account_name str
    Cosmos DB database account name.
    database_name str
    Cosmos DB database name.
    resource MongoDBCollectionResourceArgs
    The standard JSON format of a MongoDB collection
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    collection_name str
    Cosmos DB collection name.
    location str
    The location of the resource group to which the resource belongs.
    options CreateUpdateOptionsArgs
    A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
    tags Mapping[str, str]
    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".
    accountName String
    Cosmos DB database account name.
    databaseName String
    Cosmos DB database name.
    resource Property Map
    The standard JSON format of a MongoDB collection
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    collectionName String
    Cosmos DB collection name.
    location String
    The location of the resource group to which the resource belongs.
    options Property Map
    A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
    tags Map<String>
    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".

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the ARM resource.
    Type string
    The type of Azure resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the ARM resource.
    Type string
    The type of Azure resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the ARM resource.
    type String
    The type of Azure resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the ARM resource.
    type string
    The type of Azure resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the ARM resource.
    type str
    The type of Azure resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the ARM resource.
    type String
    The type of Azure resource.

    Supporting Types

    AutoscaleSettings, AutoscaleSettingsArgs

    MaxThroughput int
    Represents maximum throughput, the resource can scale up to.
    MaxThroughput int
    Represents maximum throughput, the resource can scale up to.
    maxThroughput Integer
    Represents maximum throughput, the resource can scale up to.
    maxThroughput number
    Represents maximum throughput, the resource can scale up to.
    max_throughput int
    Represents maximum throughput, the resource can scale up to.
    maxThroughput Number
    Represents maximum throughput, the resource can scale up to.

    AutoscaleSettingsResponse, AutoscaleSettingsResponseArgs

    MaxThroughput int
    Represents maximum throughput, the resource can scale up to.
    MaxThroughput int
    Represents maximum throughput, the resource can scale up to.
    maxThroughput Integer
    Represents maximum throughput, the resource can scale up to.
    maxThroughput number
    Represents maximum throughput, the resource can scale up to.
    max_throughput int
    Represents maximum throughput, the resource can scale up to.
    maxThroughput Number
    Represents maximum throughput, the resource can scale up to.

    CreateUpdateOptions, CreateUpdateOptionsArgs

    AutoscaleSettings Pulumi.AzureNative.DocumentDB.Inputs.AutoscaleSettings
    Specifies the Autoscale settings.
    Throughput int
    Request Units per second. For example, "throughput": 10000.
    AutoscaleSettings AutoscaleSettings
    Specifies the Autoscale settings.
    Throughput int
    Request Units per second. For example, "throughput": 10000.
    autoscaleSettings AutoscaleSettings
    Specifies the Autoscale settings.
    throughput Integer
    Request Units per second. For example, "throughput": 10000.
    autoscaleSettings AutoscaleSettings
    Specifies the Autoscale settings.
    throughput number
    Request Units per second. For example, "throughput": 10000.
    autoscale_settings AutoscaleSettings
    Specifies the Autoscale settings.
    throughput int
    Request Units per second. For example, "throughput": 10000.
    autoscaleSettings Property Map
    Specifies the Autoscale settings.
    throughput Number
    Request Units per second. For example, "throughput": 10000.

    MongoDBCollectionGetPropertiesResponseOptions, MongoDBCollectionGetPropertiesResponseOptionsArgs

    AutoscaleSettings Pulumi.AzureNative.DocumentDB.Inputs.AutoscaleSettingsResponse
    Specifies the Autoscale settings.
    Throughput int
    Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
    AutoscaleSettings AutoscaleSettingsResponse
    Specifies the Autoscale settings.
    Throughput int
    Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
    autoscaleSettings AutoscaleSettingsResponse
    Specifies the Autoscale settings.
    throughput Integer
    Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
    autoscaleSettings AutoscaleSettingsResponse
    Specifies the Autoscale settings.
    throughput number
    Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
    autoscale_settings AutoscaleSettingsResponse
    Specifies the Autoscale settings.
    throughput int
    Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
    autoscaleSettings Property Map
    Specifies the Autoscale settings.
    throughput Number
    Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.

    MongoDBCollectionGetPropertiesResponseResource, MongoDBCollectionGetPropertiesResponseResourceArgs

    Etag string
    A system generated property representing the resource etag required for optimistic concurrency control.
    Id string
    Name of the Cosmos DB MongoDB collection
    Rid string
    A system generated property. A unique identifier.
    Ts double
    A system generated property that denotes the last updated timestamp of the resource.
    AnalyticalStorageTtl int
    Analytical TTL.
    Indexes List<Pulumi.AzureNative.DocumentDB.Inputs.MongoIndexResponse>
    List of index keys
    ShardKey Dictionary<string, string>
    A key-value pair of shard keys to be applied for the request.
    Etag string
    A system generated property representing the resource etag required for optimistic concurrency control.
    Id string
    Name of the Cosmos DB MongoDB collection
    Rid string
    A system generated property. A unique identifier.
    Ts float64
    A system generated property that denotes the last updated timestamp of the resource.
    AnalyticalStorageTtl int
    Analytical TTL.
    Indexes []MongoIndexResponse
    List of index keys
    ShardKey map[string]string
    A key-value pair of shard keys to be applied for the request.
    etag String
    A system generated property representing the resource etag required for optimistic concurrency control.
    id String
    Name of the Cosmos DB MongoDB collection
    rid String
    A system generated property. A unique identifier.
    ts Double
    A system generated property that denotes the last updated timestamp of the resource.
    analyticalStorageTtl Integer
    Analytical TTL.
    indexes List<MongoIndexResponse>
    List of index keys
    shardKey Map<String,String>
    A key-value pair of shard keys to be applied for the request.
    etag string
    A system generated property representing the resource etag required for optimistic concurrency control.
    id string
    Name of the Cosmos DB MongoDB collection
    rid string
    A system generated property. A unique identifier.
    ts number
    A system generated property that denotes the last updated timestamp of the resource.
    analyticalStorageTtl number
    Analytical TTL.
    indexes MongoIndexResponse[]
    List of index keys
    shardKey {[key: string]: string}
    A key-value pair of shard keys to be applied for the request.
    etag str
    A system generated property representing the resource etag required for optimistic concurrency control.
    id str
    Name of the Cosmos DB MongoDB collection
    rid str
    A system generated property. A unique identifier.
    ts float
    A system generated property that denotes the last updated timestamp of the resource.
    analytical_storage_ttl int
    Analytical TTL.
    indexes Sequence[MongoIndexResponse]
    List of index keys
    shard_key Mapping[str, str]
    A key-value pair of shard keys to be applied for the request.
    etag String
    A system generated property representing the resource etag required for optimistic concurrency control.
    id String
    Name of the Cosmos DB MongoDB collection
    rid String
    A system generated property. A unique identifier.
    ts Number
    A system generated property that denotes the last updated timestamp of the resource.
    analyticalStorageTtl Number
    Analytical TTL.
    indexes List<Property Map>
    List of index keys
    shardKey Map<String>
    A key-value pair of shard keys to be applied for the request.

    MongoDBCollectionResource, MongoDBCollectionResourceArgs

    Id string
    Name of the Cosmos DB MongoDB collection
    AnalyticalStorageTtl int
    Analytical TTL.
    Indexes List<Pulumi.AzureNative.DocumentDB.Inputs.MongoIndex>
    List of index keys
    ShardKey Dictionary<string, string>
    A key-value pair of shard keys to be applied for the request.
    Id string
    Name of the Cosmos DB MongoDB collection
    AnalyticalStorageTtl int
    Analytical TTL.
    Indexes []MongoIndex
    List of index keys
    ShardKey map[string]string
    A key-value pair of shard keys to be applied for the request.
    id String
    Name of the Cosmos DB MongoDB collection
    analyticalStorageTtl Integer
    Analytical TTL.
    indexes List<MongoIndex>
    List of index keys
    shardKey Map<String,String>
    A key-value pair of shard keys to be applied for the request.
    id string
    Name of the Cosmos DB MongoDB collection
    analyticalStorageTtl number
    Analytical TTL.
    indexes MongoIndex[]
    List of index keys
    shardKey {[key: string]: string}
    A key-value pair of shard keys to be applied for the request.
    id str
    Name of the Cosmos DB MongoDB collection
    analytical_storage_ttl int
    Analytical TTL.
    indexes Sequence[MongoIndex]
    List of index keys
    shard_key Mapping[str, str]
    A key-value pair of shard keys to be applied for the request.
    id String
    Name of the Cosmos DB MongoDB collection
    analyticalStorageTtl Number
    Analytical TTL.
    indexes List<Property Map>
    List of index keys
    shardKey Map<String>
    A key-value pair of shard keys to be applied for the request.

    MongoIndex, MongoIndexArgs

    Key Pulumi.AzureNative.DocumentDB.Inputs.MongoIndexKeys
    Cosmos DB MongoDB collection index keys
    Options Pulumi.AzureNative.DocumentDB.Inputs.MongoIndexOptions
    Cosmos DB MongoDB collection index key options
    Key MongoIndexKeys
    Cosmos DB MongoDB collection index keys
    Options MongoIndexOptions
    Cosmos DB MongoDB collection index key options
    key MongoIndexKeys
    Cosmos DB MongoDB collection index keys
    options MongoIndexOptions
    Cosmos DB MongoDB collection index key options
    key MongoIndexKeys
    Cosmos DB MongoDB collection index keys
    options MongoIndexOptions
    Cosmos DB MongoDB collection index key options
    key MongoIndexKeys
    Cosmos DB MongoDB collection index keys
    options MongoIndexOptions
    Cosmos DB MongoDB collection index key options
    key Property Map
    Cosmos DB MongoDB collection index keys
    options Property Map
    Cosmos DB MongoDB collection index key options

    MongoIndexKeys, MongoIndexKeysArgs

    Keys List<string>
    List of keys for each MongoDB collection in the Azure Cosmos DB service
    Keys []string
    List of keys for each MongoDB collection in the Azure Cosmos DB service
    keys List<String>
    List of keys for each MongoDB collection in the Azure Cosmos DB service
    keys string[]
    List of keys for each MongoDB collection in the Azure Cosmos DB service
    keys Sequence[str]
    List of keys for each MongoDB collection in the Azure Cosmos DB service
    keys List<String>
    List of keys for each MongoDB collection in the Azure Cosmos DB service

    MongoIndexKeysResponse, MongoIndexKeysResponseArgs

    Keys List<string>
    List of keys for each MongoDB collection in the Azure Cosmos DB service
    Keys []string
    List of keys for each MongoDB collection in the Azure Cosmos DB service
    keys List<String>
    List of keys for each MongoDB collection in the Azure Cosmos DB service
    keys string[]
    List of keys for each MongoDB collection in the Azure Cosmos DB service
    keys Sequence[str]
    List of keys for each MongoDB collection in the Azure Cosmos DB service
    keys List<String>
    List of keys for each MongoDB collection in the Azure Cosmos DB service

    MongoIndexOptions, MongoIndexOptionsArgs

    ExpireAfterSeconds int
    Expire after seconds
    Unique bool
    Is unique or not
    ExpireAfterSeconds int
    Expire after seconds
    Unique bool
    Is unique or not
    expireAfterSeconds Integer
    Expire after seconds
    unique Boolean
    Is unique or not
    expireAfterSeconds number
    Expire after seconds
    unique boolean
    Is unique or not
    expire_after_seconds int
    Expire after seconds
    unique bool
    Is unique or not
    expireAfterSeconds Number
    Expire after seconds
    unique Boolean
    Is unique or not

    MongoIndexOptionsResponse, MongoIndexOptionsResponseArgs

    ExpireAfterSeconds int
    Expire after seconds
    Unique bool
    Is unique or not
    ExpireAfterSeconds int
    Expire after seconds
    Unique bool
    Is unique or not
    expireAfterSeconds Integer
    Expire after seconds
    unique Boolean
    Is unique or not
    expireAfterSeconds number
    Expire after seconds
    unique boolean
    Is unique or not
    expire_after_seconds int
    Expire after seconds
    unique bool
    Is unique or not
    expireAfterSeconds Number
    Expire after seconds
    unique Boolean
    Is unique or not

    MongoIndexResponse, MongoIndexResponseArgs

    Key MongoIndexKeysResponse
    Cosmos DB MongoDB collection index keys
    Options MongoIndexOptionsResponse
    Cosmos DB MongoDB collection index key options
    key MongoIndexKeysResponse
    Cosmos DB MongoDB collection index keys
    options MongoIndexOptionsResponse
    Cosmos DB MongoDB collection index key options
    key MongoIndexKeysResponse
    Cosmos DB MongoDB collection index keys
    options MongoIndexOptionsResponse
    Cosmos DB MongoDB collection index key options
    key MongoIndexKeysResponse
    Cosmos DB MongoDB collection index keys
    options MongoIndexOptionsResponse
    Cosmos DB MongoDB collection index key options
    key Property Map
    Cosmos DB MongoDB collection index keys
    options Property Map
    Cosmos DB MongoDB collection index key options

    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} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.47.0 published on Monday, Jun 24, 2024 by Pulumi