1. Packages
  2. Azure Native
  3. API Docs
  4. cosmosdb
  5. getDatabaseAccountMongoDBCollection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.8.0 published on Wednesday, Sep 3, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.cosmosdb.getDatabaseAccountMongoDBCollection

Get Started
azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.8.0 published on Wednesday, Sep 3, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets the MongoDB collection under an existing Azure Cosmos DB database account.

    Uses Azure REST API version 2016-03-31.

    Other available API versions: 2015-04-01, 2015-04-08, 2015-11-06, 2016-03-19. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cosmosdb [ApiVersion]. See the version guide for details.

    Using getDatabaseAccountMongoDBCollection

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDatabaseAccountMongoDBCollection(args: GetDatabaseAccountMongoDBCollectionArgs, opts?: InvokeOptions): Promise<GetDatabaseAccountMongoDBCollectionResult>
function getDatabaseAccountMongoDBCollectionOutput(args: GetDatabaseAccountMongoDBCollectionOutputArgs, opts?: InvokeOptions): Output<GetDatabaseAccountMongoDBCollectionResult>
    def get_database_account_mongo_db_collection(account_name: Optional[str] = None,
                                             collection_name: Optional[str] = None,
                                             database_name: Optional[str] = None,
                                             resource_group_name: Optional[str] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetDatabaseAccountMongoDBCollectionResult
def get_database_account_mongo_db_collection_output(account_name: Optional[pulumi.Input[str]] = None,
                                             collection_name: Optional[pulumi.Input[str]] = None,
                                             database_name: Optional[pulumi.Input[str]] = None,
                                             resource_group_name: Optional[pulumi.Input[str]] = None,
                                             opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseAccountMongoDBCollectionResult]
    func LookupDatabaseAccountMongoDBCollection(ctx *Context, args *LookupDatabaseAccountMongoDBCollectionArgs, opts ...InvokeOption) (*LookupDatabaseAccountMongoDBCollectionResult, error)
func LookupDatabaseAccountMongoDBCollectionOutput(ctx *Context, args *LookupDatabaseAccountMongoDBCollectionOutputArgs, opts ...InvokeOption) LookupDatabaseAccountMongoDBCollectionResultOutput

    > Note: This function is named LookupDatabaseAccountMongoDBCollection in the Go SDK.

    public static class GetDatabaseAccountMongoDBCollection 
{
    public static Task<GetDatabaseAccountMongoDBCollectionResult> InvokeAsync(GetDatabaseAccountMongoDBCollectionArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseAccountMongoDBCollectionResult> Invoke(GetDatabaseAccountMongoDBCollectionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDatabaseAccountMongoDBCollectionResult> getDatabaseAccountMongoDBCollection(GetDatabaseAccountMongoDBCollectionArgs args, InvokeOptions options)
public static Output<GetDatabaseAccountMongoDBCollectionResult> getDatabaseAccountMongoDBCollection(GetDatabaseAccountMongoDBCollectionArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:cosmosdb:getDatabaseAccountMongoDBCollection
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AccountName string
    Cosmos DB database account name.
    CollectionName string
    Cosmos DB collection name.
    DatabaseName string
    Cosmos DB database name.
    ResourceGroupName string
    Name of an Azure resource group.
    AccountName string
    Cosmos DB database account name.
    CollectionName string
    Cosmos DB collection name.
    DatabaseName string
    Cosmos DB database name.
    ResourceGroupName string
    Name of an Azure resource group.
    accountName String
    Cosmos DB database account name.
    collectionName String
    Cosmos DB collection name.
    databaseName String
    Cosmos DB database name.
    resourceGroupName String
    Name of an Azure resource group.
    accountName string
    Cosmos DB database account name.
    collectionName string
    Cosmos DB collection name.
    databaseName string
    Cosmos DB database name.
    resourceGroupName string
    Name of an Azure resource group.
    account_name str
    Cosmos DB database account name.
    collection_name str
    Cosmos DB collection name.
    database_name str
    Cosmos DB database name.
    resource_group_name str
    Name of an Azure resource group.
    accountName String
    Cosmos DB database account name.
    collectionName String
    Cosmos DB collection name.
    databaseName String
    Cosmos DB database name.
    resourceGroupName String
    Name of an Azure resource group.

    getDatabaseAccountMongoDBCollection Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The unique resource identifier of the database account.
    Name string
    The name of the database account.
    Type string
    The type of Azure resource.
    Indexes List<Pulumi.AzureNative.CosmosDB.Outputs.MongoIndexResponse>
    List of index keys
    Location string
    The location of the resource group to which the resource belongs.
    ShardKey Dictionary<string, string>
    A key-value pair of shard keys to be applied for 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".
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The unique resource identifier of the database account.
    Name string
    The name of the database account.
    Type string
    The type of Azure resource.
    Indexes []MongoIndexResponse
    List of index keys
    Location string
    The location of the resource group to which the resource belongs.
    ShardKey map[string]string
    A key-value pair of shard keys to be applied for 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".
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The unique resource identifier of the database account.
    name String
    The name of the database account.
    type String
    The type of Azure resource.
    indexes List<MongoIndexResponse>
    List of index keys
    location String
    The location of the resource group to which the resource belongs.
    shardKey Map<String,String>
    A key-value pair of shard keys to be applied for 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".
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The unique resource identifier of the database account.
    name string
    The name of the database account.
    type string
    The type of Azure resource.
    indexes MongoIndexResponse[]
    List of index keys
    location string
    The location of the resource group to which the resource belongs.
    shardKey {[key: string]: string}
    A key-value pair of shard keys to be applied for 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".
    azure_api_version str
    The Azure API version of the resource.
    id str
    The unique resource identifier of the database account.
    name str
    The name of the database account.
    type str
    The type of Azure resource.
    indexes Sequence[MongoIndexResponse]
    List of index keys
    location str
    The location of the resource group to which the resource belongs.
    shard_key Mapping[str, str]
    A key-value pair of shard keys to be applied for 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".
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The unique resource identifier of the database account.
    name String
    The name of the database account.
    type String
    The type of Azure resource.
    indexes List<Property Map>
    List of index keys
    location String
    The location of the resource group to which the resource belongs.
    shardKey Map<String>
    A key-value pair of shard keys to be applied for 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".

    Supporting Types

    MongoIndexKeysResponse

    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

    MongoIndexOptionsResponse

    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

    Key Pulumi.AzureNative.CosmosDB.Inputs.MongoIndexKeysResponse
    Cosmos DB MongoDB collection index keys
    Options Pulumi.AzureNative.CosmosDB.Inputs.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 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

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.8.0 published on Wednesday, Sep 3, 2025 by Pulumi
    pulumi/pulumi-azure-native
      Meet Neo: Your AI Platform Teammate