azure-native.documentdb.getMongoDBResourceMongoDBDatabase
Explore with Pulumi AI
Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name. Azure REST API version: 2023-04-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.
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:
- Account
Name string - Cosmos DB database account name.
- Database
Name string - Cosmos DB database name.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Account
Name string - Cosmos DB database account name.
- Database
Name string - Cosmos DB database name.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- account
Name String - Cosmos DB database account name.
- database
Name String - Cosmos DB database name.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- account
Name string - Cosmos DB database account name.
- database
Name string - Cosmos DB database name.
- resource
Group stringName - 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_ strname - The name of the resource group. The name is case insensitive.
- account
Name String - Cosmos DB database account name.
- database
Name String - Cosmos DB database name.
- resource
Group StringName - 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.
Azure Native. Document DB. Outputs. Mongo DBDatabase Get Properties Response Options - Resource
Pulumi.
Azure Native. Document DB. Outputs. Mongo DBDatabase Get Properties Response Resource - 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
Mongo
DBDatabase Get Properties Response Options - Resource
Mongo
DBDatabase Get Properties Response Resource - 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
Mongo
DBDatabase Get Properties Response Options - resource
Mongo
DBDatabase Get Properties Response Resource - 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
Mongo
DBDatabase Get Properties Response Options - resource
Mongo
DBDatabase Get Properties Response Resource - {[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
Mongo
DBDatabase Get Properties Response Options - resource
Mongo
DBDatabase Get Properties Response Resource - 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
- 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
- Max
Throughput int - Represents maximum throughput, the resource can scale up to.
- Max
Throughput int - Represents maximum throughput, the resource can scale up to.
- max
Throughput Integer - Represents maximum throughput, the resource can scale up to.
- max
Throughput number - Represents maximum throughput, the resource can scale up to.
- max_
throughput int - Represents maximum throughput, the resource can scale up to.
- max
Throughput Number - Represents maximum throughput, the resource can scale up to.
MongoDBDatabaseGetPropertiesResponseOptions
- Autoscale
Settings Pulumi.Azure Native. Document DB. Inputs. Autoscale Settings Response - Specifies the Autoscale settings.
- Throughput int
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- Autoscale
Settings AutoscaleSettings Response - Specifies the Autoscale settings.
- Throughput int
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale
Settings AutoscaleSettings Response - Specifies the Autoscale settings.
- throughput Integer
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale
Settings AutoscaleSettings Response - 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 AutoscaleSettings Response - Specifies the Autoscale settings.
- throughput int
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale
Settings 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
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0