Microsoft.DocumentDB 資料庫Accounts 2024-05-15

Bicep 資源定義

databaseAccounts 資源類型可以使用目標作業來部署：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2024-05-15' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    analyticalStorageConfiguration: {
      schemaType: 'string'
    }
    apiProperties: {
      serverVersion: 'string'
    }
    backupPolicy: {
      migrationState: {
        startTime: 'string'
        status: 'string'
        targetType: 'string'
      }
      type: 'string'
      // For remaining properties, see BackupPolicy objects
    }
    capabilities: [
      {
        name: 'string'
      }
    ]
    capacity: {
      totalThroughputLimit: int
    }
    connectorOffer: 'string'
    consistencyPolicy: {
      defaultConsistencyLevel: 'string'
      maxIntervalInSeconds: int
      maxStalenessPrefix: int
    }
    cors: [
      {
        allowedHeaders: 'string'
        allowedMethods: 'string'
        allowedOrigins: 'string'
        exposedHeaders: 'string'
        maxAgeInSeconds: int
      }
    ]
    createMode: 'string'
    customerManagedKeyStatus: 'string'
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'string'
    disableKeyBasedMetadataWriteAccess: bool
    disableLocalAuth: bool
    enableAnalyticalStorage: bool
    enableAutomaticFailover: bool
    enableBurstCapacity: bool
    enableCassandraConnector: bool
    enableFreeTier: bool
    enableMultipleWriteLocations: bool
    enablePartitionMerge: bool
    ipRules: [
      {
        ipAddressOrRange: 'string'
      }
    ]
    isVirtualNetworkFilterEnabled: bool
    keyVaultKeyUri: 'string'
    locations: [
      {
        failoverPriority: int
        isZoneRedundant: bool
        locationName: 'string'
      }
    ]
    minimalTlsVersion: 'string'
    networkAclBypass: 'string'
    networkAclBypassResourceIds: [
      'string'
    ]
    publicNetworkAccess: 'string'
    restoreParameters: {
      databasesToRestore: [
        {
          collectionNames: [
            'string'
          ]
          databaseName: 'string'
        }
      ]
      gremlinDatabasesToRestore: [
        {
          databaseName: 'string'
          graphNames: [
            'string'
          ]
        }
      ]
      restoreMode: 'string'
      restoreSource: 'string'
      restoreTimestampInUtc: 'string'
      tablesToRestore: [
        'string'
      ]
    }
    virtualNetworkRules: [
      {
        id: 'string'
        ignoreMissingVNetServiceEndpoint: bool
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

BackupPolicy 物件

設定 類型 屬性，以指定物件的類型。

針對 連續，請使用：

{
  continuousModeProperties: {
    tier: 'string'
  }
  type: 'Continuous'
}

針對 定期，請使用：

{
  periodicModeProperties: {
    backupIntervalInMinutes: int
    backupRetentionIntervalInHours: int
    backupStorageRedundancy: 'string'
  }
  type: 'Periodic'
}

屬性值

分析StorageConfiguration

ApiProperties

BackupPolicy

BackupPolicyMigrationState

能力

能力

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ConsistencyPolicy

ContinuousModeBackupPolicy

ContinuousModeProperties

CorsPolicy

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

DatabaseRestoreResource

GremlinDatabaseRestoreResource

IpAddressOrRange

位置

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts

PeriodicModeBackupPolicy

PeriodicModeProperties

RestoreParameters

標籤

VirtualNetworkRule

快速入門範例

下列快速入門範例會部署此資源類型。

ARM 樣本資源定義

databaseAccounts 資源類型可以使用目標作業來部署：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "apiVersion": "2024-05-15",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "analyticalStorageConfiguration": {
      "schemaType": "string"
    },
    "apiProperties": {
      "serverVersion": "string"
    },
    "backupPolicy": {
      "migrationState": {
        "startTime": "string",
        "status": "string",
        "targetType": "string"
      },
      "type": "string"
      // For remaining properties, see BackupPolicy objects
    },
    "capabilities": [
      {
        "name": "string"
      }
    ],
    "capacity": {
      "totalThroughputLimit": "int"
    },
    "connectorOffer": "string",
    "consistencyPolicy": {
      "defaultConsistencyLevel": "string",
      "maxIntervalInSeconds": "int",
      "maxStalenessPrefix": "int"
    },
    "cors": [
      {
        "allowedHeaders": "string",
        "allowedMethods": "string",
        "allowedOrigins": "string",
        "exposedHeaders": "string",
        "maxAgeInSeconds": "int"
      }
    ],
    "createMode": "string",
    "customerManagedKeyStatus": "string",
    "databaseAccountOfferType": "Standard",
    "defaultIdentity": "string",
    "disableKeyBasedMetadataWriteAccess": "bool",
    "disableLocalAuth": "bool",
    "enableAnalyticalStorage": "bool",
    "enableAutomaticFailover": "bool",
    "enableBurstCapacity": "bool",
    "enableCassandraConnector": "bool",
    "enableFreeTier": "bool",
    "enableMultipleWriteLocations": "bool",
    "enablePartitionMerge": "bool",
    "ipRules": [
      {
        "ipAddressOrRange": "string"
      }
    ],
    "isVirtualNetworkFilterEnabled": "bool",
    "keyVaultKeyUri": "string",
    "locations": [
      {
        "failoverPriority": "int",
        "isZoneRedundant": "bool",
        "locationName": "string"
      }
    ],
    "minimalTlsVersion": "string",
    "networkAclBypass": "string",
    "networkAclBypassResourceIds": [ "string" ],
    "publicNetworkAccess": "string",
    "restoreParameters": {
      "databasesToRestore": [
        {
          "collectionNames": [ "string" ],
          "databaseName": "string"
        }
      ],
      "gremlinDatabasesToRestore": [
        {
          "databaseName": "string",
          "graphNames": [ "string" ]
        }
      ],
      "restoreMode": "string",
      "restoreSource": "string",
      "restoreTimestampInUtc": "string",
      "tablesToRestore": [ "string" ]
    },
    "virtualNetworkRules": [
      {
        "id": "string",
        "ignoreMissingVNetServiceEndpoint": "bool"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

BackupPolicy 物件

設定 類型 屬性，以指定物件的類型。

針對 連續，請使用：

{
  "continuousModeProperties": {
    "tier": "string"
  },
  "type": "Continuous"
}

針對 定期，請使用：

{
  "periodicModeProperties": {
    "backupIntervalInMinutes": "int",
    "backupRetentionIntervalInHours": "int",
    "backupStorageRedundancy": "string"
  },
  "type": "Periodic"
}

屬性值

分析StorageConfiguration

ApiProperties

BackupPolicy

BackupPolicyMigrationState

能力

能力

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ConsistencyPolicy

ContinuousModeBackupPolicy

ContinuousModeProperties

CorsPolicy

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

DatabaseRestoreResource

GremlinDatabaseRestoreResource

IpAddressOrRange

位置

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts

PeriodicModeBackupPolicy

PeriodicModeProperties

RestoreParameters

標籤

VirtualNetworkRule

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
使用分析存放區 Azure Cosmos DB 帳戶 SQL API	此範本會建立適用於 Core （SQL） API 的 Azure Cosmos 帳戶，其中包含使用分析存放區設定的資料庫和容器。
使用 Web 應用程式 Azure Cosmos DB 帳戶	此範本會部署 Azure Cosmos DB 帳戶、App Service 方案，並在 App Service 方案中建立 Web 應用程式。 它也會將兩個應用程式設定新增至參考 Azure Cosmos DB 帳戶端點的 Web 應用程式。 如此一來，部署至 Web 應用程式的解決方案就可以使用這些設定連線到 Azure Cosmos DB 帳戶端點。
在 Azure Container Service 上使用 Jenkins CI/CD	容器可讓您輕鬆地持續建置和部署應用程式。 藉由在 Azure Container Service 中使用 Kubernetes 協調這些容器的部署，您可以達成可複製且可管理的容器叢集。 藉由設定持續組建來產生容器映像和協調流程，您可以提高部署的速度和可靠性。
建立已啟用 Microsoft Defender 的 Cosmos DB 帳戶	使用此 ARM 範本，您可以部署已啟用 Azure Cosmos DB Microsoft Defender 的 Azure Cosmos DB 帳戶。 Microsoft適用於 Azure Cosmos DB 的 Defender 是 Azure 原生安全性層，可偵測嘗試利用 Azure Cosmos DB 帳戶中的資料庫。 Microsoft適用於 Azure Cosmos DB 的 Defender 會根據 Microsoft威脅情報、可疑存取模式，以及透過遭入侵的身分識別或惡意測試人員，偵測潛在的 SQL 插入、已知不良動作專案，以及資料庫的潛在惡意探索。
建立免費層 Azure Cosmos DB 帳戶	此範本會使用具有共用輸送量和容器的資料庫，為 SQL API 建立免費層 Azure Cosmos DB 帳戶。
為 Core （SQL） API 建立最少的 Azure Cosmos DB 帳戶	此範本會為 Core （SQL） API 建立 Azure Cosmos DB 帳戶，同時只指定最少的必要資源屬性。
為 SQL API 建立無伺服器 Azure Cosmos DB 帳戶	此範本會為 Core （SQL） API 建立無伺服器 Azure Cosmos DB 帳戶。
建立零觸控 Azure Cosmos 帳戶和 Azure Web 應用程式	此範本會建立 Azure Cosmos 帳戶、將 Cosmos DB 端點和金鑰插入 Azure Web 應用程式設定，然後從 GitHub 部署 ASP MVC Web 應用程式。
建立適用於 MongoDB API 的 Azure Cosmos 帳戶	此範本會在兩個區域中建立適用於 MongoDB API 4.2 的 Azure Cosmos DB 帳戶，並使用具有兩個集合的共用和專用輸送量。
建立適用於 MongoDB API 的 Azure Cosmos 帳戶自動調整	此範本會使用共用和專用的自動調整輸送量，在兩個區域中建立 MongoDB API 4.2 的 Azure Cosmos DB 帳戶。
為數據表 API 建立 Azure Cosmos 帳戶	此範本會在兩個區域中建立適用於數據表 API 的 Azure Cosmos DB 帳戶，以及具有布建輸送量的單一數據表。
使用自動調整 建立數據表 API 的 Azure Cosmos 帳戶	此範本會在兩個區域中建立適用於數據表 API 的 Azure Cosmos DB 帳戶，以及具有自動調整輸送量的單一數據表。
為 Cassandra API 建立 Azure Cosmos DB 帳戶	此範本會在兩個區域中建立 Cassandra API 的 Azure Cosmos DB 帳戶，其中具有密鑰空間和具有專用輸送量的數據表。
建立適用於 Core （SQL） API 的 Azure Cosmos DB 帳戶	此範本會使用具有多個其他選項的資料庫和容器，建立適用於 Core （SQL） API 的 Azure Cosmos 帳戶。
為 Gremlin API 建立 Azure Cosmos DB 帳戶	此範本會在兩個區域中建立適用於 Gremlin API 的 Azure Cosmos DB 帳戶，其中一個資料庫和一個圖表使用專用輸送量。
為 Gremlin API 自動調整 建立 Azure Cosmos DB 帳戶	此範本會使用自動調整輸送量，在兩個區域中建立 Gremlin API 的 Azure Cosmos DB 帳戶，其中一個資料庫和一個圖形。
在多個區域中建立 Azure Cosmos DB 帳戶	此範本會針對具有主要和次要區域且選擇一致性層級和故障轉移類型的任何資料庫 API 類型，建立 Azure Cosmos DB 帳戶。
使用自動調整 建立 Azure Cosmos DB 帳戶 SQL API	此範本會建立適用於 Core （SQL） API 的 Azure Cosmos 帳戶，其中包含具有多個其他選項之自動調整輸送量的資料庫和容器。
使用私人端點建立 Azure Cosmos DB 帳戶	此範本會建立 Cosmos 帳戶、虛擬網路和私人端點，以將 Cosmos 帳戶公開至虛擬網路。
使用數據平面 RBAC 建立 Azure Cosmos DB SQL 帳戶	此範本會建立 SQL Cosmos 帳戶、原生維護的角色定義，以及 AAD 身分識別的原生維護角色指派。
建立 Azure CosmosDB 帳戶	此 ARM 範本旨在以最少的必要值快速建立 CosmosDB 帳戶
為 Cassandra API 建立自動調整 Azure Cosmos DB 帳戶	此範本會在兩個區域中建立 Cassandra API 的 Azure Cosmos DB 帳戶，其中具有索引鍵空間和具有自動調整輸送量的數據表。
建立 Azure Cosmos DB Core （SQL） API 預存程式	此範本會建立適用於 Core （SQL） API 的 Azure Cosmos DB 帳戶，以及具有預存程式、觸發程式和使用者定義函式的容器。
使用 SQL API 和多個容器建立 Azure Cosmos	此範本會使用 SQL API 建立 Cosmos 容器，並允許新增多函式容器。
使用 Container Apps 建立 Dapr 微服務應用程式	使用 Container Apps 建立 Dapr 微服務應用程式。
使用 Container Apps 建立 Dapr pub-sub servicebus 應用程式	使用 Container Apps 建立 Dapr pub-sub servicebus 應用程式。
使用 Cosmos DB 連線部署 Azure 數據總管 DB	使用 Cosmos DB 連線部署 Azure 數據總管 DB。
使用 SQL Database、Azure Cosmos DB、Azure 搜尋服務 Web 應用程式	此範本會布建 Web 應用程式、SQL Database、Azure Cosmos DB、Azure 搜尋服務和 Application Insights。

Terraform （AzAPI 提供者） 資源定義

databaseAccounts 資源類型可以使用目標作業來部署：

• 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts@2024-05-15"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  kind = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      analyticalStorageConfiguration = {
        schemaType = "string"
      }
      apiProperties = {
        serverVersion = "string"
      }
      backupPolicy = {
        migrationState = {
          startTime = "string"
          status = "string"
          targetType = "string"
        }
        type = "string"
        // For remaining properties, see BackupPolicy objects
      }
      capabilities = [
        {
          name = "string"
        }
      ]
      capacity = {
        totalThroughputLimit = int
      }
      connectorOffer = "string"
      consistencyPolicy = {
        defaultConsistencyLevel = "string"
        maxIntervalInSeconds = int
        maxStalenessPrefix = int
      }
      cors = [
        {
          allowedHeaders = "string"
          allowedMethods = "string"
          allowedOrigins = "string"
          exposedHeaders = "string"
          maxAgeInSeconds = int
        }
      ]
      createMode = "string"
      customerManagedKeyStatus = "string"
      databaseAccountOfferType = "Standard"
      defaultIdentity = "string"
      disableKeyBasedMetadataWriteAccess = bool
      disableLocalAuth = bool
      enableAnalyticalStorage = bool
      enableAutomaticFailover = bool
      enableBurstCapacity = bool
      enableCassandraConnector = bool
      enableFreeTier = bool
      enableMultipleWriteLocations = bool
      enablePartitionMerge = bool
      ipRules = [
        {
          ipAddressOrRange = "string"
        }
      ]
      isVirtualNetworkFilterEnabled = bool
      keyVaultKeyUri = "string"
      locations = [
        {
          failoverPriority = int
          isZoneRedundant = bool
          locationName = "string"
        }
      ]
      minimalTlsVersion = "string"
      networkAclBypass = "string"
      networkAclBypassResourceIds = [
        "string"
      ]
      publicNetworkAccess = "string"
      restoreParameters = {
        databasesToRestore = [
          {
            collectionNames = [
              "string"
            ]
            databaseName = "string"
          }
        ]
        gremlinDatabasesToRestore = [
          {
            databaseName = "string"
            graphNames = [
              "string"
            ]
          }
        ]
        restoreMode = "string"
        restoreSource = "string"
        restoreTimestampInUtc = "string"
        tablesToRestore = [
          "string"
        ]
      }
      virtualNetworkRules = [
        {
          id = "string"
          ignoreMissingVNetServiceEndpoint = bool
        }
      ]
    }
  })
}

BackupPolicy 物件

設定 類型 屬性，以指定物件的類型。

針對 連續，請使用：

{
  continuousModeProperties = {
    tier = "string"
  }
  type = "Continuous"
}

針對 定期，請使用：

{
  periodicModeProperties = {
    backupIntervalInMinutes = int
    backupRetentionIntervalInHours = int
    backupStorageRedundancy = "string"
  }
  type = "Periodic"
}

屬性值

分析StorageConfiguration

ApiProperties

BackupPolicy

BackupPolicyMigrationState

能力

能力

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ConsistencyPolicy

ContinuousModeBackupPolicy

ContinuousModeProperties

CorsPolicy

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

DatabaseRestoreResource

GremlinDatabaseRestoreResource

IpAddressOrRange

位置

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts

PeriodicModeBackupPolicy

PeriodicModeProperties

RestoreParameters

標籤

VirtualNetworkRule