azure-native.documentdb.MongoDBResourceMongoDBDatabase
Explore with Pulumi AI
An Azure Cosmos DB MongoDB database.
Uses Azure REST API version 2023-04-15. In version 1.x of the Azure Native provider, it used API version 2021-03-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.
Create MongoDBResourceMongoDBDatabase Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new MongoDBResourceMongoDBDatabase(name: string, args: MongoDBResourceMongoDBDatabaseArgs, opts?: CustomResourceOptions);
@overload
def MongoDBResourceMongoDBDatabase(resource_name: str,
args: MongoDBResourceMongoDBDatabaseArgs,
opts: Optional[ResourceOptions] = None)
@overload
def MongoDBResourceMongoDBDatabase(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_name: Optional[str] = None,
resource: Optional[MongoDBDatabaseResourceArgs] = None,
resource_group_name: Optional[str] = None,
database_name: Optional[str] = None,
location: Optional[str] = None,
options: Optional[CreateUpdateOptionsArgs] = None,
tags: Optional[Mapping[str, str]] = None)
func NewMongoDBResourceMongoDBDatabase(ctx *Context, name string, args MongoDBResourceMongoDBDatabaseArgs, opts ...ResourceOption) (*MongoDBResourceMongoDBDatabase, error)
public MongoDBResourceMongoDBDatabase(string name, MongoDBResourceMongoDBDatabaseArgs args, CustomResourceOptions? opts = null)
public MongoDBResourceMongoDBDatabase(String name, MongoDBResourceMongoDBDatabaseArgs args)
public MongoDBResourceMongoDBDatabase(String name, MongoDBResourceMongoDBDatabaseArgs args, CustomResourceOptions options)
type: azure-native:documentdb:MongoDBResourceMongoDBDatabase
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. MongoDBResourceMongoDBDatabaseArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. MongoDBResourceMongoDBDatabaseArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. MongoDBResourceMongoDBDatabaseArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. MongoDBResourceMongoDBDatabaseArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. MongoDBResourceMongoDBDatabaseArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var mongoDBResourceMongoDBDatabaseResource = new AzureNative.DocumentDB.MongoDBResourceMongoDBDatabase("mongoDBResourceMongoDBDatabaseResource", new()
{
AccountName = "string",
Resource = new AzureNative.DocumentDB.Inputs.MongoDBDatabaseResourceArgs
{
Id = "string",
},
ResourceGroupName = "string",
DatabaseName = "string",
Location = "string",
Options = new AzureNative.DocumentDB.Inputs.CreateUpdateOptionsArgs
{
AutoscaleSettings = new AzureNative.DocumentDB.Inputs.AutoscaleSettingsArgs
{
MaxThroughput = 0,
},
Throughput = 0,
},
Tags =
{
{ "string", "string" },
},
});
example, err := documentdb.NewMongoDBResourceMongoDBDatabase(ctx, "mongoDBResourceMongoDBDatabaseResource", &documentdb.MongoDBResourceMongoDBDatabaseArgs{
AccountName: pulumi.String("string"),
Resource: &documentdb.MongoDBDatabaseResourceArgs{
Id: pulumi.String("string"),
},
ResourceGroupName: pulumi.String("string"),
DatabaseName: pulumi.String("string"),
Location: pulumi.String("string"),
Options: &documentdb.CreateUpdateOptionsArgs{
AutoscaleSettings: &documentdb.AutoscaleSettingsArgs{
MaxThroughput: pulumi.Int(0),
},
Throughput: pulumi.Int(0),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var mongoDBResourceMongoDBDatabaseResource = new MongoDBResourceMongoDBDatabase("mongoDBResourceMongoDBDatabaseResource", MongoDBResourceMongoDBDatabaseArgs.builder()
.accountName("string")
.resource(MongoDBDatabaseResourceArgs.builder()
.id("string")
.build())
.resourceGroupName("string")
.databaseName("string")
.location("string")
.options(CreateUpdateOptionsArgs.builder()
.autoscaleSettings(AutoscaleSettingsArgs.builder()
.maxThroughput(0)
.build())
.throughput(0)
.build())
.tags(Map.of("string", "string"))
.build());
mongo_db_resource_mongo_db_database_resource = azure_native.documentdb.MongoDBResourceMongoDBDatabase("mongoDBResourceMongoDBDatabaseResource",
account_name="string",
resource={
"id": "string",
},
resource_group_name="string",
database_name="string",
location="string",
options={
"autoscale_settings": {
"max_throughput": 0,
},
"throughput": 0,
},
tags={
"string": "string",
})
const mongoDBResourceMongoDBDatabaseResource = new azure_native.documentdb.MongoDBResourceMongoDBDatabase("mongoDBResourceMongoDBDatabaseResource", {
accountName: "string",
resource: {
id: "string",
},
resourceGroupName: "string",
databaseName: "string",
location: "string",
options: {
autoscaleSettings: {
maxThroughput: 0,
},
throughput: 0,
},
tags: {
string: "string",
},
});
type: azure-native:documentdb:MongoDBResourceMongoDBDatabase
properties:
accountName: string
databaseName: string
location: string
options:
autoscaleSettings:
maxThroughput: 0
throughput: 0
resource:
id: string
resourceGroupName: string
tags:
string: string
MongoDBResourceMongoDBDatabase Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The MongoDBResourceMongoDBDatabase resource accepts the following input properties:
- Account
Name This property is required. Changes to this property will trigger replacement.
- Cosmos DB database account name.
- Resource
This property is required. Pulumi.Azure Native. Document DB. Inputs. Mongo DBDatabase Resource - The standard JSON format of a MongoDB database
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Database
Name Changes to this property will trigger replacement.
- Cosmos DB database name.
- Location string
- The location of the resource group to which the resource belongs.
- Options
Pulumi.
Azure Native. Document DB. Inputs. Create Update Options - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- 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".
- Account
Name This property is required. Changes to this property will trigger replacement.
- Cosmos DB database account name.
- Resource
This property is required. MongoDBDatabase Resource Args - The standard JSON format of a MongoDB database
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Database
Name Changes to this property will trigger replacement.
- Cosmos DB database name.
- Location string
- The location of the resource group to which the resource belongs.
- Options
Create
Update Options Args - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- 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".
- account
Name This property is required. Changes to this property will trigger replacement.
- Cosmos DB database account name.
- resource
This property is required. MongoDBDatabase Resource - The standard JSON format of a MongoDB database
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- database
Name Changes to this property will trigger replacement.
- Cosmos DB database name.
- location String
- The location of the resource group to which the resource belongs.
- options
Create
Update Options - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- 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".
- account
Name This property is required. Changes to this property will trigger replacement.
- Cosmos DB database account name.
- resource
This property is required. MongoDBDatabase Resource - The standard JSON format of a MongoDB database
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- database
Name Changes to this property will trigger replacement.
- Cosmos DB database name.
- location string
- The location of the resource group to which the resource belongs.
- options
Create
Update Options - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- {[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".
- account_
name This property is required. Changes to this property will trigger replacement.
- Cosmos DB database account name.
- resource
This property is required. MongoDBDatabase Resource Args - The standard JSON format of a MongoDB database
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- database_
name Changes to this property will trigger replacement.
- Cosmos DB database name.
- location str
- The location of the resource group to which the resource belongs.
- options
Create
Update Options Args - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- 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".
- account
Name This property is required. Changes to this property will trigger replacement.
- Cosmos DB database account name.
- resource
This property is required. Property Map - The standard JSON format of a MongoDB database
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- database
Name Changes to this property will trigger replacement.
- Cosmos DB database name.
- location String
- The location of the resource group to which the resource belongs.
- options Property Map
- A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- 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".
Outputs
All input properties are implicitly available as output properties. Additionally, the MongoDBResourceMongoDBDatabase resource produces the following output properties:
Supporting Types
AutoscaleSettings, AutoscaleSettingsArgs
- 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.
AutoscaleSettingsResponse, AutoscaleSettingsResponseArgs
- 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.
CreateUpdateOptions, CreateUpdateOptionsArgs
- Autoscale
Settings Pulumi.Azure Native. Document DB. Inputs. Autoscale Settings - Specifies the Autoscale settings.
- Throughput int
- Request Units per second. For example, "throughput": 10000.
- Autoscale
Settings AutoscaleSettings - Specifies the Autoscale settings.
- Throughput int
- Request Units per second. For example, "throughput": 10000.
- autoscale
Settings AutoscaleSettings - Specifies the Autoscale settings.
- throughput Integer
- Request Units per second. For example, "throughput": 10000.
- autoscale
Settings AutoscaleSettings - Specifies the Autoscale settings.
- throughput number
- Request Units per second. For example, "throughput": 10000.
- autoscale_
settings AutoscaleSettings - Specifies the Autoscale settings.
- throughput int
- Request Units per second. For example, "throughput": 10000.
- autoscale
Settings Property Map - Specifies the Autoscale settings.
- throughput Number
- Request Units per second. For example, "throughput": 10000.
MongoDBDatabaseGetPropertiesResponseOptions, MongoDBDatabaseGetPropertiesResponseOptionsArgs
- 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, MongoDBDatabaseGetPropertiesResponseResourceArgs
- 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 database
- 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.
- 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 database
- 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.
- 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 database
- 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.
- 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 database
- 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.
- 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 database
- 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.
- 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 database
- 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.
MongoDBDatabaseResource, MongoDBDatabaseResourceArgs
- Id
This property is required. string - Name of the Cosmos DB MongoDB database
- Id
This property is required. string - Name of the Cosmos DB MongoDB database
- id
This property is required. String - Name of the Cosmos DB MongoDB database
- id
This property is required. string - Name of the Cosmos DB MongoDB database
- id
This property is required. str - Name of the Cosmos DB MongoDB database
- id
This property is required. String - Name of the Cosmos DB MongoDB database
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:documentdb:MongoDBResourceMongoDBDatabase databaseName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0