次の方法で共有

Microsoft.DocumentDB databaseAccounts 2023-09-15-preview

  • [アーティクル]

Bicep リソース定義

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

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

リソース形式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2023-09-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  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: 'Small'
    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'
    defaultPriorityLevel: 'string'
    diagnosticLogSettings: {
      enableFullTextQuery: 'string'
    }
    disableKeyBasedMetadataWriteAccess: bool
    disableLocalAuth: bool
    enableAnalyticalStorage: bool
    enableAutomaticFailover: bool
    enableBurstCapacity: bool
    enableCassandraConnector: bool
    enableFreeTier: bool
    enableMaterializedViews: bool
    enableMultipleWriteLocations: bool
    enablePartitionMerge: bool
    enablePriorityBasedExecution: 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: 'PointInTime'
      restoreSource: 'string'
      restoreTimestampInUtc: 'string'
      sourceBackupLocation: 'string'
      tablesToRestore: [
        'string'
      ]
    }
    virtualNetworkRules: [
      {
        id: 'string'
        ignoreMissingVNetServiceEndpoint: bool
      }
    ]
  }
}

BackupPolicy オブジェクト

オブジェクトの 型 を指定するには、type プロパティを設定します。

[継続的] には、次の値を使用します。

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

定期的な場合は、次の値を使用します。

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

プロパティ値

databaseAccounts

名前 説明 値
name リソース名 string (必須)

文字制限: 3 から 44

有効な文字:
小文字、数字、およびハイフン。

先頭には小文字または数字を使用します。

リソース名は、Azure 全体で一意である必要があります。
location リソースが属しているリソース グループの場所。 string
tags タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
kind データベース アカウントの種類を示します。 これは、データベース アカウントの作成時にのみ設定できます。 'GlobalDocumentDB'
'MongoDB'
'Parse'
identity リソースの ID。 ManagedServiceIdentity
properties Azure Cosmos DB データベース アカウントを作成および更新するためのプロパティ。 DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (必須)

ManagedServiceIdentity

名前 説明 値
type リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名前 説明 値
{カスタマイズされたプロパティ} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

名前 説明 値
analyticalStorageConfiguration 分析ストレージ固有のプロパティ。 AnalyticalStorageConfiguration
apiProperties API 固有のプロパティ。 現在、MongoDB API でのみサポートされています。 ApiProperties
backupPolicy アカウントでバックアップを作成するためのポリシーを表す オブジェクト。 BackupPolicy
capabilities アカウントの Cosmos DB 機能の一覧 Capability[]
capacity アカウントの容量の適用に関連するすべてのプロパティを表す オブジェクト。 [容量]
connectorOffer Cosmos DB データベース C* アカウントの cassandra コネクタ オファーの種類。 'Small'
consistencyPolicy Cosmos DB アカウントの整合性ポリシー。 ConsistencyPolicy
cors Cosmos DB データベース アカウントの CORS ポリシー。 CorsPolicy[]
createMode アカウントの作成モードを示す列挙型。 'Default'
'PointInTimeRestore'
'Restore'
customerManagedKeyStatus アカウントのカスタマー マネージド キー機能の状態を示します。 エラーが発生した場合は、 プロパティでトラブルシューティング ガイダンスが提供されます。 '構成済みのカスタマー マネージド キーへのアクセスが確認されました。'
"Azure Cosmos DB アカウントには未定義の既定の ID があるため、アカウントへのアクセスは現在取り消されています。このエラーの詳細とアカウントへのアクセスを復元する方法については、(4015) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#invalid-azure-cosmos-db-default-identity してください。
'Azure Cosmos DB アカウントのキー コンテナー キー URI が想定される形式に従っていないため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4006) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#improper-syntax-detected-on-the-key-vault-uri-property してください。
Azure Cosmos DB サービスがアカウントの既定の ID の AAD 認証トークンを取得できないため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4000) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-active-directory-token-acquisition-error してください。
'Azure Cosmos DB サービスがキーをラップまたはラップ解除できないため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4005) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#internal-unwrapping-procedure-error してください。
'アカウントの keyvaultkeyuri プロパティで指定された Azure Key Vault DNS 名を解決できなかったため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4009) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#unable-to-resolve-the-key-vaults-dns してください。
"アクセス規則によって Azure Key Vault サービスへの送信要求がブロックされているため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4016) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide してください。
'対応する Azure Key Vault が見つからなかったため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4017) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found してください。
'指定された Key Vault で対応するキーが見つからないため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4003) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found してください。
'現在の既定の ID に関連付けられている Key Vault キーへのアクセス許可がなくなったため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4002) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#default-identity-is-unauthorized-to-access-the-azure-key-vault-key してください。
'アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、 を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guideしてください。
databaseAccountOfferType データベースのオファーの種類 'Standard' (必須)
defaultIdentity カスタマー マネージド キーなどの機能で使用されるキー コンテナーにアクセスするための既定の ID。 既定の ID は、ユーザーが明示的に設定する必要があります。 "FirstPartyIdentity"、"SystemAssignedIdentity" などです。 string
defaultPriorityLevel 優先度ベースの実行に対する要求の既定の優先度レベルを示す列挙型。 'High'
'Low'
diagnosticLogSettings Cosmos DB アカウントのさまざまな診断ログ設定を表す オブジェクト。 DiagnosticLogSettings
disableKeyBasedMetadataWriteAccess アカウント キーを使用してメタデータ リソース (データベース、コンテナー、スループット) に対する書き込み操作を無効にする [bool]
disableLocalAuth ローカル認証をオプトアウトし、MSI と AAD のみを認証専用に使用できるようにします。 [bool]
enableAnalyticalStorage ストレージ分析を有効にするかどうかを示すフラグ。 [bool]
enableAutomaticFailover 障害が原因でリージョンが使用できないまれな場合に、書き込みリージョンの自動フェールオーバーを有効にします。 自動フェールオーバーにより、アカウントの新しい書き込みリージョンが作成され、アカウントに構成されているフェールオーバーの優先順位に基づいて選択されます。 [bool]
enableBurstCapacity アカウントでのバースト容量プレビュー機能の有効化/無効化を示すフラグ [bool]
enableCassandraConnector Cosmos DB C* アカウントで cassandra コネクタを有効にします [bool]
enableFreeTier Free レベルが有効かどうかを示すフラグ。 [bool]
enableMaterializedViews Cosmos DB アカウントで MaterializedViews を有効にするかどうかを示すフラグ [bool]
enableMultipleWriteLocations アカウントを複数の場所に書き込むことができます [bool]
enablePartitionMerge アカウントでのパーティション マージ機能の有効化/無効化を示すフラグ [bool]
enablePriorityBasedExecution アカウントでの優先度ベースの実行プレビュー機能の有効化/無効化を示すフラグ [bool]
ipRules IpRules の一覧。 IpAddressOrRange[]
isVirtualNetworkFilterEnabled 仮想ネットワーク ACL 規則を有効または無効にするかどうかを示すフラグ。 [bool]
keyVaultKeyUri キー コンテナーの URI string
locations Cosmos DB アカウントで有効になっている georeplication の場所を含む配列。 Location[] (必須)
minimalTlsVersion 許可されている Tls の最小バージョンを示します。 Tls 1.2 でのみ動作する Cassandra と Mongo API を除き、既定値は Tls 1.0 です。 'Tls'
'Tls11'
'Tls12'
networkAclBypass ファイアウォール チェックをバイパスできるサービスを示します。 'AzureServices'
'None'
networkAclBypassResourceIds Cosmos DB アカウントのネットワーク ACL バイパスのリソース ID を含む配列。 string[]
publicNetworkAccess パブリック ネットワークからの要求を許可するかどうか 'Disabled'
'Enabled'
'SecuredByPerimeter'
restoreParameters 復元に関する情報を示すパラメーター。 RestoreParameters
virtualNetworkRules Cosmos DB アカウント用に構成された仮想ネットワーク ACL 規則の一覧。 VirtualNetworkRule[]

AnalyticalStorageConfiguration

名前 説明 値
schemaType 分析ストレージのスキーマの種類について説明します。 'FullFidelity'
'WellDefined'

ApiProperties

名前 説明 値
serverVersion MongoDB アカウントの ServerVersion について説明します。 '3.2'
'3.6'
'4.0'
'4.2'

BackupPolicy

名前 説明 値
migrationState バックアップ ポリシー間の移行の状態を表す オブジェクト。 BackupPolicyMigrationState
型 オブジェクトの種類を設定する 継続的
定期的 (必須)

BackupPolicyMigrationState

名前 説明 値
startTime バックアップ ポリシーの移行が開始された時刻 (ISO-8601 形式)。 string
status バックアップ ポリシーの種類間の移行の状態について説明します。 'Completed'
'Failed'
'InProgress'
'Invalid'
targetType バックアップ ポリシー移行のターゲット バックアップ ポリシーの種類について説明します。 'Continuous'
'Periodic'

ContinuousModeBackupPolicy

名前 説明 値
type バックアップのモードについて説明します。 'Continuous' (必須)
continuousModeProperties 連続モード バックアップの構成値 ContinuousModeProperties

ContinuousModeProperties

名前 説明 値
レベル Continuos バックアップ モードの種類を示す列挙型 'Continuous30Days'
'Continuous7Days'

PeriodicModeBackupPolicy

名前 説明 値
type バックアップのモードについて説明します。 'Periodic' (必須)
periodicModeProperties 定期モード バックアップの構成値 PeriodicModeProperties

PeriodicModeProperties

名前 説明 値
backupIntervalInMinutes 2 つのバックアップ間の間隔を分単位で表す整数 INT

制約:
最小値 = 0
backupRetentionIntervalInHours 各バックアップが保持される時間 (時間単位) を表す整数 INT

制約:
最小値 = 0
backupStorageRedundancy バックアップの保存場所の種類を示す列挙型 'Geo'
'Local'
'Zone'

機能

名前 説明 値
name Cosmos DB 機能の名前。 たとえば、"name": "EnableCassandra" です。 現在の値には、"EnableTable" と "EnableGremlin" も含まれます。 string

容量

名前 説明 値
totalThroughputLimit アカウントに課される合計スループット制限。 totalThroughputLimit が 2000 の場合、そのアカウントでプロビジョニングできる最大スループットの厳密な制限は 2000 になります。 totalThroughputLimit の -1 は、スループットのプロビジョニングに制限がないことを示します。 INT

ConsistencyPolicy

名前 説明 値
defaultConsistencyLevel Cosmos DB アカウントの既定の整合性レベルと構成設定。 'BoundedStaleness'
'ConsistentPrefix'
'Eventual'
'Session'
'Strong' (必須)
maxIntervalInSeconds 有界整合性整合性レベルで使用する場合、この値は許容される制約の時間 (秒単位) を表します。 この値の許容範囲は 5 ~ 86400 です。 defaultConsistencyPolicy が 'BoundedStaleness' に設定されている場合に必要です。 INT

制約:
最小値 = 5
最大値 = 86400
maxStalenessPrefix 有界整合性整合性レベルで使用する場合、この値は許容される古い要求の数を表します。 この値の許容範囲は、1 ～ 2,147,483,647 です。 defaultConsistencyPolicy が 'BoundedStaleness' に設定されている場合に必要です。 INT

制約:
最小値 = 1
最大値 = 2147483647

CorsPolicy

名前 説明 値
allowedHeaders 元のドメインが CORS 要求に指定できる要求ヘッダー。 string
allowedMethods 元のドメインが CORS 要求で使用できるメソッド (HTTP 要求の動詞)。 string
allowedOrigins CORS 経由でサービスに対して要求を行うことができます。 string (必須)
exposedHeaders CORS 要求への応答で送信され、ブラウザーが要求の発行元に公開できる応答ヘッダー。 string
maxAgeInSeconds ブラウザーがプレフライト OPTIONS 要求をキャッシュする最大時間。 INT

制約:
最小値 = 1
最大値 = 2147483647

DiagnosticLogSettings

名前 説明 値
enableFullTextQuery クエリをログに記録する詳細レベルについて説明します。 "False"
'None'
'True'

IpAddressOrRange

名前 説明 値
ipAddressOrRange 1 つの IPv4 アドレスまたは CIDR 形式の単一の IPv4 アドレス範囲。 IP アドレスは適切に書式設定されている必要があり、10.0.0.0/8、100.64.0.0/10、172.16.0.0/12、192.168.0.0/16 のいずれかの範囲に含めることはできません。IP アドレス フィルターでは適用できないためです。 有効な入力の例: "23.40.210.245" または "23.40.210.0/8" string

場所

名前 説明 値
failoverPriority リージョンのフェールオーバー優先度。 フェールオーバーの優先度が 0 の場合は、書き込みリージョンを示します。 フェールオーバー優先度の最大値 = (リージョンの合計数 - 1)。 フェールオーバーの優先度の値は、データベース アカウントが存在するリージョンごとに一意である必要があります。 INT

制約:
最小値 = 0
isZoneRedundant このリージョンが AvailabilityZone リージョンかどうかを示すフラグ [bool]
locationName 領域の名前。 string

RestoreParameters

名前 説明 値
databasesToRestore 復元に使用できる特定のデータベースの一覧。 DatabaseRestoreResource[]
gremlinDatabasesToRestore 復元に使用できる特定の gremlin データベースの一覧。 GremlinDatabaseRestoreResource[]
restoreMode 復元のモードについて説明します。 'PointInTime'
restoreSource 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc アカウントを復元する必要がある時間 (ISO-8601 形式)。 string
sourceBackupLocation 復元のソース バックアップの場所。 string
tablesToRestore 復元に使用できる特定のテーブルの一覧。 string[]

DatabaseRestoreResource

名前 説明 値
collectionNames 復元に使用できるコレクションの名前。 string[]
databaseName 復元に使用できるデータベースの名前。 string

GremlinDatabaseRestoreResource

名前 説明 値
databaseName 復元に使用できる gremlin データベースの名前。 string
graphNames 復元に使用できるグラフの名前。 string[]

VirtualNetworkRule

名前 説明 値
id サブネットのリソース ID(例: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName})。 string
ignoreMissingVNetServiceEndpoint 仮想ネットワークで vnet サービス エンドポイントが有効になる前に、ファイアウォール規則を作成します。 [bool]

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

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

Template 説明
Azure Container Service (AKS) で Jenkins を使用する CI/CD

Azure にデプロイする		 コンテナーにより、アプリケーションの継続的なビルドとデプロイが非常に簡単になります。 Azure Container Service で Kubernetes を使用してこれらのコンテナーのデプロイを調整することで、コンテナーのレプリケート可能で管理しやすいクラスターを実現できます。 コンテナー イメージを生成するための継続的ビルドを設定し、オーケストレーションすることで、デプロイのスピードと信頼性を向上させることができます。
SQL Database、Azure Cosmos DB、Azure Search を使用した Web アプリ

Azure にデプロイする		 このテンプレートは、Web アプリ、SQL Database、Azure Cosmos DB、Azure Search、Application Insights をプロビジョニングします。
Cassandra API 用の Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートは、専用スループットのキースペースとテーブルを持つ 2 つのリージョンに Cassandra API 用の Azure Cosmos DB アカウントを作成します。
Cassandra API の自動スケーリング Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートは、キースペースと自動スケーリング スループットを持つテーブルを持つ 2 つのリージョンに Cassandra API 用の Azure Cosmos DB アカウントを作成します。
Azure CosmosDB アカウントを作成する

Azure にデプロイする		 この ARM テンプレートは、必要最小限の値で CosmosDB アカウントをすばやく作成することを目的としています
複数のリージョンに Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートは、整合性レベルとフェールオーバーの種類を選択して、プライマリリージョンとセカンダリ リージョンを持つ任意のデータベース API の種類に対して Azure Cosmos DB アカウントを作成します。
Free レベルの Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートでは、共有スループットとコンテナーを持つデータベースを使用して、SQL API 用の Free レベルの Azure Cosmos DB アカウントを作成します。
Gremlin API 用の Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートは、専用スループットを使用して、1 つのデータベースと 1 つのグラフを含む 2 つのリージョンに Gremlin API 用の Azure Cosmos DB アカウントを作成します。
Gremlin API 自動スケーリング用の Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートは、自動スケーリング スループットを使用して、1 つのデータベースと 1 つのグラフを含む 2 つのリージョンに Gremlin API 用の Azure Cosmos DB アカウントを作成します。
MongoDB API 用の Azure Cosmos アカウントを作成する

Azure にデプロイする		 このテンプレートでは、2 つのコレクションで共有スループットと専用スループットを使用して、MongoDB API 4.2 用の Azure Cosmos DB アカウントを 2 つのリージョンに作成します。
MongoDB API 自動スケーリング用の Azure Cosmos アカウントを作成する

Azure にデプロイする		 このテンプレートでは、共有と専用の自動スケーリングの両方のスループットを使用して、MongoDB API 4.2 用の Azure Cosmos DB アカウントを 2 つのリージョンに作成します。
プライベート エンドポイントを使用して Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートでは、Cosmos アカウント、仮想ネットワーク、および Cosmos アカウントを仮想ネットワークに公開するプライベート エンドポイントが作成されます。
Core (SQL) API 用の Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートでは、他の複数のオプションを含むスループットを持つデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。
分析ストアを使用した Azure Cosmos DB アカウント SQL API

Azure にデプロイする		 このテンプレートでは、分析ストアで構成されたデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。
自動スケーリングを使用して Azure Cosmos DB アカウント SQL API を作成する

Azure にデプロイする		 このテンプレートでは、他の複数のオプションを使用して、自動スケーリング スループットを持つデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。
Azure Cosmos DB Core (SQL) API ストアド プロシージャを作成する

Azure にデプロイする		 このテンプレートでは、Core (SQL) API 用の Azure Cosmos DB アカウントと、ストアド プロシージャ、トリガー、およびユーザー定義関数を含むコンテナーを作成します。
Core (SQL) API 用の最小限の Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートでは、必要最小限のリソース プロパティのみを指定しながら、コア (SQL) API 用の Azure Cosmos DB アカウントを作成します。
SQL API と複数のコンテナーを使用して Azure Cosmos を作成する

Azure にデプロイする		 このテンプレートでは、SQL API を使用して Cosmos コンテナーを作成し、複数のコンテナーを追加できます。
データ プレーン RBAC を使用して Azure Cosmos DB SQL アカウントを作成する

Azure にデプロイする		 このテンプレートは、AAD ID 用の SQL Cosmos アカウント、ネイティブに管理されるロールの定義、およびネイティブに管理されるロールの割り当てを作成します。
SQL API 用のサーバーレス Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートは、Core (SQL) API 用のサーバーレス Azure Cosmos DB アカウントを作成します。
Table API 用の Azure Cosmos アカウントを作成する

Azure にデプロイする		 このテンプレートでは、Table API 用の Azure Cosmos DB アカウントが 2 つのリージョンに作成され、スループットがプロビジョニングされた 1 つのテーブルが作成されます。
自動スケーリングを使用して Table API 用の Azure Cosmos アカウントを作成する

Azure にデプロイする		 このテンプレートでは、2 つのリージョンに Table API 用の Azure Cosmos DB アカウントを作成し、自動スケーリング スループットを持つ 1 つのテーブルを作成します。
ゼロタッチの Azure Cosmos アカウントと Azure Web アプリを作成する

Azure にデプロイする		 このテンプレートでは、Azure Cosmos アカウントを作成し、Cosmos DB エンドポイントとキーを Azure Web App 設定に挿入してから、GitHub から ASP MVC Web アプリをデプロイします。
Microsoft Defender を有効にして Cosmos DB アカウントを作成する

Azure にデプロイする		 この 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 は、潜在的な SQL インジェクション、Microsoft 脅威インテリジェンスに基づく既知の悪意のあるアクター、疑わしいアクセス パターン、および侵害された ID または悪意のある内部関係者によるデータベースの潜在的な悪用を検出します。
Cosmos DB 接続を使用して Azure Data Explorer DB をデプロイする

Azure にデプロイする		 Cosmos DB 接続を使用して Azure Data Explorer DB をデプロイします。
Web アプリを使用した Azure Cosmos DB アカウント

Azure にデプロイする		 このテンプレートは、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": "2023-09-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "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": "Small",
    "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",
    "defaultPriorityLevel": "string",
    "diagnosticLogSettings": {
      "enableFullTextQuery": "string"
    },
    "disableKeyBasedMetadataWriteAccess": "bool",
    "disableLocalAuth": "bool",
    "enableAnalyticalStorage": "bool",
    "enableAutomaticFailover": "bool",
    "enableBurstCapacity": "bool",
    "enableCassandraConnector": "bool",
    "enableFreeTier": "bool",
    "enableMaterializedViews": "bool",
    "enableMultipleWriteLocations": "bool",
    "enablePartitionMerge": "bool",
    "enablePriorityBasedExecution": "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": "PointInTime",
      "restoreSource": "string",
      "restoreTimestampInUtc": "string",
      "sourceBackupLocation": "string",
      "tablesToRestore": [ "string" ]
    },
    "virtualNetworkRules": [
      {
        "id": "string",
        "ignoreMissingVNetServiceEndpoint": "bool"
      }
    ]
  }
}

BackupPolicy オブジェクト

オブジェクトの 型 を指定するには、type プロパティを設定します。

[継続的] には、次の値を使用します。

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

定期的な場合は、次の値を使用します。

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

プロパティ値

databaseAccounts

名前 説明 値
type リソースの種類 'Microsoft.DocumentDB/databaseAccounts'
apiVersion リソース API のバージョン '2023-09-15-preview'
name リソース名 string (必須)

文字制限: 3 から 44

有効な文字:
小文字、数字、およびハイフン。

先頭には小文字または数字を使用します。

リソース名は、Azure 全体で一意である必要があります。
location リソースが属しているリソース グループの場所。 string
tags タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
kind データベース アカウントの種類を示します。 これは、データベース アカウントの作成時にのみ設定できます。 'GlobalDocumentDB'
'MongoDB'
'Parse'
identity リソースの ID。 ManagedServiceIdentity
properties Azure Cosmos DB データベース アカウントを作成および更新するためのプロパティ。 DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (必須)

ManagedServiceIdentity

名前 説明 値
type リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名前 説明 値
{カスタマイズされたプロパティ} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

名前 説明 値
analyticalStorageConfiguration 分析ストレージ固有のプロパティ。 AnalyticalStorageConfiguration
apiProperties API 固有のプロパティ。 現在、MongoDB API でのみサポートされています。 ApiProperties
backupPolicy アカウントでバックアップを作成するためのポリシーを表す オブジェクト。 BackupPolicy
capabilities アカウントの Cosmos DB 機能の一覧 Capability[]
capacity アカウントの容量の適用に関連するすべてのプロパティを表す オブジェクト。 [容量]
connectorOffer Cosmos DB データベース C* アカウントの cassandra コネクタ オファーの種類。 'Small'
consistencyPolicy Cosmos DB アカウントの整合性ポリシー。 ConsistencyPolicy
cors Cosmos DB データベース アカウントの CORS ポリシー。 CorsPolicy[]
createMode アカウントの作成モードを示す列挙型。 'Default'
'PointInTimeRestore'
'Restore'
customerManagedKeyStatus アカウントのカスタマー マネージド キー機能の状態を示します。 エラーが発生した場合、プロパティはトラブルシューティング ガイダンスを提供します。 '構成済みのカスタマー マネージド キーへのアクセスが確認されました。'
'Azure Cosmos DB アカウントには未定義の既定の ID があるため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4015) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#invalid-azure-cosmos-db-default-identity してください。
'Azure Cosmos DB アカウントのキー コンテナー キー URI が想定される形式に従っていないため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4006) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#improper-syntax-detected-on-the-key-vault-uri-property してください。
'Azure Cosmos DB サービスがアカウントの既定の ID の AAD 認証トークンを取得できないため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4000) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-active-directory-token-acquisition-error してください。
'Azure Cosmos DB サービスがキーをラップまたはラップ解除できないため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4005) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#internal-unwrapping-procedure-error してください。
'アカウントの keyvaultkeyuri プロパティで指定された Azure Key Vault DNS 名を解決できなかったため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4009) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#unable-to-resolve-the-key-vaults-dns してください。
'アクセス規則によって Azure Key Vault サービスへの送信要求がブロックされているため、アカウントへのアクセスは現在取り消されています。このエラーの詳細とアカウントへのアクセスを復元する方法については、(4016) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide してください。
'対応する Azure Key Vault が見つからなかったため、アカウントへのアクセスは現在取り消されています。このエラーの詳細とアカウントへのアクセスを復元する方法については、(4017) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found してください。
'対応するキーが指定された Key Vault で見つからないため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4003) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found してください。
'現在、アカウントへのアクセスは取り消されています。現在の既定の ID には、関連付けられている Key Vault キーに対するアクセス許可がないためです。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4002) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#default-identity-is-unauthorized-to-access-the-azure-key-vault-key してください。
'アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、 を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guideしてください。
databaseAccountOfferType データベースのオファーの種類 'Standard' (必須)
defaultIdentity カスタマー マネージド キーなどの機能で使用されるキー コンテナーにアクセスするための既定の ID。 既定の ID は、ユーザーが明示的に設定する必要があります。 "FirstPartyIdentity"、"SystemAssignedIdentity" などを指定できます。 string
defaultPriorityLevel 優先度ベースの実行の要求の既定の優先度レベルを示す列挙型。 'High'
'Low'
diagnosticLogSettings Cosmos DB アカウントのさまざまな診断ログ設定を表す オブジェクト。 DiagnosticLogSettings
disableKeyBasedMetadataWriteAccess アカウント キーを使用してメタデータ リソース (データベース、コンテナー、スループット) に対する書き込み操作を無効にする [bool]
disableLocalAuth ローカル認証をオプトアウトし、MSI と AAD のみを認証専用に使用できることを確認します。 [bool]
enableAnalyticalStorage ストレージ分析を有効にするかどうかを示すフラグ。 [bool]
enableAutomaticFailover 障害が原因でリージョンが使用できないまれな場合に、書き込みリージョンの自動フェールオーバーを有効にします。 自動フェールオーバーでは、アカウントの新しい書き込みリージョンが作成され、アカウント用に構成されたフェールオーバーの優先順位に基づいて選択されます。 [bool]
enableBurstCapacity アカウントでバースト容量プレビュー機能を有効または無効にすることを示すフラグ [bool]
enableCassandraConnector Cosmos DB C* アカウントで cassandra コネクタを有効にします [bool]
enableFreeTier Free レベルが有効かどうかを示すフラグ。 [bool]
enableMaterializedViews Cosmos DB アカウントで MaterializedViews を有効にするかどうかを示すフラグ [bool]
enableMultipleWriteLocations アカウントを複数の場所に書き込むことができます [bool]
enablePartitionMerge アカウントでのパーティションマージ機能の有効化/無効化を示すフラグ [bool]
enablePriorityBasedExecution アカウントで優先度ベースの実行プレビュー機能を有効または無効にすることを示すフラグ [bool]
ipRules IpRules の一覧。 IpAddressOrRange[]
isVirtualNetworkFilterEnabled 仮想ネットワーク ACL 規則を有効または無効にするかどうかを示すフラグ。 [bool]
keyVaultKeyUri キー コンテナーの URI string
locations Cosmos DB アカウントで有効になっている georeplication の場所を含む配列。 Location[] (必須)
minimalTlsVersion 許可される Tls の最小バージョンを示します。 Tls 1.2 でのみ動作する Cassandra と Mongo API を除き、既定値は Tls 1.0 です。 'Tls'
'Tls11'
'Tls12'
networkAclBypass ファイアウォール チェックをバイパスできるサービスを示します。 'AzureServices'
'None'
networkAclBypassResourceIds Cosmos DB アカウントのネットワーク ACL バイパスのリソース ID を含む配列。 string[]
publicNetworkAccess パブリック ネットワークからの要求が許可されるかどうか 'Disabled'
'Enabled'
'SecuredByPerimeter'
restoreParameters 復元に関する情報を示すパラメーター。 RestoreParameters
virtualNetworkRules Cosmos DB アカウント用に構成された仮想ネットワーク ACL 規則の一覧。 VirtualNetworkRule[]

AnalyticalStorageConfiguration

名前 説明 値
schemaType 分析ストレージのスキーマの種類について説明します。 'FullFidelity'
'WellDefined'

ApiProperties

名前 説明 値
serverVersion MongoDB アカウントの ServerVersion について説明します。 '3.2'
'3.6'
'4.0'
'4.2'

BackupPolicy

名前 説明 値
migrationState バックアップ ポリシー間の移行の状態を表す オブジェクト。 BackupPolicyMigrationState
型 オブジェクトの種類を設定する 継続的
定期的 (必須)

BackupPolicyMigrationState

名前 説明 値
startTime バックアップ ポリシーの移行が開始された時刻 (ISO-8601 形式)。 string
status バックアップ ポリシーの種類間の移行の状態について説明します。 'Completed'
'Failed'
'InProgress'
'Invalid'
targetType バックアップ ポリシー移行のターゲット バックアップ ポリシーの種類について説明します。 'Continuous'
'Periodic'

ContinuousModeBackupPolicy

名前 説明 値
type バックアップのモードについて説明します。 'Continuous' (必須)
continuousModeProperties 連続モード バックアップの構成値 ContinuousModeProperties

ContinuousModeProperties

名前 説明 値
レベル Continuos バックアップ モードの種類を示す列挙型 'Continuous30Days'
'Continuous7Days'

PeriodicModeBackupPolicy

名前 説明 値
type バックアップのモードについて説明します。 'Periodic' (必須)
periodicModeProperties 定期モード バックアップの構成値 PeriodicModeProperties

PeriodicModeProperties

名前 説明 値
backupIntervalInMinutes 2 つのバックアップ間の間隔を分単位で表す整数 INT

制約:
最小値 = 0
backupRetentionIntervalInHours 各バックアップが保持される時間 (時間単位) を表す整数 INT

制約:
最小値 = 0
backupStorageRedundancy バックアップ所在地の種類を示す列挙型 'Geo'
'Local'
'Zone'

機能

名前 説明 値
name Cosmos DB 機能の名前。 たとえば、"name": "EnableCassandra" です。 現在の値には、"EnableTable" と "EnableGremlin" も含まれます。 string

容量

名前 説明 値
totalThroughputLimit アカウントに課される合計スループット制限。 totalThroughputLimit が 2000 の場合、そのアカウントでプロビジョニングできる最大スループットの厳密な制限は 2000 になります。 totalThroughputLimit の -1 は、スループットのプロビジョニングに制限がないことを示します。 INT

ConsistencyPolicy

名前 説明 値
defaultConsistencyLevel Cosmos DB アカウントの既定の整合性レベルと構成設定。 'BoundedStaleness'
'ConsistentPrefix'
'Eventual'
'Session'
'Strong' (必須)
maxIntervalInSeconds 有界整合性整合性レベルで使用する場合、この値は許容される失効の時間 (秒単位) を表します。 この値に使用できる範囲は 5 から 86400 です。 defaultConsistencyPolicy が 'BoundedStaleness' に設定されている場合は必須です。 INT

制約:
最小値 = 5
最大値 = 86400
maxStalenessPrefix 有界整合性整合性レベルで使用する場合、この値は許容される古い要求の数を表します。 この値の許容範囲は、1 ～ 2,147,483,647 です。 defaultConsistencyPolicy が 'BoundedStaleness' に設定されている場合は必須です。 INT

制約:
最小値 = 1
最大値 = 2147483647

CorsPolicy

名前 説明 値
allowedHeaders 元のドメインが CORS 要求に指定できる要求ヘッダー。 string
allowedMethods 元のドメインが CORS 要求で使用できるメソッド (HTTP 要求の動詞)。 string
allowedOrigins CORS 経由でサービスに対して要求を行うために許可される配信元ドメイン。 string (必須)
exposedHeaders CORS 要求への応答で送信され、ブラウザーが要求の発行元に公開できる応答ヘッダー。 string
maxAgeInSeconds ブラウザーがプレフライト OPTIONS 要求をキャッシュする最大時間。 INT

制約:
最小値 = 1
最大値 = 2147483647

DiagnosticLogSettings

名前 説明 値
enableFullTextQuery クエリをログに記録する詳細レベルについて説明します。 "False"
'None'
'True'

IpAddressOrRange

名前 説明 値
ipAddressOrRange 1 つの IPv4 アドレスまたは CIDR 形式の単一の IPv4 アドレス範囲。 IP アドレスは適切に書式設定されている必要があり、10.0.0.0/8、100.64.0.0/10、172.16.0.0/12、192.168.0.0/16 のいずれかの範囲に含めることはできません。IP アドレス フィルターでは適用できないためです。 有効な入力の例: "23.40.210.245" または "23.40.210.0/8" string

場所

名前 説明 値
failoverPriority リージョンのフェールオーバー優先度。 フェールオーバーの優先度が 0 の場合は、書き込みリージョンを示します。 フェールオーバー優先度の最大値 = (リージョンの合計数 - 1)。 フェールオーバーの優先度の値は、データベース アカウントが存在するリージョンごとに一意である必要があります。 INT

制約:
最小値 = 0
isZoneRedundant このリージョンが AvailabilityZone リージョンかどうかを示すフラグ [bool]
locationName 領域の名前。 string

RestoreParameters

名前 説明 値
databasesToRestore 復元に使用できる特定のデータベースの一覧。 DatabaseRestoreResource[]
gremlinDatabasesToRestore 復元に使用できる特定の gremlin データベースの一覧。 GremlinDatabaseRestoreResource[]
restoreMode 復元のモードについて説明します。 'PointInTime'
restoreSource 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc アカウントを復元する必要がある時間 (ISO-8601 形式)。 string
sourceBackupLocation 復元のソース バックアップの場所。 string
tablesToRestore 復元に使用できる特定のテーブルの一覧。 string[]

DatabaseRestoreResource

名前 説明 値
collectionNames 復元に使用できるコレクションの名前。 string[]
databaseName 復元に使用できるデータベースの名前。 string

GremlinDatabaseRestoreResource

名前 説明 値
databaseName 復元に使用できる gremlin データベースの名前。 string
graphNames 復元に使用できるグラフの名前。 string[]

VirtualNetworkRule

名前 説明 値
id サブネットのリソース ID (例: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName})。 string
ignoreMissingVNetServiceEndpoint 仮想ネットワークで vnet サービス エンドポイントが有効にする前に、ファイアウォール規則を作成します。 [bool]

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

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

Template 説明
Azure Container Service (AKS) で Jenkins を使用する CI/CD

Azure にデプロイする		 コンテナーにより、アプリケーションの継続的なビルドとデプロイが非常に簡単になります。 Azure Container Service で Kubernetes を使用してこれらのコンテナーのデプロイを調整することで、コンテナーのレプリケート可能で管理可能なクラスターを実現できます。 コンテナー イメージを生成するための継続的ビルドを設定し、オーケストレーションすることで、デプロイのスピードと信頼性を向上させることができます。
SQL Database、Azure Cosmos DB、Azure Search を使用した Web アプリ

Azure にデプロイする		 このテンプレートは、Web アプリ、SQL Database、Azure Cosmos DB、Azure Search、Application Insights をプロビジョニングします。
Cassandra API 用の Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートは、専用スループットのキースペースとテーブルを持つ 2 つのリージョンに Cassandra API 用の Azure Cosmos DB アカウントを作成します。
Cassandra API 用の自動スケーリング Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートは、キースペースと自動スケーリング スループットを持つテーブルを持つ 2 つのリージョンに Cassandra API 用の Azure Cosmos DB アカウントを作成します。
Azure CosmosDB アカウントを作成する

Azure にデプロイする		 この ARM テンプレートは、必要最小限の値で CosmosDB アカウントをすばやく作成することを目的としています
複数のリージョンに Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートでは、整合性レベルとフェールオーバーの種類を選択して、プライマリ リージョンとセカンダリ リージョンを持つ任意のデータベース API の種類に対して Azure Cosmos DB アカウントを作成します。
Free レベルの Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートでは、共有スループットとコンテナーを持つデータベースを使用して、SQL API 用の Free レベルの Azure Cosmos DB アカウントを作成します。
Gremlin API 用の Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートは、専用スループットを使用して、1 つのデータベースと 1 つのグラフを持つ 2 つのリージョンに Gremlin API 用の Azure Cosmos DB アカウントを作成します。
Gremlin API 自動スケーリング用の Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートは、自動スケーリング スループットを使用して、1 つのデータベースと 1 つのグラフを持つ 2 つのリージョンに Gremlin API 用の Azure Cosmos DB アカウントを作成します。
MongoDB API 用の Azure Cosmos アカウントを作成する

Azure にデプロイする		 このテンプレートでは、2 つのコレクションで共有スループットと専用スループットを使用して、MongoDB API 4.2 用の Azure Cosmos DB アカウントを 2 つのリージョンに作成します。
MongoDB API 自動スケーリング用の Azure Cosmos アカウントを作成する

Azure にデプロイする		 このテンプレートは、共有と専用の自動スケーリングスループットの両方を使用して、2 つのリージョンに MongoDB API 4.2 用の Azure Cosmos DB アカウントを作成します。
プライベート エンドポイントを使用して Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートでは、Cosmos アカウント、仮想ネットワーク、および Cosmos アカウントを仮想ネットワークに公開するプライベート エンドポイントが作成されます。
Core (SQL) API 用の Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートでは、他の複数のオプションを含むスループットを持つデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。
分析ストアを使用した Azure Cosmos DB アカウント SQL API

Azure にデプロイする		 このテンプレートは、分析ストアで構成されたデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。
自動スケーリングを使用して Azure Cosmos DB アカウント SQL API を作成する

Azure にデプロイする		 このテンプレートでは、他の複数のオプションを使用して、自動スケーリング スループットを持つデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。
Azure Cosmos DB Core (SQL) API ストアド プロシージャを作成する

Azure にデプロイする		 このテンプレートは、Core (SQL) API 用の Azure Cosmos DB アカウントと、ストアド プロシージャ、トリガー、およびユーザー定義関数を含むコンテナーを作成します。
Core (SQL) API 用の最小限の Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートでは、必要最小限のリソース プロパティのみを指定しながら、Core (SQL) API 用の Azure Cosmos DB アカウントを作成します。
SQL API と複数のコンテナーを使用して Azure Cosmos を作成する

Azure にデプロイする		 このテンプレートでは、SQL API を使用して Cosmos コンテナーを作成し、複数のコンテナーを追加できます。
データ プレーン RBAC を使用して Azure Cosmos DB SQL アカウントを作成する

Azure にデプロイする		 このテンプレートは、AAD ID 用の SQL Cosmos アカウント、ネイティブに管理されるロールの定義、およびネイティブに管理されるロールの割り当てを作成します。
SQL API 用のサーバーレス Azure Cosmos DB アカウントを作成する

Azure にデプロイする		 このテンプレートは、Core (SQL) API 用のサーバーレス Azure Cosmos DB アカウントを作成します。
Table API 用の Azure Cosmos アカウントを作成する

Azure にデプロイする		 このテンプレートでは、Table API 用の Azure Cosmos DB アカウントを 2 つのリージョンに作成し、スループットがプロビジョニングされた 1 つのテーブルを作成します。
自動スケーリングを使用して Table API 用の Azure Cosmos アカウントを作成する

Azure にデプロイする		 このテンプレートは、2 つのリージョンに Table API 用の Azure Cosmos DB アカウントを作成し、自動スケーリング スループットを持つ 1 つのテーブルを作成します。
ゼロタッチの Azure Cosmos アカウントと Azure Web アプリを作成する

Azure にデプロイする		 このテンプレートは、Azure Cosmos アカウントを作成し、Cosmos DB エンドポイントとキーを Azure Web App 設定に挿入してから、GitHub から ASP MVC Web アプリをデプロイします。
Microsoft Defender を有効にして Cosmos DB アカウントを作成する

Azure にデプロイする		 この 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 をデプロイする

Azure にデプロイする		 Cosmos DB 接続を使用して Azure Data Explorer DB をデプロイします。
Web アプリを使用した Azure Cosmos DB アカウント

Azure にデプロイする		 このテンプレートは、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@2023-09-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  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 = "Small"
      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"
      defaultPriorityLevel = "string"
      diagnosticLogSettings = {
        enableFullTextQuery = "string"
      }
      disableKeyBasedMetadataWriteAccess = bool
      disableLocalAuth = bool
      enableAnalyticalStorage = bool
      enableAutomaticFailover = bool
      enableBurstCapacity = bool
      enableCassandraConnector = bool
      enableFreeTier = bool
      enableMaterializedViews = bool
      enableMultipleWriteLocations = bool
      enablePartitionMerge = bool
      enablePriorityBasedExecution = 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 = "PointInTime"
        restoreSource = "string"
        restoreTimestampInUtc = "string"
        sourceBackupLocation = "string"
        tablesToRestore = [
          "string"
        ]
      }
      virtualNetworkRules = [
        {
          id = "string"
          ignoreMissingVNetServiceEndpoint = bool
        }
      ]
    }
    kind = "string"
  })
}

BackupPolicy オブジェクト

type プロパティを設定して、オブジェクトの種類を指定します。

[継続的] には、次の値を使用します。

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

定期的な場合は、次の値を使用します。

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

プロパティ値

databaseAccounts

名前 説明 値
type リソースの種類 "Microsoft.DocumentDB/databaseAccounts@2023-09-15-preview"
name リソース名 string (必須)

文字数制限: 3 から 44

有効な文字:
小文字、数字、およびハイフン。

先頭には小文字または数字を使用します。

リソース名は、Azure 全体で一意である必要があります。
location リソースが属しているリソース グループの場所。 string
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
tags タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 タグ名と値のディクショナリ。
kind データベース アカウントの種類を示します。 これは、データベース アカウントの作成時にのみ設定できます。 "GlobalDocumentDB"
"MongoDB"
"Parse"
identity リソースの ID。 ManagedServiceIdentity
properties Azure Cosmos DB データベース アカウントを作成および更新するためのプロパティ。 DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (必須)

ManagedServiceIdentity

名前 説明 値
type リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
identity_ids リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。 ユーザー ID ID の配列。

ManagedServiceIdentityUserAssignedIdentities

名前 説明 値
{カスタマイズされたプロパティ} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

名前 説明 値
analyticalStorageConfiguration 分析ストレージ固有のプロパティ。 AnalyticalStorageConfiguration
apiProperties API 固有のプロパティ。 現在、MongoDB API でのみサポートされています。 ApiProperties
backupPolicy アカウントでバックアップを作成するためのポリシーを表す オブジェクト。 BackupPolicy
capabilities アカウントの Cosmos DB 機能の一覧 Capability[]
capacity アカウントの容量の適用に関連するすべてのプロパティを表す オブジェクト。 [容量]
connectorOffer Cosmos DB データベース C* アカウントの cassandra コネクタ オファーの種類。 "Small"
consistencyPolicy Cosmos DB アカウントの整合性ポリシー。 ConsistencyPolicy
cors Cosmos DB データベース アカウントの CORS ポリシー。 CorsPolicy[]
createMode アカウントの作成モードを示す列挙型。 "Default"
"PointInTimeRestore"
"復元"
customerManagedKeyStatus アカウントのカスタマー マネージド キー機能の状態を示します。 エラーが発生した場合、プロパティはトラブルシューティング ガイダンスを提供します。 "構成済みのカスタマー マネージド キーへのアクセスが確認されました。
"Azure Cosmos DB アカウントには未定義の既定の ID があるため、アカウントへのアクセスは現在取り消されています。このエラーの詳細とアカウントへのアクセスを復元する方法の詳細については、(4015) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#invalid-azure-cosmos-db-default-identity してください。
"Azure Cosmos DB アカウントのキー コンテナー キー URI が想定される形式に従っていないため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4006) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#improper-syntax-detected-on-the-key-vault-uri-property してください。
"Azure Cosmos DB サービスがアカウントの既定の ID の AAD 認証トークンを取得できないため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4000) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-active-directory-token-acquisition-error してください。
"Azure Cosmos DB サービスがキーをラップまたはラップ解除できないため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4005) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#internal-unwrapping-procedure-error してください。
"アカウントで指定された Azure Key Vault DNS 名"の keyvaultkeyuri プロパティを解決できなかったため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4009) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#unable-to-resolve-the-key-vaults-dns してください。
"アクセス規則によって Azure Key Vault サービスへの送信要求がブロックされているため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4016) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide してください。
"対応する Azure Key Vault が見つからなかったため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4017) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found してください。
"指定した Key Vault で対応するキーが見つからないため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4003) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found してください。
"現在の既定の ID に関連付けられている Key Vault キーへのアクセス許可がなくなったため、アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、(4002) を参照 https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#default-identity-is-unauthorized-to-access-the-azure-key-vault-key してください。
"アカウントへのアクセスは現在取り消されています。このエラーとアカウントへのアクセスを復元する方法の詳細については、 にアクセス https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guideしてください。
databaseAccountOfferType データベースのオファーの種類 "Standard" (必須)
defaultIdentity カスタマー マネージド キーなどの機能で使用されるキー コンテナーにアクセスするための既定の ID。 既定の ID は、ユーザーが明示的に設定する必要があります。 "FirstPartyIdentity"、"SystemAssignedIdentity" などを指定できます。 string
defaultPriorityLevel 優先度ベースの実行の要求の既定の優先度レベルを示す列挙型。 "High"
"Low"
diagnosticLogSettings Cosmos DB アカウントのさまざまな診断ログ設定を表す オブジェクト。 DiagnosticLogSettings
disableKeyBasedMetadataWriteAccess アカウント キーを使用してメタデータ リソース (データベース、コンテナー、スループット) に対する書き込み操作を無効にする [bool]
disableLocalAuth ローカル認証をオプトアウトし、MSI と AAD のみを認証専用に使用できることを確認します。 [bool]
enableAnalyticalStorage ストレージ分析を有効にするかどうかを示すフラグ。 [bool]
enableAutomaticFailover 障害が原因でリージョンが使用できないまれな場合に、書き込みリージョンの自動フェールオーバーを有効にします。 自動フェールオーバーでは、アカウントの新しい書き込みリージョンが作成され、アカウント用に構成されたフェールオーバーの優先順位に基づいて選択されます。 [bool]
enableBurstCapacity アカウントでバースト容量プレビュー機能を有効または無効にすることを示すフラグ [bool]
enableCassandraConnector Cosmos DB C* アカウントで cassandra コネクタを有効にします [bool]
enableFreeTier Free レベルが有効かどうかを示すフラグ。 [bool]
enableMaterializedViews Cosmos DB アカウントで MaterializedViews を有効にするかどうかを示すフラグ [bool]
enableMultipleWriteLocations アカウントを複数の場所に書き込むことができます [bool]
enablePartitionMerge アカウントでのパーティション マージ機能の有効化/無効化を示すフラグ [bool]
enablePriorityBasedExecution アカウントでの優先度ベースの実行プレビュー機能の有効化/無効化を示すフラグ [bool]
ipRules IpRules の一覧。 IpAddressOrRange[]
isVirtualNetworkFilterEnabled 仮想ネットワーク ACL 規則を有効または無効にするかどうかを示すフラグ。 [bool]
keyVaultKeyUri キー コンテナーの URI string
locations Cosmos DB アカウントで有効になっている georeplication の場所を含む配列。 Location[] (必須)
minimalTlsVersion 許可されている Tls の最小バージョンを示します。 Tls 1.2 でのみ動作する Cassandra と Mongo API を除き、既定値は Tls 1.0 です。 "Tls"
"Tls11"
"Tls12"
networkAclBypass ファイアウォール チェックをバイパスできるサービスを示します。 "AzureServices"
"None"
networkAclBypassResourceIds Cosmos DB アカウントのネットワーク ACL バイパスのリソース ID を含む配列。 string[]
publicNetworkAccess パブリック ネットワークからの要求を許可するかどうか "無効"
"有効"
"SecuredByPerimeter"
restoreParameters 復元に関する情報を示すパラメーター。 RestoreParameters
virtualNetworkRules Cosmos DB アカウント用に構成された仮想ネットワーク ACL 規則の一覧。 VirtualNetworkRule[]

AnalyticalStorageConfiguration

名前 説明 値
schemaType 分析ストレージのスキーマの種類について説明します。 "FullFidelity"
"WellDefined"

ApiProperties

名前 説明 値
serverVersion MongoDB アカウントの ServerVersion について説明します。 "3.2"
"3.6"
"4.0"
"4.2"

BackupPolicy

名前 説明 値
migrationState バックアップ ポリシー間の移行の状態を表す オブジェクト。 BackupPolicyMigrationState
型 オブジェクトの種類を設定する 継続的
定期的 (必須)

BackupPolicyMigrationState

名前 説明 値
startTime バックアップ ポリシーの移行が開始された時刻 (ISO-8601 形式)。 string
status バックアップ ポリシーの種類間の移行の状態について説明します。 "完了"
"Failed"
"InProgress"
"無効"
targetType バックアップ ポリシー移行のターゲット バックアップ ポリシーの種類について説明します。 "Continuous"
"Periodic"

ContinuousModeBackupPolicy

名前 説明 値
type バックアップのモードについて説明します。 "Continuous" (必須)
continuousModeProperties 連続モード バックアップの構成値 ContinuousModeProperties

ContinuousModeProperties

名前 説明 値
レベル Continuos バックアップ モードの種類を示す列挙型 "Continuous30Days"
"Continuous7Days"

PeriodicModeBackupPolicy

名前 説明 値
type バックアップのモードについて説明します。 "Periodic" (必須)
periodicModeProperties 定期モード バックアップの構成値 PeriodicModeProperties

PeriodicModeProperties

名前 説明 値
backupIntervalInMinutes 2 つのバックアップ間の間隔を分単位で表す整数 INT

制約:
最小値 = 0
backupRetentionIntervalInHours 各バックアップが保持される時間 (時間単位) を表す整数 INT

制約:
最小値 = 0
backupStorageRedundancy バックアップの保存場所の種類を示す列挙型 "Geo"
"Local"
"Zone"

機能

名前 説明 値
name Cosmos DB 機能の名前。 たとえば、"name": "EnableCassandra" です。 現在の値には、"EnableTable" と "EnableGremlin" も含まれます。 string

容量

名前 説明 値
totalThroughputLimit アカウントに課される合計スループット制限。 totalThroughputLimit が 2000 の場合、そのアカウントでプロビジョニングできる最大スループットの厳密な制限は 2000 になります。 totalThroughputLimit の -1 は、スループットのプロビジョニングに制限がないことを示します。 INT

ConsistencyPolicy

名前 説明 値
defaultConsistencyLevel Cosmos DB アカウントの既定の整合性レベルと構成設定。 "BoundedStaleness"
"ConsistentPrefix"
"Eventual"
"セッション"
"Strong" (必須)
maxIntervalInSeconds 有界整合性整合性レベルで使用する場合、この値は許容される制約の時間 (秒単位) を表します。 この値の許容範囲は 5 ~ 86400 です。 defaultConsistencyPolicy が 'BoundedStaleness' に設定されている場合に必要です。 INT

制約:
最小値 = 5
最大値 = 86400
maxStalenessPrefix 有界整合性整合性レベルで使用する場合、この値は許容される古い要求の数を表します。 この値の許容範囲は、1 ～ 2,147,483,647 です。 defaultConsistencyPolicy が 'BoundedStaleness' に設定されている場合に必要です。 INT

制約:
最小値 = 1
最大値 = 2147483647

CorsPolicy

名前 説明 値
allowedHeaders 元のドメインが CORS 要求に指定できる要求ヘッダー。 string
allowedMethods 元のドメインが CORS 要求で使用できるメソッド (HTTP 要求の動詞)。 string
allowedOrigins CORS 経由でサービスに対して要求を行うことができます。 string (必須)
exposedHeaders CORS 要求への応答で送信され、ブラウザーが要求の発行元に公開できる応答ヘッダー。 string
maxAgeInSeconds ブラウザーがプレフライト OPTIONS 要求をキャッシュする最大時間。 INT

制約:
最小値 = 1
最大値 = 2147483647

DiagnosticLogSettings

名前 説明 値
enableFullTextQuery クエリをログに記録する詳細レベルについて説明します。 "False"
"None"
"True"

IpAddressOrRange

名前 説明 値
ipAddressOrRange CIDR 形式の単一の IPv4 アドレスまたは単一の IPv4 アドレス範囲。 IP は適切な形式である必要があり、10.0.0.0/8、100.64.0.0/10、172.16.0.0/12、192.168.0.0/16 のいずれかの範囲に含めることはできません。これらは IP アドレス フィルターによって適用できないためです。 有効な入力の例: "23.40.210.245" または "23.40.210.0/8" string

場所

名前 説明 値
failoverPriority リージョンのフェールオーバー優先度。 フェールオーバーの優先度が 0 の場合は、書き込みリージョンを示します。 フェールオーバー優先度の最大値 = (リージョンの合計数 - 1)。 フェールオーバー優先度の値は、データベース アカウントが存在するリージョンごとに一意である必要があります。 INT

制約:
最小値 = 0
isZoneRedundant このリージョンが AvailabilityZone リージョンであるかどうかを示すフラグ [bool]
locationName 領域の名前。 string

RestoreParameters

名前 説明 値
databasesToRestore 復元に使用できる特定のデータベースの一覧。 DatabaseRestoreResource[]
gremlinDatabasesToRestore 復元に使用できる特定の gremlin データベースの一覧。 GremlinDatabaseRestoreResource[]
restoreMode 復元のモードについて説明します。 "PointInTime"
restoreSource 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc アカウントを復元する必要がある時間 (ISO-8601 形式)。 string
sourceBackupLocation 復元のソース バックアップの場所。 string
tablesToRestore 復元に使用できる特定のテーブルの一覧。 string[]

DatabaseRestoreResource

名前 説明 値
collectionNames 復元に使用できるコレクションの名前。 string[]
databaseName 復元に使用できるデータベースの名前。 string

GremlinDatabaseRestoreResource

名前 説明 値
databaseName 復元に使用できる gremlin データベースの名前。 string
graphNames 復元に使用できるグラフの名前。 string[]

VirtualNetworkRule

名前 説明 値
id サブネットのリソース ID (例: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName})。 string
ignoreMissingVNetServiceEndpoint 仮想ネットワークで vnet サービス エンドポイントが有効になる前に、ファイアウォール規則を作成します。 [bool]