Databáze Microsoft.DocumentDBAccounts/mongodbDatabases 2022-08-15-preview
- Latest (Nejnovější)
- 2023-04-15
- 2023-03-15
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 2021-01-15
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
Definice prostředku Bicep
Typ prostředku databaseAccounts/mongodbDatabases je možné nasadit s operacemi, které cílí na:
- Skupiny prostředků – viz příkazy pro nasazení skupin prostředků.
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/mongodbDatabases, přidejte do šablony následující bicep.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2022-08-15-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {}
}
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
createMode: 'string'
id: 'string'
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
}
}
}
}
Hodnoty vlastností
databaseAccounts/mongodbDatabases
| Název | Description | Hodnota |
|---|---|---|
| name | Název prostředku Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v nástroji Bicep. |
string (povinné) |
| location | Umístění skupiny prostředků, do které prostředek patří. | řetězec |
| tags | Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupení tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč, který nesmí být delší než 128 znaků a hodnota nesmí být větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastavené na defaultExperience: Cassandra. Aktuální hodnoty defaultExperience také zahrnují "Table", "Graph", "DocumentDB" a "MongoDB". | Slovník názvů a hodnot značek. Zobrazit značky v šablonách |
| Nadřazené | V nástroji Bicep můžete zadat nadřazený prostředek podřízeného prostředku. Tuto vlastnost stačí přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek. Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek. |
Symbolický název prostředku typu databaseAccounts |
| identity | Identita prostředku. | Identita spravované služby |
| properties | Vlastnosti pro vytvoření a aktualizaci databáze MongoDB služby Azure Cosmos DB | MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (povinné) |
Identita spravované služby
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ identity použitý pro prostředek. Typ SystemAssigned,UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity. | 'Žádný' 'SystemAssigned' 'SystemAssigned,UserAssigned' UserAssigned |
| userAssignedIdentity | Seznam identit uživatelů přidružených k prostředku. Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu//subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | object |
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...
| Název | Description | Hodnota |
|---|---|---|
| možnosti | Dvojice možností klíč-hodnota, které se použijí pro požadavek. To odpovídá hlavičkám odeslaným s požadavkem. | CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt... |
| prostředek | Standardní formát JSON databáze MongoDB | MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (povinné) |
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
| Název | Description | Hodnota |
|---|---|---|
| nastavení automatického škálování | Určuje nastavení automatického škálování. | Nastavení automatického škálování |
| throughput | Jednotky žádostí za sekundu. Například propustnost: 10000. | int |
Nastavení automatického škálování
| Název | Description | Hodnota |
|---|---|---|
| maxThroughput | Představuje maximální propustnost, na které se prostředek může vertikálně navýšit. | int |
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...
| Název | Description | Hodnota |
|---|---|---|
| createMode | Výčet označující režim vytváření prostředků. | 'Výchozí' Obnovit |
| id | Název databáze MongoDB Cosmos DB | string (povinné) |
| obnoveníParameters | Parametry označující informace o obnovení | ResourceRestoreParameters |
ResourceRestoreParameters
| Název | Description | Hodnota |
|---|---|---|
| obnovitzdroj | ID obnovitelného databázového účtu, ze kterého se má zahájit obnovení. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | řetězec |
| restoreTimestampInUtc | Čas, do kterého musí být účet obnoven (formát ISO-8601). | řetězec |
Šablony pro rychlý start
Následující šablony pro rychlý start nasadí tento typ prostředku.
| Template (Šablona) | Description |
|---|---|
Vytvoření účtu služby Azure Cosmos pro rozhraní MongoDB API |
Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní MongoDB API 4.2 ve dvou oblastech s využitím sdílené a vyhrazené propustnosti se dvěma kolekcemi. |
| Vytvoření účtu služby Azure Cosmos pro automatické škálování rozhraní MongoDB API |
Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní MongoDB API 4.2 ve dvou oblastech s využitím sdílené i vyhrazené propustnosti automatického škálování. |
Definice prostředku šablony ARM
Typ prostředku databaseAccounts/mongodbDatabases je možné nasadit s operacemi, které cílí na:
- Skupiny prostředků – viz příkazy pro nasazení skupin prostředků.
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/mongodbDatabases, přidejte do šablony následující kód JSON.
{
"type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases",
"apiVersion": "2022-08-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {}
},
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"createMode": "string",
"id": "string",
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string"
}
}
}
}
Hodnoty vlastností
databaseAccounts/mongodbDatabases
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ prostředku | Microsoft.DocumentDB/databaseAccounts/mongodbDatabases |
| apiVersion | Verze rozhraní API prostředku | 2022-08-15-preview |
| name | Název prostředku Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v šablonách JSON ARM. |
string (povinné) |
| location | Umístění skupiny prostředků, do které prostředek patří. | řetězec |
| tags | Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupení tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč, který nesmí být delší než 128 znaků a hodnota nesmí být větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastavené na defaultExperience: Cassandra. Aktuální hodnoty defaultExperience také zahrnují "Table", "Graph", "DocumentDB" a "MongoDB". | Slovník názvů a hodnot značek. Zobrazit značky v šablonách |
| identity | Identita prostředku. | Identita spravované služby |
| properties | Vlastnosti pro vytvoření a aktualizaci databáze MongoDB služby Azure Cosmos DB | MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (povinné) |
Identita spravované služby
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ identity použitý pro prostředek. Typ SystemAssigned,UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity. | 'Žádný' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| userAssignedIdentity | Seznam identit uživatelů přidružených k prostředku Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | object |
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...
| Název | Description | Hodnota |
|---|---|---|
| možnosti | Dvojice možností klíč-hodnota, které se mají použít pro požadavek. To odpovídá hlavičkám odeslaným s požadavkem. | CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt... |
| prostředek | Standardní formát JSON databáze MongoDB | MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (povinné) |
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
| Název | Description | Hodnota |
|---|---|---|
| automatické škálováníSettings | Určuje nastavení automatického škálování. | Automatické nastavení škálování |
| throughput | Jednotky žádostí za sekundu. Například propustnost: 10000. | int |
Automatické nastavení škálování
| Název | Description | Hodnota |
|---|---|---|
| maxThroughput | Představuje maximální propustnost, na které může prostředek vertikálně navýšit kapacitu. | int |
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...
| Název | Description | Hodnota |
|---|---|---|
| createMode | Výčet označující režim vytváření prostředků | Výchozí 'Obnovit' |
| id | Název databáze MongoDB služby Cosmos DB | string (povinné) |
| restoreParameters | Parametry označující informace o obnovení | ResourceRestoreParameters |
ResourceRestoreParameters
| Název | Description | Hodnota |
|---|---|---|
| restoreSource | ID obnovitelného databázového účtu, ze kterého se má zahájit obnovení. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | řetězec |
| restoreTimestampInUtc | Čas, do kterého musí být účet obnoven (formát ISO-8601). | řetězec |
Šablony pro rychlý start
Následující šablony rychlého startu nasadí tento typ prostředku.
| Template (Šablona) | Description |
|---|---|
| Vytvoření účtu služby Azure Cosmos pro rozhraní MongoDB API |
Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní MongoDB API 4.2 ve dvou oblastech s využitím sdílené a vyhrazené propustnosti se dvěma kolekcemi. |
| Vytvoření účtu služby Azure Cosmos pro automatické škálování rozhraní MongoDB API |
Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní MongoDB API 4.2 ve dvou oblastech s využitím sdílené i vyhrazené propustnosti automatického škálování. |
Definice prostředku Terraformu (zprostředkovatele AzAPI)
Typ prostředku databaseAccounts/mongodbDatabases je možné nasadit s operacemi, které cílí:
- Skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/mongodbDatabases, přidejte do šablony následující Terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2022-08-15-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
options = {
autoscaleSettings = {
maxThroughput = int
}
throughput = int
}
resource = {
createMode = "string"
id = "string"
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
}
}
}
})
}
Hodnoty vlastností
databaseAccounts/mongodbDatabases
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ prostředku | Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2022-08-15-preview |
| name | Název prostředku | string (povinné) |
| location | Umístění skupiny prostředků, do které prostředek patří. | řetězec |
| parent_id | ID prostředku, který je nadřazený pro tento prostředek. | ID prostředku typu : databaseAccounts |
| tags | Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupení tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč nejvýše 128 znaků a hodnotu nesmí být větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastavené na defaultExperience: "Cassandra". Aktuální hodnoty defaultExperience zahrnují také "Table", "Graph", "DocumentDB" a "MongoDB". | Slovník názvů značek a hodnot. |
| identity | Identita prostředku. | Identita spravované služby |
| properties | Vlastnosti pro vytvoření a aktualizaci databáze MongoDB služby Azure Cosmos DB | MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (povinné) |
Identita spravované služby
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ identity použitý pro prostředek. Typ SystemAssigned,UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity. | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| identity_ids | Seznam identit uživatelů přidružených k prostředku. Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu//subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | Pole ID identit uživatelů |
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...
| Název | Description | Hodnota |
|---|---|---|
| možnosti | Dvojice možností klíč-hodnota, které se použijí pro požadavek. To odpovídá hlavičkám odeslaným s požadavkem. | CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt... |
| prostředek | Standardní formát JSON databáze MongoDB | MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (povinné) |
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
| Název | Description | Hodnota |
|---|---|---|
| nastavení automatického škálování | Určuje nastavení automatického škálování. | Nastavení automatického škálování |
| throughput | Jednotky žádostí za sekundu. Například propustnost: 10000. | int |
Nastavení automatického škálování
| Název | Description | Hodnota |
|---|---|---|
| maxThroughput | Představuje maximální propustnost, na které se prostředek může vertikálně navýšit. | int |
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...
| Název | Description | Hodnota |
|---|---|---|
| createMode | Výčet označující režim vytváření prostředků. | "Výchozí" "Obnovit" |
| id | Název databáze MongoDB Cosmos DB | string (povinné) |
| obnoveníParameters | Parametry označující informace o obnovení | ResourceRestoreParameters |
ResourceRestoreParameters
| Název | Description | Hodnota |
|---|---|---|
| obnovitzdroj | ID obnovitelného databázového účtu, ze kterého se má zahájit obnovení. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | řetězec |
| restoreTimestampInUtc | Čas, do kterého musí být účet obnoven (formát ISO-8601). | řetězec |