Microsoft.DocumentDB databaseAccounts 2020-03-01

Bicep リソース定義

databaseAccounts リソースの種類は、次を対象とする操作でデプロイできます。

• リソース グループ - リソース グループのデプロイ コマンドを参照してください

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.DocumentDB/databaseAccounts リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2020-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  properties: {
    capabilities: [
      {
        name: 'string'
      }
    ]
    connectorOffer: 'Small'
    consistencyPolicy: {
      defaultConsistencyLevel: 'string'
      maxIntervalInSeconds: int
      maxStalenessPrefix: int
    }
    databaseAccountOfferType: 'Standard'
    disableKeyBasedMetadataWriteAccess: bool
    enableAutomaticFailover: bool
    enableCassandraConnector: bool
    enableMultipleWriteLocations: bool
    ipRangeFilter: 'string'
    isVirtualNetworkFilterEnabled: bool
    keyVaultKeyUri: 'string'
    locations: [
      {
        failoverPriority: int
        isZoneRedundant: bool
        locationName: 'string'
      }
    ]
    virtualNetworkRules: [
      {
        id: 'string'
        ignoreMissingVNetServiceEndpoint: bool
      }
    ]
  }
}

プロパティ値

databaseAccounts

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

機能

ConsistencyPolicy

位置情報

VirtualNetworkRule

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template	説明
Azure Container Service (AKS) で Jenkins を使用する CI/CD	コンテナーにより、アプリケーションの継続的なビルドとデプロイが非常に簡単になります。 Azure Container Service で Kubernetes を使用してこれらのコンテナーのデプロイを調整することで、コンテナーのレプリケート可能で管理可能なクラスターを実現できます。 コンテナー イメージを生成するための継続的ビルドを設定し、オーケストレーションすることで、デプロイのスピードと信頼性を向上させることができます。
SQL Database、Azure Cosmos DB、Azure Search を使用した Web アプリ	このテンプレートは、Web アプリ、SQL Database、Azure Cosmos DB、Azure Search、Application Insights をプロビジョニングします。
Cassandra API 用の Azure Cosmos DB アカウントを作成する	このテンプレートは、専用スループットのキースペースとテーブルを持つ 2 つのリージョンに Cassandra API 用の Azure Cosmos DB アカウントを作成します。
Cassandra API 用の自動スケーリング Azure Cosmos DB アカウントを作成する	このテンプレートは、キースペースと自動スケーリング スループットを持つテーブルを持つ 2 つのリージョンに Cassandra API 用の Azure Cosmos DB アカウントを作成します。
Azure CosmosDB アカウントを作成する	この ARM テンプレートは、必要最小限の値で CosmosDB アカウントをすばやく作成することを目的としています
複数のリージョンに Azure Cosmos DB アカウントを作成する	このテンプレートでは、整合性レベルとフェールオーバーの種類を選択して、プライマリ リージョンとセカンダリ リージョンを持つ任意のデータベース API の種類に対して Azure Cosmos DB アカウントを作成します。
Free レベルの Azure Cosmos DB アカウントを作成する	このテンプレートでは、共有スループットとコンテナーを持つデータベースを使用して、SQL API 用の Free レベルの Azure Cosmos DB アカウントを作成します。
Gremlin API 用の Azure Cosmos DB アカウントを作成する	このテンプレートは、専用スループットを使用して、1 つのデータベースと 1 つのグラフを持つ 2 つのリージョンに Gremlin API 用の Azure Cosmos DB アカウントを作成します。
Gremlin API 自動スケーリング用の Azure Cosmos DB アカウントを作成する	このテンプレートは、自動スケーリング スループットを使用して、1 つのデータベースと 1 つのグラフを持つ 2 つのリージョンに Gremlin API 用の Azure Cosmos DB アカウントを作成します。
MongoDB API 用の Azure Cosmos アカウントを作成する	このテンプレートでは、2 つのコレクションで共有スループットと専用スループットを使用して、MongoDB API 4.2 用の Azure Cosmos DB アカウントを 2 つのリージョンに作成します。
MongoDB API 自動スケーリング用の Azure Cosmos アカウントを作成する	このテンプレートは、共有と専用の自動スケーリングスループットの両方を使用して、2 つのリージョンに MongoDB API 4.2 用の Azure Cosmos DB アカウントを作成します。
プライベート エンドポイントを使用して Azure Cosmos DB アカウントを作成する	このテンプレートでは、Cosmos アカウント、仮想ネットワーク、および Cosmos アカウントを仮想ネットワークに公開するプライベート エンドポイントが作成されます。
Core (SQL) API 用の Azure Cosmos DB アカウントを作成する	このテンプレートでは、他の複数のオプションを含むスループットを持つデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。
分析ストアを使用した Azure Cosmos DB アカウント SQL API	このテンプレートは、分析ストアで構成されたデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。
自動スケーリングを使用して Azure Cosmos DB アカウント SQL API を作成する	このテンプレートでは、他の複数のオプションを使用して、自動スケーリング スループットを持つデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。
Azure Cosmos DB Core (SQL) API ストアド プロシージャを作成する	このテンプレートは、Core (SQL) API 用の Azure Cosmos DB アカウントと、ストアド プロシージャ、トリガー、およびユーザー定義関数を含むコンテナーを作成します。
Core (SQL) API 用の最小限の Azure Cosmos DB アカウントを作成する	このテンプレートでは、必要最小限のリソース プロパティのみを指定しながら、Core (SQL) API 用の Azure Cosmos DB アカウントを作成します。
SQL API と複数のコンテナーを使用して Azure Cosmos を作成する	このテンプレートでは、SQL API を使用して Cosmos コンテナーを作成し、複数のコンテナーを追加できます。
データ プレーン RBAC を使用して Azure Cosmos DB SQL アカウントを作成する	このテンプレートは、AAD ID 用の SQL Cosmos アカウント、ネイティブに管理されるロールの定義、およびネイティブに管理されるロールの割り当てを作成します。
SQL API 用のサーバーレス Azure Cosmos DB アカウントを作成する	このテンプレートは、Core (SQL) API 用のサーバーレス Azure Cosmos DB アカウントを作成します。
Table API 用の Azure Cosmos アカウントを作成する	このテンプレートでは、Table API 用の Azure Cosmos DB アカウントを 2 つのリージョンに作成し、スループットがプロビジョニングされた 1 つのテーブルを作成します。
自動スケーリングを使用して Table API 用の Azure Cosmos アカウントを作成する	このテンプレートは、2 つのリージョンに Table API 用の Azure Cosmos DB アカウントを作成し、自動スケーリング スループットを持つ 1 つのテーブルを作成します。
ゼロタッチの Azure Cosmos アカウントと Azure Web アプリを作成する	このテンプレートは、Azure Cosmos アカウントを作成し、Cosmos DB エンドポイントとキーを Azure Web App 設定に挿入してから、GitHub から ASP MVC Web アプリをデプロイします。
Microsoft Defender を有効にして Cosmos DB アカウントを作成する	この ARM テンプレートを使用すると、Microsoft Defender for Azure Cosmos DB が有効になっている Azure Cosmos DB アカウントをデプロイできます。 Microsoft Defender for Azure Cosmos DB は、Azure ネイティブのセキュリティ層であり、ここでは Azure Cosmos DB アカウント内のデータベースを悪用しようとする試みが検出されます。 Microsoft Defender for Azure Cosmos DB は、侵害された ID や悪意のある内部関係者を通じて、潜在的な SQL インジェクション、Microsoft 脅威インテリジェンスに基づく既知の悪意のあるアクター、疑わしいアクセス パターン、およびデータベースの潜在的な悪用を検出します。
Cosmos DB 接続を使用して Azure Data Explorer DB をデプロイする	Cosmos DB 接続を使用して Azure Data Explorer DB をデプロイします。
Web アプリを使用した Azure Cosmos DB アカウント	このテンプレートは、Azure Cosmos DB アカウント、App Service プランをデプロイし、App Service プランに Web アプリを作成します。 また、Azure Cosmos DB アカウント エンドポイントを参照する 2 つのアプリケーション設定を Web アプリに追加します。 このようにして、Web アプリにデプロイされたソリューションは、これらの設定を使用して Azure Cosmos DB アカウント エンドポイントに接続できます。

ARM テンプレート リソース定義

databaseAccounts リソースの種類は、次を対象とする操作でデプロイできます。

• リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.DocumentDB/databaseAccounts リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "apiVersion": "2020-03-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "properties": {
    "capabilities": [
      {
        "name": "string"
      }
    ],
    "connectorOffer": "Small",
    "consistencyPolicy": {
      "defaultConsistencyLevel": "string",
      "maxIntervalInSeconds": "int",
      "maxStalenessPrefix": "int"
    },
    "databaseAccountOfferType": "Standard",
    "disableKeyBasedMetadataWriteAccess": "bool",
    "enableAutomaticFailover": "bool",
    "enableCassandraConnector": "bool",
    "enableMultipleWriteLocations": "bool",
    "ipRangeFilter": "string",
    "isVirtualNetworkFilterEnabled": "bool",
    "keyVaultKeyUri": "string",
    "locations": [
      {
        "failoverPriority": "int",
        "isZoneRedundant": "bool",
        "locationName": "string"
      }
    ],
    "virtualNetworkRules": [
      {
        "id": "string",
        "ignoreMissingVNetServiceEndpoint": "bool"
      }
    ]
  }
}

プロパティ値

databaseAccounts

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

機能

ConsistencyPolicy

位置情報

VirtualNetworkRule

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template	説明
Azure Container Service (AKS) で Jenkins を使用する CI/CD	コンテナーにより、アプリケーションの継続的なビルドとデプロイが非常に簡単になります。 Azure Container Service で Kubernetes を使用してこれらのコンテナーのデプロイを調整することで、コンテナーのレプリケート可能で管理可能なクラスターを実現できます。 コンテナー イメージを生成するための継続的ビルドを設定し、オーケストレーションすることで、デプロイのスピードと信頼性を向上させることができます。
SQL Database、Azure Cosmos DB、Azure Search を使用した Web アプリ	このテンプレートは、Web アプリ、SQL Database、Azure Cosmos DB、Azure Search、Application Insights をプロビジョニングします。
Cassandra API 用の Azure Cosmos DB アカウントを作成する	このテンプレートは、専用スループットのキースペースとテーブルを持つ 2 つのリージョンに Cassandra API 用の Azure Cosmos DB アカウントを作成します。
Cassandra API 用の自動スケーリング Azure Cosmos DB アカウントを作成する	このテンプレートは、キースペースと自動スケーリング スループットを持つテーブルを持つ 2 つのリージョンに Cassandra API 用の Azure Cosmos DB アカウントを作成します。
Azure CosmosDB アカウントを作成する	この ARM テンプレートは、必要最小限の値で CosmosDB アカウントをすばやく作成することを目的としています
複数のリージョンに Azure Cosmos DB アカウントを作成する	このテンプレートでは、整合性レベルとフェールオーバーの種類を選択して、プライマリ リージョンとセカンダリ リージョンを持つ任意のデータベース API の種類に対して Azure Cosmos DB アカウントを作成します。
Free レベルの Azure Cosmos DB アカウントを作成する	このテンプレートでは、共有スループットとコンテナーを持つデータベースを使用して、SQL API 用の Free レベルの Azure Cosmos DB アカウントを作成します。
Gremlin API 用の Azure Cosmos DB アカウントを作成する	このテンプレートは、専用スループットを使用して、1 つのデータベースと 1 つのグラフを持つ 2 つのリージョンに Gremlin API 用の Azure Cosmos DB アカウントを作成します。
Gremlin API 自動スケーリング用の Azure Cosmos DB アカウントを作成する	このテンプレートは、自動スケーリング スループットを使用して、1 つのデータベースと 1 つのグラフを持つ 2 つのリージョンに Gremlin API 用の Azure Cosmos DB アカウントを作成します。
MongoDB API 用の Azure Cosmos アカウントを作成する	このテンプレートでは、2 つのコレクションで共有スループットと専用スループットを使用して、MongoDB API 4.2 用の Azure Cosmos DB アカウントを 2 つのリージョンに作成します。
MongoDB API 自動スケーリング用の Azure Cosmos アカウントを作成する	このテンプレートは、共有と専用の自動スケーリングスループットの両方を使用して、2 つのリージョンに MongoDB API 4.2 用の Azure Cosmos DB アカウントを作成します。
プライベート エンドポイントを使用して Azure Cosmos DB アカウントを作成する	このテンプレートでは、Cosmos アカウント、仮想ネットワーク、および Cosmos アカウントを仮想ネットワークに公開するプライベート エンドポイントが作成されます。
Core (SQL) API 用の Azure Cosmos DB アカウントを作成する	このテンプレートでは、他の複数のオプションを含むスループットを持つデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。
分析ストアを使用した Azure Cosmos DB アカウント SQL API	このテンプレートは、分析ストアで構成されたデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。
自動スケーリングを使用して Azure Cosmos DB アカウント SQL API を作成する	このテンプレートでは、他の複数のオプションを使用して、自動スケーリング スループットを持つデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。
Azure Cosmos DB Core (SQL) API ストアド プロシージャを作成する	このテンプレートは、Core (SQL) API 用の Azure Cosmos DB アカウントと、ストアド プロシージャ、トリガー、およびユーザー定義関数を含むコンテナーを作成します。
Core (SQL) API 用の最小限の Azure Cosmos DB アカウントを作成する	このテンプレートでは、必要最小限のリソース プロパティのみを指定しながら、Core (SQL) API 用の Azure Cosmos DB アカウントを作成します。
SQL API と複数のコンテナーを使用して Azure Cosmos を作成する	このテンプレートでは、SQL API を使用して Cosmos コンテナーを作成し、複数のコンテナーを追加できます。
データ プレーン RBAC を使用して Azure Cosmos DB SQL アカウントを作成する	このテンプレートは、AAD ID 用の SQL Cosmos アカウント、ネイティブに管理されるロールの定義、およびネイティブに管理されるロールの割り当てを作成します。
SQL API 用のサーバーレス Azure Cosmos DB アカウントを作成する	このテンプレートは、Core (SQL) API 用のサーバーレス Azure Cosmos DB アカウントを作成します。
Table API 用の Azure Cosmos アカウントを作成する	このテンプレートでは、Table API 用の Azure Cosmos DB アカウントを 2 つのリージョンに作成し、スループットがプロビジョニングされた 1 つのテーブルを作成します。
自動スケーリングを使用して Table API 用の Azure Cosmos アカウントを作成する	このテンプレートは、2 つのリージョンに Table API 用の Azure Cosmos DB アカウントを作成し、自動スケーリング スループットを持つ 1 つのテーブルを作成します。
ゼロタッチの Azure Cosmos アカウントと Azure Web アプリを作成する	このテンプレートは、Azure Cosmos アカウントを作成し、Cosmos DB エンドポイントとキーを Azure Web App 設定に挿入してから、GitHub から ASP MVC Web アプリをデプロイします。
Microsoft Defender を有効にして Cosmos DB アカウントを作成する	この ARM テンプレートを使用すると、Microsoft Defender for Azure Cosmos DB が有効になっている Azure Cosmos DB アカウントをデプロイできます。 Microsoft Defender for Azure Cosmos DB は、Azure ネイティブのセキュリティ層であり、ここでは Azure Cosmos DB アカウント内のデータベースを悪用しようとする試みが検出されます。 Microsoft Defender for Azure Cosmos DB は、侵害された ID や悪意のある内部関係者を通じて、潜在的な SQL インジェクション、Microsoft 脅威インテリジェンスに基づく既知の悪意のあるアクター、疑わしいアクセス パターン、およびデータベースの潜在的な悪用を検出します。
Cosmos DB 接続を使用して Azure Data Explorer DB をデプロイする	Cosmos DB 接続を使用して Azure Data Explorer DB をデプロイします。
Web アプリを使用した Azure Cosmos DB アカウント	このテンプレートは、Azure Cosmos DB アカウント、App Service プランをデプロイし、App Service プランに Web アプリを作成します。 また、Azure Cosmos DB アカウント エンドポイントを参照する 2 つのアプリケーション設定を Web アプリに追加します。 このようにして、Web アプリにデプロイされたソリューションは、これらの設定を使用して Azure Cosmos DB アカウント エンドポイントに接続できます。

Terraform (AzAPI プロバイダー) リソース定義

databaseAccounts リソースの種類は、次を対象とする操作でデプロイできます。

• リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.DocumentDB/databaseAccounts リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts@2020-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      capabilities = [
        {
          name = "string"
        }
      ]
      connectorOffer = "Small"
      consistencyPolicy = {
        defaultConsistencyLevel = "string"
        maxIntervalInSeconds = int
        maxStalenessPrefix = int
      }
      databaseAccountOfferType = "Standard"
      disableKeyBasedMetadataWriteAccess = bool
      enableAutomaticFailover = bool
      enableCassandraConnector = bool
      enableMultipleWriteLocations = bool
      ipRangeFilter = "string"
      isVirtualNetworkFilterEnabled = bool
      keyVaultKeyUri = "string"
      locations = [
        {
          failoverPriority = int
          isZoneRedundant = bool
          locationName = "string"
        }
      ]
      virtualNetworkRules = [
        {
          id = "string"
          ignoreMissingVNetServiceEndpoint = bool
        }
      ]
    }
    kind = "string"
  })
}

プロパティ値

databaseAccounts

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

機能

ConsistencyPolicy

位置情報

VirtualNetworkRule