Azure Native

Pulumi Official
Package maintained by Pulumi
v1.68.2 published on Tuesday, Aug 16, 2022 by Pulumi

getMongoDBResourceMongoDBDatabase

An Azure Cosmos DB MongoDB database. API Version: 2021-03-15.

Using getMongoDBResourceMongoDBDatabase

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 getMongoDBResourceMongoDBDatabase(args: GetMongoDBResourceMongoDBDatabaseArgs, opts?: InvokeOptions): Promise<GetMongoDBResourceMongoDBDatabaseResult>
function getMongoDBResourceMongoDBDatabaseOutput(args: GetMongoDBResourceMongoDBDatabaseOutputArgs, opts?: InvokeOptions): Output<GetMongoDBResourceMongoDBDatabaseResult>
def get_mongo_db_resource_mongo_db_database(account_name: Optional[str] = None,
                                            database_name: Optional[str] = None,
                                            resource_group_name: Optional[str] = None,
                                            opts: Optional[InvokeOptions] = None) -> GetMongoDBResourceMongoDBDatabaseResult
def get_mongo_db_resource_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[GetMongoDBResourceMongoDBDatabaseResult]
func LookupMongoDBResourceMongoDBDatabase(ctx *Context, args *LookupMongoDBResourceMongoDBDatabaseArgs, opts ...InvokeOption) (*LookupMongoDBResourceMongoDBDatabaseResult, error)
func LookupMongoDBResourceMongoDBDatabaseOutput(ctx *Context, args *LookupMongoDBResourceMongoDBDatabaseOutputArgs, opts ...InvokeOption) LookupMongoDBResourceMongoDBDatabaseResultOutput

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

public static class GetMongoDBResourceMongoDBDatabase 
{
    public static Task<GetMongoDBResourceMongoDBDatabaseResult> InvokeAsync(GetMongoDBResourceMongoDBDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetMongoDBResourceMongoDBDatabaseResult> Invoke(GetMongoDBResourceMongoDBDatabaseInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetMongoDBResourceMongoDBDatabaseResult> getMongoDBResourceMongoDBDatabase(GetMongoDBResourceMongoDBDatabaseArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:documentdb:getMongoDBResourceMongoDBDatabase
  Arguments:
    # Arguments dictionary

The following arguments are supported:

AccountName string

Cosmos DB database account name.

DatabaseName string

Cosmos DB database name.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

AccountName string

Cosmos DB database account name.

DatabaseName string

Cosmos DB database name.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

accountName String

Cosmos DB database account name.

databaseName String

Cosmos DB database name.

resourceGroupName String

The name of the resource group. The name is case insensitive.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

resourceGroupName string

The name of the resource group. The name is case insensitive.

account_name str

Cosmos DB database account name.

database_name str

Cosmos DB database name.

resource_group_name str

The name of the resource group. The name is case insensitive.

accountName String

Cosmos DB database account name.

databaseName String

Cosmos DB database name.

resourceGroupName String

The name of the resource group. The name is case insensitive.

getMongoDBResourceMongoDBDatabase 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.MongoDBDatabaseGetPropertiesResponseOptions
Resource Pulumi.AzureNative.DocumentDB.Outputs.MongoDBDatabaseGetPropertiesResponseResource
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 MongoDBDatabaseGetPropertiesResponseOptions
Resource MongoDBDatabaseGetPropertiesResponseResource
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 MongoDBDatabaseGetPropertiesResponseOptions
resource MongoDBDatabaseGetPropertiesResponseResource
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 MongoDBDatabaseGetPropertiesResponseOptions
resource MongoDBDatabaseGetPropertiesResponseResource
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 MongoDBDatabaseGetPropertiesResponseOptions
resource MongoDBDatabaseGetPropertiesResponseResource
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.

MongoDBDatabaseGetPropertiesResponseOptions

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.

MongoDBDatabaseGetPropertiesResponseResource

Etag string

A system generated property representing the resource etag required for optimistic concurrency control.

Id string

Name of the Cosmos DB MongoDB database

Rid string

A system generated property. A unique identifier.

Ts double

A system generated property that denotes the last updated timestamp of the resource.

Etag string

A system generated property representing the resource etag required for optimistic concurrency control.

Id string

Name of the Cosmos DB MongoDB database

Rid string

A system generated property. A unique identifier.

Ts float64

A system generated property that denotes the last updated timestamp of the resource.

etag String

A system generated property representing the resource etag required for optimistic concurrency control.

id String

Name of the Cosmos DB MongoDB database

rid String

A system generated property. A unique identifier.

ts Double

A system generated property that denotes the last updated timestamp of the resource.

etag string

A system generated property representing the resource etag required for optimistic concurrency control.

id string

Name of the Cosmos DB MongoDB database

rid string

A system generated property. A unique identifier.

ts number

A system generated property that denotes the last updated timestamp of the resource.

etag str

A system generated property representing the resource etag required for optimistic concurrency control.

id str

Name of the Cosmos DB MongoDB database

rid str

A system generated property. A unique identifier.

ts float

A system generated property that denotes the last updated timestamp of the resource.

etag String

A system generated property representing the resource etag required for optimistic concurrency control.

id String

Name of the Cosmos DB MongoDB database

rid String

A system generated property. A unique identifier.

ts Number

A system generated property that denotes the last updated timestamp of the resource.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0