使用 Azure Policy 实现 Azure Cosmos DB 资源的治理和控制

项目
10/23/2024

适用对象： NoSQL MongoDB Cassandra Gremlin 表

Azure Policy 有助于强制实施组织治理标准、评估资源符合性并实现自动修复。常见的用例包括安全性、成本管理和配置一致性。

Azure Policy 提供内置策略定义。可以为内置策略定义未解决的方案创建自定义策略定义。有关更多详细信息，请参阅 Azure Policy 文档。

重要

Azure Policy 是在 Azure 服务的资源提供程序级别上强制实施的。 Azure Cosmos DB SDK 可以对数据库、容器和吞吐量资源执行大多数管理操作，这些操作会跳过 Azure Cosmos DB 的资源提供程序，从而会忽略使用 Azure Policy 创建的任何策略。

分配内置策略定义

策略定义描述了资源符合性条件以及在满足某个条件时所产生的效果。策略分配是根据策略定义创建的。可以对 Azure Cosmos DB 资源使用内置或自定义策略定义。策略分配的范围为 Azure 管理组、Azure 订阅或资源组，策略分配将应用于所选范围内的资源。或者，可以从所选范围中排除特定资源。

可以使用 Azure 门户、Azure PowerShell、Azure CLI 或 ARM 模板创建策略分配。

若要根据 Azure Cosmos DB 的内置策略定义创建策略分配，请使用使用 Azure 门户创建策略分配一文中的步骤。

在选择策略定义的步骤中，在“搜索”字段中输入 Azure Cosmos DB 来筛选可用的内置策略定义。选择一个可用的内置策略定义，然后选择“选择”继续创建策略分配。

提示

你还可以将“可用定义”格窗中显示的内置策略定义名称与 Azure PowerShell、Azure CLI 或 ARM 模板结合使用来创建策略分配。

搜索 Azure Cosmos DB 内置策略定义

创建自定义策略定义

对于内置策略未解决的特定方案，可以创建自定义策略定义。之后，根据自定义策略定义创建策略分配。

策略规则中的属性类型和属性别名

使用自定义策略定义步骤来标识创建策略规则所需的资源属性和属性别名。

若要确定特定于 Azure Cosmos DB 的属性别名，请将命名空间 Microsoft.DocumentDB 与“自定义策略定义步骤”一文中所述的其中一种方法结合使用。

使用 Azure CLI：

# Login first with az login if not using local Shell
az cloud set -n AzureChinaCloud
az login

# Get Azure Policy aliases for namespace Microsoft.DocumentDB
az provider show --namespace Microsoft.DocumentDB --expand "resourceTypes/aliases" --query "resourceTypes[].aliases[].name"

使用 Azure PowerShell：

# Login first with Connect-AzAccount -Environment AzureChinaCloud if not using local Shell
Connect-AzAccount -Environment AzureChinaCloud

# Use Get-AzPolicyAlias to list aliases for Microsoft.DocumentDB namespace
(Get-AzPolicyAlias -NamespaceMatch 'Microsoft.DocumentDB').Aliases

这些命令输出 Azure Cosmos DB 属性的属性别名列表。下面是输出的摘录：

[
  "Microsoft.DocumentDB/databaseAccounts/sku.name",
  "Microsoft.DocumentDB/databaseAccounts/virtualNetworkRules[*]",
  "Microsoft.DocumentDB/databaseAccounts/virtualNetworkRules[*].id",
  "Microsoft.DocumentDB/databaseAccounts/isVirtualNetworkFilterEnabled",
  "Microsoft.DocumentDB/databaseAccounts/consistencyPolicy.defaultConsistencyLevel",
  "Microsoft.DocumentDB/databaseAccounts/enableAutomaticFailover",
  "Microsoft.DocumentDB/databaseAccounts/Locations",
  "Microsoft.DocumentDB/databaseAccounts/Locations[*]",
  "Microsoft.DocumentDB/databaseAccounts/Locations[*].locationName",
  "..."
]

可以在自定义策略定义规则中使用这些属性别名中的任何一个。

下面是有关用于检查 Cosmos DB 帐户是否配置了多个写入位置的策略定义示例。自定义策略定义包括两个规则：一个用于检查属性别名的具体类型，另一个用于检查类型的具体属性，在本例中即存储多个写入位置设置的字段。这两个规则都使用别名。

"policyRule": {
  "if": {
    "allOf": [
      {
        "field": "type",
        "equals": "Microsoft.DocumentDB/databaseAccounts"
      },
      {
        "field": "Microsoft.DocumentDB/databaseAccounts/enableMultipleWriteLocations",
        "notEquals": true
      }
    ]
  },
  "then": {
    "effect": "Audit"
  }
}

同内置策略定义一样，自定义策略定义可用于创建策略分配。

策略符合性

创建策略分配后，Azure Policy 将评估分配范围内的资源。每个资源会接受策略符合性评估。策略中指定的效果会应用到不符合的资源。

你可以在 Azure 门户或通过 Azure CLI 或 Azure Monitor 日志查看符合性结果和修正详细信息。

以下屏幕截图显示了两个策略分配示例。

其中一个分配基于内置的策略定义，该定义检查 Azure Cosmos DB 资源是否仅部署到允许的 Azure 区域。资源合规性显示范围内资源的策略评估结果（合规或不合规）。

另一个分配基于自定义策略定义。此分配检查 Azure Cosmos DB 帐户是否配置了多个写入位置。

部署策略分配后，符合性仪表板将显示评估结果。请注意，部署策略分配后，可能需要 30 分钟才会显示评估结果。此外，创建策略分配后即可按需启动策略评估扫描。

此屏幕截图显示了范围内 Azure Cosmos DB 帐户的以下合规性评估结果：

两个帐户均不遵从必须配置虚拟网络 (VNet) 筛选的策略。
两个帐户均不遵从帐户需配置多个写入位置的策略
两个帐户均不遵从将资源部署到允许的 Azure 区域的策略。

列出的 Azure 策略分配的合规性结果

若要修正不合规的资源，请参阅如何使用 Azure Policy 修正资源。

后续步骤

查看 Azure Cosmos DB 的示例自定义策略定义，包括针对上述的多个写入位置和 VNet 筛选策略的内容。
在 Azure 门户中创建策略分配
查看 Azure Cosmos DB 的 Azure Policy 内置策略定义

通过