使用 Azure 资源管理器模板管理 Azure Cosmos DB MongoDB API 资源Manage Azure Cosmos DB MongoDB API resources using Azure Resource Manager templates

本文介绍如何使用 Azure 资源管理器模板来帮助部署和管理 Azure Cosmos DB for MongoDB API 帐户、数据库和集合。In this article, you learn how to use Azure Resource Manager templates to help deploy and manage your Azure Cosmos DB accounts for MongoDB API, databases, and collections.

本文仅提供 Azure Cosmos DB API for MongoDB 的示例,若要查找其他 API 类型帐户的示例,请参阅以下文章:将 Azure 资源管理器模板与适用于 CassandraGremlinSQL的 Azure Cosmos DB API 配合使用。This article has examples for Azure Cosmos DB's API for MongoDB only, to find examples for other API type accounts see: use Azure Resource Manager templates with Azure Cosmos DB's API for Cassandra, Gremlin, SQL, Table articles.

重要

  • 帐户名称限制为 44 个字符,全部小写。Account names are limited to 44 characters, all lowercase.
  • 若要更改吞吐量值,请用更新的 RU/s 重新部署模板。To change the throughput values, redeploy the template with updated RU/s.
  • 当你在 Azure Cosmos 帐户中添加或删除位置时,无法同时修改其他属性。When you add or remove locations to an Azure Cosmos account, you can't simultaneously modify other properties. 必须单独执行这些操作。These operations must be done separately.

若要创建以下任何 Azure Cosmos DB 资源,请将下列示例模板复制到新的 json 文件中。To create any of the Azure Cosmos DB resources below, copy the following example template into a new json file. 在部署具有不同名称和值的同一资源的多个实例时,可以选择创建要使用的参数 json 文件。You can optionally create a parameters json file to use when deploying multiple instances of the same resource with different names and values. 可以通过多种方式部署 Azure 资源管理器模板,包括 Azure 门户Azure CLIAzure PowerShellGitHubThere are many ways to deploy Azure Resource Manager templates including, Azure portal, Azure CLI, Azure PowerShell and GitHub.

预配了自动缩放吞吐量的 Azure Cosmos for MongoDB 帐户Azure Cosmos account for MongoDB with autoscale provisioned throughput

此模板将创建一个 Azure Cosmos for MongoDB API 帐户(3.2 或 3.6),其中包含两个在数据库级别共享自动缩放吞吐量的集合。This template will create an Azure Cosmos account for MongoDB API (3.2 or 3.6) with two collections that share autoscale throughput at the database level. 此模板还支持从 Azure 快速入门模板库进行一键部署。This template is also available for one-click deploy from Azure Quickstart Templates Gallery.

部署到 Azure Deploy to Azure

{
    "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
       "accountName": {
          "type": "string",
          "defaultValue": "[concat('mongodb-', uniqueString(resourceGroup().id))]",
          "metadata": {
             "description": "Cosmos DB account name"
          }
       },
       "location": {
          "type": "string",
          "defaultValue": "[resourceGroup().location]",
          "metadata": {
             "description": "Location for the Cosmos DB account."
          }
       },
       "primaryRegion":{
          "type":"string",
          "metadata": {
             "description": "The primary replica region for the Cosmos DB account."
          }
       },
       "secondaryRegion":{
          "type":"string",
          "metadata": {
            "description": "The secondary replica region for the Cosmos DB account."
         }
       },
       "serverVersion": {
          "defaultValue": "3.6",
          "allowedValues": [
             "3.2",
             "3.6"
          ],
          "type": "String",
          "metadata": {
             "description": "Specifies the MongoDB server version to use."
          }
       },
       "defaultConsistencyLevel": {
          "type": "string",
          "defaultValue": "Session",
          "allowedValues": [ 
               "Eventual", 
               "ConsistentPrefix", 
               "Session", 
               "BoundedStaleness", 
               "Strong" 
            ],
          "metadata": {
             "description": "The default consistency level of the Cosmos DB account."
          }
       },
       "maxStalenessPrefix": {
          "type": "int",
          "defaultValue": 100000,
          "minValue": 10,
          "maxValue": 2147483647,
          "metadata": {
             "description": "Max stale requests. Required for BoundedStaleness. Valid ranges, Single Region: 10 to 1000000. Multi Region: 100000 to 1000000."
          }
       },
       "maxIntervalInSeconds": {
          "type": "int",
          "defaultValue": 300,
          "minValue": 5,
          "maxValue": 86400,
          "metadata": {
             "description": "Max lag time (seconds). Required for BoundedStaleness. Valid ranges, Single Region: 5 to 84600. Multi Region: 300 to 86400."
          }
       },
       "databaseName": {
          "type": "string",
          "metadata": {
             "description": "The name for the Mongo DB database"
          }
       },
       "collection1Name": {
          "type": "string",
          "metadata": {
             "description": "The name for the first Mongo DB collection"
          }
       },
       "collection2Name": {
          "type": "string",
          "metadata": {
             "description": "The name for the second Mongo DB collection"
          }
       },
        "autoscaleMaxThroughput": {
            "type": "int",
            "defaultValue": 4000,
            "minValue": 4000,
            "maxValue": 1000000,
            "metadata": {
                "description": "Maximum throughput when using Autoscale Throughput Policy for the Database"
            }
        }
    },
    "variables": {
       "accountName": "[toLower(parameters('accountName'))]",
       "consistencyPolicy": {
          "Eventual": {
             "defaultConsistencyLevel": "Eventual"
          },
          "ConsistentPrefix": {
             "defaultConsistencyLevel": "ConsistentPrefix"
          },
          "Session": {
             "defaultConsistencyLevel": "Session"
          },
          "BoundedStaleness": {
             "defaultConsistencyLevel": "BoundedStaleness",
             "maxStalenessPrefix": "[parameters('maxStalenessPrefix')]",
             "maxIntervalInSeconds": "[parameters('maxIntervalInSeconds')]"
          },
          "Strong": {
             "defaultConsistencyLevel": "Strong"
          }
       },
       "locations": [
          {
             "locationName": "[parameters('primaryRegion')]",
             "failoverPriority": 0,
             "isZoneRedundant": false
          },
          {
             "locationName": "[parameters('secondaryRegion')]",
             "failoverPriority": 1,
             "isZoneRedundant": false
          }
       ]
    },
    "resources": [
         {
          "type": "Microsoft.DocumentDB/databaseAccounts",
          "name": "[variables('accountName')]",
          "apiVersion": "2020-04-01",
          "location": "[parameters('location')]",
          "kind": "MongoDB",
          "properties": {
             "consistencyPolicy": "[variables('consistencyPolicy')[parameters('defaultConsistencyLevel')]]",
             "locations": "[variables('locations')]",
             "databaseAccountOfferType": "Standard",
             "apiProperties": {
                "serverVersion": "[parameters('serverVersion')]"
             }
          }
       },
       {
          "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases",
          "name": "[concat(variables('accountName'), '/', parameters('databaseName'))]",
          "apiVersion": "2020-04-01",
          "dependsOn": [ 
             "[resourceId('Microsoft.DocumentDB/databaseAccounts/', variables('accountName'))]" 
            ],
          "properties":{
             "resource":{
                "id": "[parameters('databaseName')]"
             },
             "options": {
                  "autoscaleSettings": { 
                     "maxThroughput": "[parameters('autoscaleMaxThroughput')]" 
                  }
               }
            }
       },
       {
          "type": "Microsoft.DocumentDb/databaseAccounts/mongodbDatabases/collections",
          "name": "[concat(variables('accountName'), '/', parameters('databaseName'), '/', parameters('collection1Name'))]",
          "apiVersion": "2020-04-01",
          "dependsOn": [ 
             "[resourceId('Microsoft.DocumentDB/databaseAccounts/mongodbDatabases', variables('accountName'), parameters('databaseName'))]" 
            ],
          "properties":
          {
             "resource":{
                "id":  "[parameters('collection1Name')]",
                "shardKey": { 
                   "user_id": "Hash" 
                  },
                "indexes": [
                   {
                      "key": { 
                         "keys":["user_id", "user_address"] 
                        },
                      "options": { 
                         "unique": "true" 
                        }
                   },
                   {
                      "key": { 
                         "keys":["_ts"] 
                         },
                      "options": { 
                         "expireAfterSeconds": "2629746" 
                        }
                   }
                ],
                "options": {
                   "If-Match": "<ETag>"
                }
             }
          }
       },
       {
          "type": "Microsoft.DocumentDb/databaseAccounts/mongodbDatabases/collections",
          "name": "[concat(variables('accountName'), '/', parameters('databaseName'), '/', parameters('collection2Name'))]",
          "apiVersion": "2020-04-01",
          "dependsOn": [ 
             "[resourceId('Microsoft.DocumentDB/databaseAccounts/mongodbDatabases', variables('accountName'),  parameters('databaseName'))]" 
            ],
          "properties":
          {
             "resource":{
                "id":  "[parameters('collection2Name')]",
                "shardKey": { 
                   "company_id": "Hash" 
                  },
                "indexes": [
                   {
                      "key": { 
                         "keys":[
                            "company_id", 
                            "company_address"
                           ] 
                        },
                      "options": { 
                         "unique": "true" 
                        }
                   },
                   {
                      "key": { 
                         "keys":["_ts"] 
                        },
                      "options": { 
                         "expireAfterSeconds": "2629746" 
                        }
                   }
                ],
                "options": {
                   "If-Match": "<ETag>"
                }
             }
          }
       }
    ]
 }

预配了标准吞吐量的 Azure Cosmos for MongoDB 帐户Azure Cosmos account for MongoDB with standard provisioned throughput

此模板将创建一个 Azure Cosmos for MongoDB API 帐户(3.2 或 3.6),其中包含两个在数据库级别共享 400 RU/s 标准(手动)吞吐量的集合。This template will create an Azure Cosmos account for MongoDB API (3.2 or 3.6) with two collections that share 400 RU/s standard (manual) throughput at the database level. 此模板还支持从 Azure 快速入门模板库进行一键部署。This template is also available for one-click deploy from Azure Quickstart Templates Gallery.

部署到 Azure Deploy to Azure

{
    "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "accountName": {
            "type": "string",
            "defaultValue": "[concat('mongodb-', uniqueString(resourceGroup().id))]",
            "metadata": {
                "description": "Cosmos DB account name"
            }
        },
        "location": {
            "type": "string",
            "defaultValue": "[resourceGroup().location]",
            "metadata": {
                "description": "Location for the Cosmos DB account."
            }
        },
        "primaryRegion":{
            "type":"string",
            "metadata": {
                "description": "The primary replica region for the Cosmos DB account."
            }
        },
        "secondaryRegion":{
            "type":"string",
            "metadata": {
              "description": "The secondary replica region for the Cosmos DB account."
          }
        },
        "defaultConsistencyLevel": {
            "type": "string",
            "defaultValue": "Session",
            "allowedValues": [ "Eventual", "ConsistentPrefix", "Session", "BoundedStaleness", "Strong" ],
            "metadata": {
                "description": "The default consistency level of the Cosmos DB account."
            }
        },
        "serverVersion": {
            "defaultValue": "3.6",
            "allowedValues": [
                "3.2",
                "3.6"
            ],
            "type": "String",
            "metadata": {
                "description": "Specifies the MongoDB server version to use."
            }
        },
        "maxStalenessPrefix": {
            "type": "int",
            "defaultValue": 100000,
            "minValue": 10,
            "maxValue": 2147483647,
            "metadata": {
                "description": "Max stale requests. Required for BoundedStaleness. Valid ranges, Single Region: 10 to 1000000. Multi Region: 100000 to 1000000."
            }
        },
        "maxIntervalInSeconds": {
            "type": "int",
            "defaultValue": 300,
            "minValue": 5,
            "maxValue": 86400,
            "metadata": {
                "description": "Max lag time (seconds). Required for BoundedStaleness. Valid ranges, Single Region: 5 to 84600. Multi Region: 300 to 86400."
            }
        },
        "databaseName": {
            "type": "string",
            "metadata": {
                "description": "The name for the Mongo DB database"
            }
        },
        "throughput": {
            "type": "int",
            "defaultValue": 400,
            "minValue": 400,
            "maxValue": 1000000,
            "metadata": {
                "description": "The shared throughput for the Mongo DB database"
            }           
        },
        "collection1Name": {
            "type": "string",
            "metadata": {
                "description": "The name for the first Mongo DB collection"
            }
        },
        "collection2Name": {
            "type": "string",
            "metadata": {
                "description": "The name for the second Mongo DB collection"
            }
        }
    },
    "variables": {
        "accountName": "[toLower(parameters('accountName'))]",
        "consistencyPolicy": {
            "Eventual": {
                "defaultConsistencyLevel": "Eventual"
            },
            "ConsistentPrefix": {
                "defaultConsistencyLevel": "ConsistentPrefix"
            },
            "Session": {
                "defaultConsistencyLevel": "Session"
            },
            "BoundedStaleness": {
                "defaultConsistencyLevel": "BoundedStaleness",
                "maxStalenessPrefix": "[parameters('maxStalenessPrefix')]",
                "maxIntervalInSeconds": "[parameters('maxIntervalInSeconds')]"
            },
            "Strong": {
                "defaultConsistencyLevel": "Strong"
            }
        },
        "locations": 
        [ 
            {
                "locationName": "[parameters('primaryRegion')]",
                "failoverPriority": 0,
                "isZoneRedundant": false
            }, 
            {
                "locationName": "[parameters('secondaryRegion')]",
                "failoverPriority": 1,
                "isZoneRedundant": false
            }
        ]
    },
    "resources": 
    [
        {
            "type": "Microsoft.DocumentDB/databaseAccounts",
            "name": "[variables('accountName')]",
            "apiVersion": "2020-03-01",
            "location": "[parameters('location')]",
            "kind": "MongoDB",
            "properties": {
                "consistencyPolicy": "[variables('consistencyPolicy')[parameters('defaultConsistencyLevel')]]",
                "locations": "[variables('locations')]",
                "databaseAccountOfferType": "Standard",
                "apiProperties": {
                    "serverVersion": "[parameters('serverVersion')]"
                }
            }
        },
        {
            "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases",
            "name": "[concat(variables('accountName'), '/', parameters('databaseName'))]",
            "apiVersion": "2020-03-01",
            "dependsOn": [ "[resourceId('Microsoft.DocumentDB/databaseAccounts/', variables('accountName'))]" ],
            "properties":{
                "resource":{
                    "id": "[parameters('databaseName')]"
                },
                "options": { "throughput": "[parameters('throughput')]" }
            }
        },
        {
            "type": "Microsoft.DocumentDb/databaseAccounts/mongodbDatabases/collections",
            "name": "[concat(variables('accountName'), '/', parameters('databaseName'), '/', parameters('collection1Name'))]",
            "apiVersion": "2020-03-01",
            "dependsOn": [ "[resourceId('Microsoft.DocumentDB/databaseAccounts/mongodbDatabases', variables('accountName'), parameters('databaseName'))]" ],
            "properties":
            {
                "resource":{
                    "id":  "[parameters('collection1Name')]",
                    "shardKey": { "user_id": "Hash" },
                    "indexes": [
                        {
                            "key": { "keys":["user_id", "user_address"] },
                            "options": { "unique": "true" }
                        },
                        {
                            "key": { "keys":["_ts"] },
                            "options": { "expireAfterSeconds": "2629746" }
                        }
                    ],
                    "options": {
                        "If-Match": "<ETag>"
                    }
                }
            }
        },
        {
            "type": "Microsoft.DocumentDb/databaseAccounts/mongodbDatabases/collections",
            "name": "[concat(variables('accountName'), '/', parameters('databaseName'), '/', parameters('collection2Name'))]",
            "apiVersion": "2020-03-01",
            "dependsOn": [ "[resourceId('Microsoft.DocumentDB/databaseAccounts/mongodbDatabases', variables('accountName'),  parameters('databaseName'))]" ],
            "properties":
            {
                "resource":{
                    "id":  "[parameters('collection2Name')]",
                    "shardKey": { "company_id": "Hash" },
                    "indexes": [
                        {
                            "key": { "keys":["company_id", "company_address"] },
                            "options": { "unique": "true" }
                        },
                        {
                            "key": { "keys":["_ts"] },
                            "options": { "expireAfterSeconds": "2629746" }
                        }
                    ],
                    "options": {
                        "If-Match": "<ETag>"
                    }
                }
            }
        }
    ]
}

后续步骤Next steps

下面是一些其他资源:Here are some additional resources: