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

在本文中,你将了解如何使用 Azure 资源管理器模板来帮助部署和管理 Azure Cosmos DB 帐户、密钥空间和表。In this article, you learn how to use Azure Resource Manager templates to help deploy and manage your Azure Cosmos DB accounts, keyspaces, and tables.

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

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

此模板在两个区域创建一个 Azure Cosmos 帐户,其中包含用于一致性和故障转移的选项,以及为自动缩放吞吐量配置的密钥空间和表。This template creates an Azure Cosmos account in two regions with options for consistency and failover, with a keyspace and table configured for autoscale throughput. 此模板还支持从 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('cassandra-', uniqueString(resourceGroup().id))]",
         "metadata": {
            "description": "Cosmos DB account name, max length 44 characters"
         }
      },
      "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."
         }
      },
      "maxStalenessPrefix": {
         "type": "int",
         "defaultValue": 100000,
         "minValue": 10,
         "maxValue": 1000000,
         "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."
         }
      },
      "automaticFailover": {
         "type": "bool",
         "defaultValue": true,
         "allowedValues": [
            true,
            false
         ],
         "metadata": {
            "description": "Enable automatic failover for regions"
         }
      },
      "keyspaceName": {
         "type": "string",
         "metadata": {
            "description": "The name for the Cassandra Keyspace"
         }
      },
      "tableName": {
         "type": "string",
         "metadata": {
            "description": "The name for the Cassandra table"
         }
      },
      "autoscaleMaxThroughput": {
         "type": "int",
         "defaultValue": 4000,
         "minValue": 4000,
         "maxValue": 1000000,
         "metadata": {
            "description": "Maximum autoscale throughput for the Cassandra table"
         }
      }
   },
   "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": "GlobalDocumentDB",
         "properties": {
            "capabilities": [ { "name": "EnableCassandra" } ],
            "consistencyPolicy": "[variables('consistencyPolicy')[parameters('defaultConsistencyLevel')]]",
            "locations": "[variables('locations')]",
            "databaseAccountOfferType": "Standard",
            "enableAutomaticFailover": "[parameters('automaticFailover')]"
         }
      },
      {
         "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces",
         "name": "[concat(variables('accountName'), '/', parameters('keyspaceName'))]",
         "apiVersion": "2020-04-01",
         "dependsOn": [
            "[resourceId('Microsoft.DocumentDB/databaseAccounts/', variables('accountName'))]"
         ],
         "properties": {
            "resource": {
               "id": "[parameters('keyspaceName')]"
            }
         }
      },
      {
         "type": "Microsoft.DocumentDb/databaseAccounts/cassandraKeyspaces/tables",
         "name": "[concat(variables('accountName'), '/', parameters('keyspaceName'), '/', parameters('tableName'))]",
         "apiVersion": "2020-04-01",
         "dependsOn": [
            "[resourceId('Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces', variables('accountName'), parameters('keyspaceName'))]"
         ],
         "properties": {
            "resource": {
               "id": "[parameters('tableName')]",
               "schema": {
                  "columns": [
                     {
                        "name": "loadid",
                        "type": "uuid"
                     },
                     {
                        "name": "machine",
                        "type": "uuid"
                     },
                     {
                        "name": "cpu",
                        "type": "int"
                     },
                     {
                        "name": "mtime",
                        "type": "int"
                     },
                     {
                        "name": "load",
                        "type": "float"
                     }
                  ],
                  "partitionKeys": [
                     { "name": "machine" },
                     { "name": "cpu" },
                     { "name": "mtime" }
                  ],
                  "clusterKeys": [
                     {
                        "name": "loadid",
                        "orderBy": "asc"
                     }
                  ]
               }
            },
            "options": {
               "autoscaleSettings": { 
                  "maxThroughput": "[parameters('autoscaleMaxThroughput')]" 
               }
            }
         }
      }
   ]
}

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

此模板在两个区域创建一个 Azure Cosmos 帐户,其中包含用于一致性和故障转移的选项,以及为标准吞吐量配置的密钥空间和表。This template creates an Azure Cosmos account in two regions with options for consistency and failover, with a keyspace and table configured for standard throughput. 此模板还支持从 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('sql-', uniqueString(resourceGroup().id))]",
            "metadata": {
                "description": "Cosmos DB account name, max length 44 characters"
            }
        },
        "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."
            }
        },
        "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."
            }
        },
        "automaticFailover": {
            "type": "bool",
            "defaultValue": true,
            "allowedValues": [ true, false ],
            "metadata": {
                "description": "Enable automatic failover for regions"
            }
        },
        "keyspaceName": {
            "type": "string",
            "metadata": {
                "description": "The name for the Cassandra Keyspace"
            }
        },
        "tableName": {
            "type": "string",
            "metadata": {
                "description": "The name for the first Cassandra table"
            }
        },
        "throughput": {
            "type": "int",
            "defaultValue": 400,
            "minValue": 400,
            "maxValue": 1000000,
            "metadata": {
                "description": "The throughput for both Cassandra tables"
            }       
        }
    },
    "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": "GlobalDocumentDB",
            "properties": {
                "capabilities": [{ "name": "EnableCassandra" }],
                "consistencyPolicy": "[variables('consistencyPolicy')[parameters('defaultConsistencyLevel')]]",
                "locations": "[variables('locations')]",
                "databaseAccountOfferType": "Standard",
                "enableAutomaticFailover": "[parameters('automaticFailover')]"
            }
        },
        {
            "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces",
            "name": "[concat(variables('accountName'), '/', parameters('keyspaceName'))]",
            "apiVersion": "2020-03-01",
            "dependsOn": [ "[resourceId('Microsoft.DocumentDB/databaseAccounts/', variables('accountName'))]" ],
            "properties":{
                "resource":{
                    "id": "[parameters('keyspaceName')]"
                }
            }
        },
        {
            "type": "Microsoft.DocumentDb/databaseAccounts/cassandraKeyspaces/tables",
            "name": "[concat(variables('accountName'), '/', parameters('keyspaceName'), '/', parameters('tableName'))]",
            "apiVersion": "2020-03-01",
            "dependsOn": [ "[resourceId('Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces', variables('accountName'), parameters('keyspaceName'))]" ],
            "properties":
            {
                "resource":{
                    "id":  "[parameters('tableName')]",
                    "schema": {
                        "columns": [
                            { "name": "loadid", "type": "uuid" },
                            { "name": "machine", "type": "uuid" },
                            { "name": "cpu", "type": "int" },
                            { "name": "mtime", "type": "int" },
                            { "name": "load", "type": "float" }
                        ],
                        "partitionKeys": [ 
                            { "name": "machine" }, 
                            { "name": "cpu" }, 
                            { "name": "mtime" } 
                        ],
                        "clusterKeys": [ 
                            { "name": "loadid", "orderBy": "asc" } 
                        ]
                    },
                    "options": { "throughput": "[parameters('throughput')]" }
                }
            }
        }
    ]
}

后续步骤Next steps

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