Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. cosmosdb
  5. getDatabaseAccountMongoDBDatabase
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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.cosmosdb.getDatabaseAccountMongoDBDatabase

Explore with Pulumi AI

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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name.

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 getDatabaseAccountMongoDBDatabase

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 getDatabaseAccountMongoDBDatabase(args: GetDatabaseAccountMongoDBDatabaseArgs, opts?: InvokeOptions): Promise<GetDatabaseAccountMongoDBDatabaseResult>
function getDatabaseAccountMongoDBDatabaseOutput(args: GetDatabaseAccountMongoDBDatabaseOutputArgs, opts?: InvokeOptions): Output<GetDatabaseAccountMongoDBDatabaseResult>
Copy
def get_database_account_mongo_db_database(account_name: Optional[str] = None,
                                           database_name: Optional[str] = None,
                                           resource_group_name: Optional[str] = None,
                                           opts: Optional[InvokeOptions] = None) -> GetDatabaseAccountMongoDBDatabaseResult
def get_database_account_mongo_db_database_output(account_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[GetDatabaseAccountMongoDBDatabaseResult]
Copy
func LookupDatabaseAccountMongoDBDatabase(ctx *Context, args *LookupDatabaseAccountMongoDBDatabaseArgs, opts ...InvokeOption) (*LookupDatabaseAccountMongoDBDatabaseResult, error)
func LookupDatabaseAccountMongoDBDatabaseOutput(ctx *Context, args *LookupDatabaseAccountMongoDBDatabaseOutputArgs, opts ...InvokeOption) LookupDatabaseAccountMongoDBDatabaseResultOutput
Copy

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

public static class GetDatabaseAccountMongoDBDatabase 
{
    public static Task<GetDatabaseAccountMongoDBDatabaseResult> InvokeAsync(GetDatabaseAccountMongoDBDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseAccountMongoDBDatabaseResult> Invoke(GetDatabaseAccountMongoDBDatabaseInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDatabaseAccountMongoDBDatabaseResult> getDatabaseAccountMongoDBDatabase(GetDatabaseAccountMongoDBDatabaseArgs args, InvokeOptions options)
public static Output<GetDatabaseAccountMongoDBDatabaseResult> getDatabaseAccountMongoDBDatabase(GetDatabaseAccountMongoDBDatabaseArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:cosmosdb:getDatabaseAccountMongoDBDatabase
  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.
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
Name of an Azure resource group.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account 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
Name of an Azure resource group.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account 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
Name of an Azure resource group.
accountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account 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
Name of an Azure resource group.
account_name
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB database account 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
Name of an Azure resource group.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account 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
Name of an Azure resource group.

getDatabaseAccountMongoDBDatabase 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.
Location string
The location of the resource group to which the resource belongs.
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.
Location string
The location of the resource group to which the resource belongs.
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.
location String
The location of the resource group to which the resource belongs.
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.
location string
The location of the resource group to which the resource belongs.
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.
location str
The location of the resource group to which the resource belongs.
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.
location String
The location of the resource group to which the resource belongs.
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".

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native