Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. documentdb
  5. getMongoDBResourceMongoDBCollection
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.documentdb.getMongoDBResourceMongoDBCollection

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the MongoDB collection under an existing Azure Cosmos DB database account. Azure REST API version: 2023-04-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.

Using getMongoDBResourceMongoDBCollection

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 getMongoDBResourceMongoDBCollection(args: GetMongoDBResourceMongoDBCollectionArgs, opts?: InvokeOptions): Promise<GetMongoDBResourceMongoDBCollectionResult>
function getMongoDBResourceMongoDBCollectionOutput(args: GetMongoDBResourceMongoDBCollectionOutputArgs, opts?: InvokeOptions): Output<GetMongoDBResourceMongoDBCollectionResult>
Copy
def get_mongo_db_resource_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) -> GetMongoDBResourceMongoDBCollectionResult
def get_mongo_db_resource_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[GetMongoDBResourceMongoDBCollectionResult]
Copy
func LookupMongoDBResourceMongoDBCollection(ctx *Context, args *LookupMongoDBResourceMongoDBCollectionArgs, opts ...InvokeOption) (*LookupMongoDBResourceMongoDBCollectionResult, error)
func LookupMongoDBResourceMongoDBCollectionOutput(ctx *Context, args *LookupMongoDBResourceMongoDBCollectionOutputArgs, opts ...InvokeOption) LookupMongoDBResourceMongoDBCollectionResultOutput
Copy

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

public static class GetMongoDBResourceMongoDBCollection 
{
    public static Task<GetMongoDBResourceMongoDBCollectionResult> InvokeAsync(GetMongoDBResourceMongoDBCollectionArgs args, InvokeOptions? opts = null)
    public static Output<GetMongoDBResourceMongoDBCollectionResult> Invoke(GetMongoDBResourceMongoDBCollectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetMongoDBResourceMongoDBCollectionResult> getMongoDBResourceMongoDBCollection(GetMongoDBResourceMongoDBCollectionArgs args, InvokeOptions options)
public static Output<GetMongoDBResourceMongoDBCollectionResult> getMongoDBResourceMongoDBCollection(GetMongoDBResourceMongoDBCollectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:documentdb:getMongoDBResourceMongoDBCollection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
CollectionName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB collection name.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
CollectionName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB collection name.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
collectionName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB collection name.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
collectionName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB collection name.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
account_name
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB database account name.
collection_name
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB collection name.
database_name
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB database name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
collectionName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB collection name.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getMongoDBResourceMongoDBCollection Result

The following output properties are available:

Id string
The unique resource identifier of the ARM resource.
Name string
The name of the ARM resource.
Type string
The type of Azure resource.
Location string
The location of the resource group to which the resource belongs.
Options Pulumi.AzureNative.DocumentDB.Outputs.MongoDBCollectionGetPropertiesResponseOptions
Resource Pulumi.AzureNative.DocumentDB.Outputs.MongoDBCollectionGetPropertiesResponseResource
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".
Id string
The unique resource identifier of the ARM resource.
Name string
The name of the ARM resource.
Type string
The type of Azure resource.
Location string
The location of the resource group to which the resource belongs.
Options MongoDBCollectionGetPropertiesResponseOptions
Resource MongoDBCollectionGetPropertiesResponseResource
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".
id String
The unique resource identifier of the ARM resource.
name String
The name of the ARM resource.
type String
The type of Azure resource.
location String
The location of the resource group to which the resource belongs.
options MongoDBCollectionGetPropertiesResponseOptions
resource MongoDBCollectionGetPropertiesResponseResource
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".
id string
The unique resource identifier of the ARM resource.
name string
The name of the ARM resource.
type string
The type of Azure resource.
location string
The location of the resource group to which the resource belongs.
options MongoDBCollectionGetPropertiesResponseOptions
resource MongoDBCollectionGetPropertiesResponseResource
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".
id str
The unique resource identifier of the ARM resource.
name str
The name of the ARM resource.
type str
The type of Azure resource.
location str
The location of the resource group to which the resource belongs.
options MongoDBCollectionGetPropertiesResponseOptions
resource MongoDBCollectionGetPropertiesResponseResource
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".
id String
The unique resource identifier of the ARM resource.
name String
The name of the ARM resource.
type String
The type of Azure resource.
location String
The location of the resource group to which the resource belongs.
options Property Map
resource Property Map
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

AutoscaleSettingsResponse

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.

MongoDBCollectionGetPropertiesResponseOptions

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

Etag This property is required. string
A system generated property representing the resource etag required for optimistic concurrency control.
Id This property is required. string
Name of the Cosmos DB MongoDB collection
Rid This property is required. string
A system generated property. A unique identifier.
Ts This property is required. 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 This property is required. string
A system generated property representing the resource etag required for optimistic concurrency control.
Id This property is required. string
Name of the Cosmos DB MongoDB collection
Rid This property is required. string
A system generated property. A unique identifier.
Ts This property is required. 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 This property is required. String
A system generated property representing the resource etag required for optimistic concurrency control.
id This property is required. String
Name of the Cosmos DB MongoDB collection
rid This property is required. String
A system generated property. A unique identifier.
ts This property is required. 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 This property is required. string
A system generated property representing the resource etag required for optimistic concurrency control.
id This property is required. string
Name of the Cosmos DB MongoDB collection
rid This property is required. string
A system generated property. A unique identifier.
ts This property is required. 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 This property is required. str
A system generated property representing the resource etag required for optimistic concurrency control.
id This property is required. str
Name of the Cosmos DB MongoDB collection
rid This property is required. str
A system generated property. A unique identifier.
ts This property is required. 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 This property is required. String
A system generated property representing the resource etag required for optimistic concurrency control.
id This property is required. String
Name of the Cosmos DB MongoDB collection
rid This property is required. String
A system generated property. A unique identifier.
ts This property is required. 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.

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 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-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native