Microsoft.DocumentDB databaseAccounts
- 最新の を
する - 2024-12-01-preview
- 2024-11-15
- 2024-09-01-preview
- 2024-08-15
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 2021-01-15
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
- 2016-03-31
- 2016-03-19
- 2015-11-06
- 2015-04-08
- 2015-04-01
Bicep リソース定義
databaseAccounts リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.DocumentDB/databaseAccounts リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2024-12-01-preview' = {
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
}
capacityMode: 'string'
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'
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
enablePerRegionPerPartitionAutoscale: 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: 'string'
restoreSource: 'string'
restoreTimestampInUtc: 'string'
restoreWithTtlDisabled: bool
sourceBackupLocation: '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'
}
プロパティ値
AnalyticalStorageConfiguration
| 名前 | 形容 | 価値 |
|---|---|---|
| schemaType | 分析ストレージのスキーマの種類について説明します。 | 'FullFidelity' 'WellDefined' |
ApiProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| serverVersion | MongoDB アカウントのバージョンについて説明します。 | '3.2' '3.6' '4.0' '4.2' '5.0' '6.0' '7.0' |
BackupPolicy
| 名前 | 形容 | 価値 |
|---|---|---|
| migrationState | バックアップ ポリシー間の移行の状態を表すオブジェクト。 | BackupPolicyMigrationState |
| 種類 | ContinuousModeBackupPolicy型 |
'Continuous' 'Periodic' (必須) |
BackupPolicyMigrationState
| 名前 | 形容 | 価値 |
|---|---|---|
| startTime | バックアップ ポリシーの移行が開始された時刻 (ISO-8601 形式)。 | 糸 |
| 地位 | バックアップ ポリシーの種類間の移行の状態について説明します。 | 'Completed' 'Failed' 'InProgress' 'Invalid' |
| targetType | バックアップ ポリシー移行のターゲット バックアップ ポリシーの種類について説明します。 | 'Continuous' 'Periodic' |
力
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | Cosmos DB 機能の名前。 たとえば、"name": "EnableCassandra" です。 現在の値には、"EnableTable" と "EnableGremlin" も含まれます。 | 糸 |
能力
| 名前 | 形容 | 価値 |
|---|---|---|
| totalThroughputLimit | アカウントに課される合計スループット制限。 totalThroughputLimit が 2000 の場合、そのアカウントでプロビジョニングできる最大スループットの厳密な制限は 2000 になります。 totalThroughputLimit の -1 は、スループットのプロビジョニングに制限がないことを示します。 | int 制約： 最小値 = -1 |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| 名前 | 形容 | 価値 |
|---|
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 |
ContinuousModeBackupPolicy
| 名前 | 形容 | 価値 |
|---|---|---|
| continuousModeProperties | 連続モード バックアップの構成値 | ContinuousModeProperties の |
| 種類 | バックアップのモードについて説明します。 | 'Continuous' (必須) |
ContinuousModeProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 層 | Continuos バックアップ モードの種類を示す列挙型 | 'Continuous30Days' 'Continuous7Days' |
CorsPolicy
| 名前 | 形容 | 価値 |
|---|---|---|
| allowedHeaders | 配信元ドメインが CORS 要求で指定できる要求ヘッダー。 | 糸 |
| allowedMethods | 配信元ドメインが CORS 要求に使用できるメソッド (HTTP 要求動詞)。 | 糸 |
| allowedOrigins | CORS 経由でサービスに対して要求を行うことができます。 | string (必須) |
| exposedHeaders | CORS 要求への応答で送信され、ブラウザーによって要求発行者に公開される可能性がある応答ヘッダー。 | 糸 |
| maxAgeInSeconds | ブラウザーがプレフライト OPTIONS 要求をキャッシュする最大時間。 | int 制約： 最小値 = 1 最大値 = 2147483647 |
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| analyticalStorageConfiguration | 分析ストレージ固有のプロパティ。 | AnalyticalStorageConfiguration |
| apiProperties | API 固有のプロパティ。 現在、MongoDB API でのみサポートされています。 | ApiProperties |
| backupPolicy | アカウントでバックアップを作成するためのポリシーを表すオブジェクト。 | BackupPolicy |
| 資格 | アカウントの Cosmos DB 機能の一覧 | 機能[] |
| 能力 | アカウントの容量の適用に関連するすべてのプロパティを表すオブジェクト。 | 容量 の |
| capacityMode | Cosmos DB アカウントの capacityMode を示します。 | 'None' 'Provisioned' 'サーバーレス' |
| connectorOffer | Cosmos DB データベース C* アカウントの cassandra コネクタ オファーの種類。 | 'Small' |
| consistencyPolicy | Cosmos DB アカウントの整合性ポリシー。 | ConsistencyPolicy |
| cors | Cosmos DB データベース アカウントの CORS ポリシー。 | CorsPolicy[] |
| createMode | アカウント作成モードを示す列挙型。 | 'Default' 'Restore' |
| customerManagedKeyStatus | アカウントのカスタマー マネージド キー機能の状態を示します。 エラーが発生した場合、このプロパティはトラブルシューティング のガイダンスを提供します。 | 糸 |
| databaseAccountOfferType | データベースのオファーの種類 | 'Standard' (必須) |
| defaultIdentity | カスタマー マネージド キーなどの機能で使用されるキー コンテナーにアクセスするための既定の ID。 既定の ID は、ユーザーが明示的に設定する必要があります。 "FirstPartyIdentity"、"SystemAssignedIdentity" などを指定できます。 | 糸 |
| 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 |
| enablePerRegionPerPartitionAutoscale | アカウントでのパーティションごとの自動スケール プレビュー機能 Per-Region 有効または無効にすることを示すフラグ | bool |
| enablePriorityBasedExecution | アカウントでの優先度ベースの実行プレビュー機能の有効化/無効化を示すフラグ | bool |
| ipRules | IpRules の一覧。 | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | 仮想ネットワーク ACL 規則を有効または無効にするかどうかを示すフラグ。 | bool |
| keyVaultKeyUri | キー コンテナーの URI | 糸 |
| 場所 | Cosmos DB アカウントで有効になっている georeplication の場所を含む配列。 | Location[] (必須) |
| minimalTlsVersion | 許可される Tls の最小バージョンを示します。 既定は Tls 1.0 です。Cassandra と Mongo API は除き、Tls 1.2 でのみ機能します。 | 'Tls' 'Tls11' 'Tls12' |
| networkAclBypass | ファイアウォール チェックをバイパスできるサービスを示します。 | 'AzureServices' 'None' |
| networkAclBypassResourceIds | Cosmos DB アカウントのネットワーク ACL バイパスのリソース ID を含む配列。 | string[] |
| publicNetworkAccess | パブリック ネットワークからの要求が許可されるかどうか | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
| restoreParameters | 復元に関する情報を示すパラメーター。 | RestoreParameters |
| virtualNetworkRules | Cosmos DB アカウント用に構成された仮想ネットワーク ACL 規則の一覧。 | VirtualNetworkRule[] |
DatabaseRestoreResource
| 名前 | 形容 | 価値 |
|---|---|---|
| collectionNames | 復元に使用できるコレクションの名前。 | string[] |
| databaseName | 復元に使用できるデータベースの名前。 | 糸 |
DiagnosticLogSettings
| 名前 | 形容 | 価値 |
|---|---|---|
| enableFullTextQuery | クエリのログ記録に使用する詳細レベルについて説明します。 | 'False' 'None' 'True' |
GremlinDatabaseRestoreResource
| 名前 | 形容 | 価値 |
|---|---|---|
| databaseName | 復元に使用できる gremlin データベースの名前。 | 糸 |
| graphNames | 復元に使用できるグラフの名前。 | string[] |
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"。 | 糸 |
場所
| 名前 | 形容 | 価値 |
|---|---|---|
| failoverPriority | リージョンのフェールオーバーの優先順位。 フェールオーバーの優先度が 0 の場合は、書き込みリージョンを示します。 フェールオーバー優先度の最大値 = (リージョンの合計数 - 1)。 フェールオーバー優先度の値は、データベース アカウントが存在するリージョンごとに一意である必要があります。 | int 制約： 最小値 = 0 |
| isZoneRedundant | このリージョンが AvailabilityZone リージョンかどうかを示すフラグ | bool |
| locationName | リージョンの名前。 | 糸 |
ManagedServiceIdentity
| 名前 | 形容 | 価値 |
|---|---|---|
| 種類 | リソースに使用される 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
| 名前 | 形容 | 価値 |
|---|
Microsoft.DocumentDB/databaseAccounts
| 名前 | 形容 | 価値 |
|---|---|---|
| 同一性 | リソースの ID。 | ManagedServiceIdentity の |
| 種類 | データベース アカウントの種類を示します。 これは、データベース アカウントの作成時にのみ設定できます。 | 'GlobalDocumentDB' 'MongoDB' 'Parse' |
| 場所 | リソースが属するリソース グループの場所。 | 糸 |
| 名前 | リソース名 | 糸 制約： 最小長 = 3 最大長 = 3 パターン = ^[a-z0-9]+(-[a-z0-9]+)* (必須) |
| プロパティ | Azure Cosmos DB データベース アカウントを作成および更新するためのプロパティ。 | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (必須) |
| タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
PeriodicModeBackupPolicy
| 名前 | 形容 | 価値 |
|---|---|---|
| periodicModeProperties | 定期モード バックアップの構成値 | PeriodicModeProperties |
| 種類 | バックアップのモードについて説明します。 | 'Periodic' (必須) |
PeriodicModeProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| backupIntervalInMinutes | 2 つのバックアップ間の間隔を分単位で表す整数 | int 制約： 最小値 = 0 |
| backupRetentionIntervalInHours | 各バックアップが保持される時間 (時間単位) を表す整数 | int 制約： 最小値 = 0 |
| backupStorageRedundancy | バックアップの保存場所の種類を示す列挙型 | 'Geo' 'Local' 'Zone' |
RestoreParameters
| 名前 | 形容 | 価値 |
|---|---|---|
| databasesToRestore | 復元に使用できる特定のデータベースの一覧。 | DatabaseRestoreResource[] |
| gremlinDatabasesToRestore | 復元に使用できる特定の gremlin データベースの一覧。 | GremlinDatabaseRestoreResource[] |
| restoreMode | 復元のモードについて説明します。 | 'PointInTime' |
| restoreSource | 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | 糸 |
| restoreTimestampInUtc | アカウントを復元する必要がある時間 (ISO-8601 形式)。 | 糸 |
| restoreWithTtlDisabled | 復元が成功した時点で、復元されたアカウントに Time-To-Live を無効にするかどうかを指定します。 | bool |
| sourceBackupLocation | 復元のソース バックアップの場所。 | 糸 |
| tablesToRestore | 復元に使用できる特定のテーブルの一覧。 | string[] |
タグ
| 名前 | 形容 | 価値 |
|---|
VirtualNetworkRule
| 名前 | 形容 | 価値 |
|---|---|---|
| 身分証明書 | サブネットのリソース ID (例: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName})。 | 糸 |
| ignoreMissingVNetServiceEndpoint | 仮想ネットワークで vnet サービス エンドポイントが有効になる前に、ファイアウォール規則を作成します。 | bool |
クイック スタートのサンプル
次のクイック スタート サンプルでは、このリソースの種類をデプロイします。
| Bicep ファイル | 形容 |
|---|---|
| 分析ストア を使用して Azure Cosmos DB アカウント SQL API を |
このテンプレートは、分析ストアで構成されたデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。 |
| Web App を使用して Azure Cosmos DB アカウントを |
このテンプレートは、Azure Cosmos DB アカウントと App Service プランをデプロイし、App Service プランに Web アプリを作成します。 また、Azure Cosmos DB アカウント エンドポイントを参照する 2 つのアプリケーション設定を Web アプリに追加します。 このように、Web アプリにデプロイされたソリューションは、これらの設定を使用して Azure Cosmos DB アカウント エンドポイントに接続できます。 |
| Microsoft Defender が有効な を使用して Cosmos DB アカウントを作成する | この ARM テンプレートを使用すると、Microsoft Defender for Azure Cosmos DB が有効になっている Azure Cosmos DB アカウントをデプロイできます。 Microsoft Defender for Azure Cosmos DB は、Azure Cosmos DB アカウント内のデータベースを悪用しようとする試みを検出する、Azure ネイティブのセキュリティ レイヤーです。 Microsoft Defender for Azure Cosmos DB は、潜在的な SQL インジェクション、Microsoft 脅威インテリジェンスに基づく既知の悪意のあるアクター、疑わしいアクセス パターン、および侵害された ID または悪意のある内部関係者によるデータベースの潜在的な悪用を検出します。 |
| Free レベルの Azure Cosmos DB アカウント を作成する | このテンプレートは、共有スループットとコンテナーを持つデータベースを使用して、SQL API 用の Free レベルの Azure Cosmos DB アカウントを作成します。 |
| Core (SQL) API 用に最小限の Azure Cosmos DB アカウントを作成する | このテンプレートでは、必要最小限のリソース プロパティのみを指定しながら、コア (SQL) API 用の Azure Cosmos DB アカウントを作成します。 |
| SQL API 用のサーバーレス Azure Cosmos DB アカウントを作成する | このテンプレートは、Core (SQL) API 用のサーバーレス Azure Cosmos DB アカウントを作成します。 |
| ゼロ タッチの Azure Cosmos アカウントと Azure Web App を作成する | このテンプレートは、Azure Cosmos アカウントを作成し、Cosmos DB エンドポイントとキーを Azure Web App の設定に挿入してから、GitHub から ASP MVC Web アプリをデプロイします。 |
| MongoDB API 用の Azure Cosmos アカウントを作成する | このテンプレートでは、2 つのコレクションで共有スループットと専用スループットを使用して、MongoDB API 4.2 用の Azure Cosmos DB アカウントを 2 つのリージョンに作成します。 |
| MongoDB API 自動スケール 用の Azure Cosmos アカウントを作成する | このテンプレートでは、共有スループットと専用自動スケーリング スループットの両方を使用して、MongoDB API 4.2 用の Azure Cosmos DB アカウントを 2 つのリージョンに作成します。 |
| Table API 用の Azure Cosmos アカウントを作成する | このテンプレートでは、Table API 用の Azure Cosmos DB アカウントが 2 つのリージョンに作成され、スループットがプロビジョニングされた 1 つのテーブルが作成されます。 |
| 自動スケール を使用して Table API 用の Azure Cosmos アカウントを作成する | このテンプレートは、2 つのリージョンに Table API 用の Azure Cosmos DB アカウントを作成し、自動スケール スループットを持つ 1 つのテーブルを作成します。 |
| Cassandra API 用の Azure Cosmos DB アカウントを作成する | このテンプレートは、専用スループットのキースペースとテーブルを持つ 2 つのリージョンに Cassandra API 用の Azure Cosmos DB アカウントを作成します。 |
| Core (SQL) API 用の Azure Cosmos DB アカウントを作成する | このテンプレートでは、他の複数のオプションを含むスループットを持つデータベースとコンテナーを使用して、コア (SQL) API 用の Azure Cosmos アカウントを作成します。 |
| 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 アカウントを作成します。 |
| 複数のリージョンに 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 ID のネイティブに管理されるロールの割り当てが作成されます。 |
| Azure CosmosDB アカウント を作成 |
この ARM テンプレートは、最小限の必須値で CosmosDB アカウントをすばやく作成することを目的としています |
| Cassandra API の自動スケーリング Azure Cosmos DB アカウントを作成する | このテンプレートは、キースペースと自動スケール スループットを持つテーブルを持つ 2 つのリージョンに Cassandra API 用の Azure Cosmos DB アカウントを作成します。 |
| Azure Cosmos DB Core (SQL) API ストアド プロシージャを作成 | このテンプレートでは、Core (SQL) API 用の Azure Cosmos DB アカウントと、ストアド プロシージャ、トリガー、およびユーザー定義関数を含むコンテナーが作成されます。 |
| Container Apps を使用して Dapr マイクロサービス アプリを作成する | Container Apps を使用して Dapr マイクロサービス アプリを作成します。 |
| Container Apps を使用して Dapr pub-sub servicebus アプリを作成します | Container Apps を使用して Dapr pub-sub servicebus アプリを作成します。 |
| Cosmos DB 接続 を使用して Azure Data Explorer DB をデプロイする | Cosmos DB 接続を使用して Azure Data Explorer DB をデプロイします。 |
ARM テンプレート リソース定義
databaseAccounts リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.DocumentDB/databaseAccounts リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.DocumentDB/databaseAccounts",
"apiVersion": "2024-12-01-preview",
"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"
},
"capacityMode": "string",
"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",
"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",
"enablePerRegionPerPartitionAutoscale": "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": "string",
"restoreSource": "string",
"restoreTimestampInUtc": "string",
"restoreWithTtlDisabled": "bool",
"sourceBackupLocation": "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"
}
プロパティ値
AnalyticalStorageConfiguration
| 名前 | 形容 | 価値 |
|---|---|---|
| schemaType | 分析ストレージのスキーマの種類について説明します。 | 'FullFidelity' 'WellDefined' |
ApiProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| serverVersion | MongoDB アカウントのバージョンについて説明します。 | '3.2' '3.6' '4.0' '4.2' '5.0' '6.0' '7.0' |
BackupPolicy
| 名前 | 形容 | 価値 |
|---|---|---|
| migrationState | バックアップ ポリシー間の移行の状態を表すオブジェクト。 | BackupPolicyMigrationState |
| 種類 | ContinuousModeBackupPolicy型 |
'Continuous' 'Periodic' (必須) |
BackupPolicyMigrationState
| 名前 | 形容 | 価値 |
|---|---|---|
| startTime | バックアップ ポリシーの移行が開始された時刻 (ISO-8601 形式)。 | 糸 |
| 地位 | バックアップ ポリシーの種類間の移行の状態について説明します。 | 'Completed' 'Failed' 'InProgress' 'Invalid' |
| targetType | バックアップ ポリシー移行のターゲット バックアップ ポリシーの種類について説明します。 | 'Continuous' 'Periodic' |
力
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | Cosmos DB 機能の名前。 たとえば、"name": "EnableCassandra" です。 現在の値には、"EnableTable" と "EnableGremlin" も含まれます。 | 糸 |
能力
| 名前 | 形容 | 価値 |
|---|---|---|
| totalThroughputLimit | アカウントに課される合計スループット制限。 totalThroughputLimit が 2000 の場合、そのアカウントでプロビジョニングできる最大スループットの厳密な制限は 2000 になります。 totalThroughputLimit の -1 は、スループットのプロビジョニングに制限がないことを示します。 | int 制約： 最小値 = -1 |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| 名前 | 形容 | 価値 |
|---|
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 |
ContinuousModeBackupPolicy
| 名前 | 形容 | 価値 |
|---|---|---|
| continuousModeProperties | 連続モード バックアップの構成値 | ContinuousModeProperties の |
| 種類 | バックアップのモードについて説明します。 | 'Continuous' (必須) |
ContinuousModeProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 層 | Continuos バックアップ モードの種類を示す列挙型 | 'Continuous30Days' 'Continuous7Days' |
CorsPolicy
| 名前 | 形容 | 価値 |
|---|---|---|
| allowedHeaders | 配信元ドメインが CORS 要求で指定できる要求ヘッダー。 | 糸 |
| allowedMethods | 配信元ドメインが CORS 要求に使用できるメソッド (HTTP 要求動詞)。 | 糸 |
| allowedOrigins | CORS 経由でサービスに対して要求を行うことができます。 | string (必須) |
| exposedHeaders | CORS 要求への応答で送信され、ブラウザーによって要求発行者に公開される可能性がある応答ヘッダー。 | 糸 |
| maxAgeInSeconds | ブラウザーがプレフライト OPTIONS 要求をキャッシュする最大時間。 | int 制約： 最小値 = 1 最大値 = 2147483647 |
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| analyticalStorageConfiguration | 分析ストレージ固有のプロパティ。 | AnalyticalStorageConfiguration |
| apiProperties | API 固有のプロパティ。 現在、MongoDB API でのみサポートされています。 | ApiProperties |
| backupPolicy | アカウントでバックアップを作成するためのポリシーを表すオブジェクト。 | BackupPolicy |
| 資格 | アカウントの Cosmos DB 機能の一覧 | 機能[] |
| 能力 | アカウントの容量の適用に関連するすべてのプロパティを表すオブジェクト。 | 容量 の |
| capacityMode | Cosmos DB アカウントの capacityMode を示します。 | 'None' 'Provisioned' 'サーバーレス' |
| connectorOffer | Cosmos DB データベース C* アカウントの cassandra コネクタ オファーの種類。 | 'Small' |
| consistencyPolicy | Cosmos DB アカウントの整合性ポリシー。 | ConsistencyPolicy |
| cors | Cosmos DB データベース アカウントの CORS ポリシー。 | CorsPolicy[] |
| createMode | アカウント作成モードを示す列挙型。 | 'Default' 'Restore' |
| customerManagedKeyStatus | アカウントのカスタマー マネージド キー機能の状態を示します。 エラーが発生した場合、このプロパティはトラブルシューティング のガイダンスを提供します。 | 糸 |
| databaseAccountOfferType | データベースのオファーの種類 | 'Standard' (必須) |
| defaultIdentity | カスタマー マネージド キーなどの機能で使用されるキー コンテナーにアクセスするための既定の ID。 既定の ID は、ユーザーが明示的に設定する必要があります。 "FirstPartyIdentity"、"SystemAssignedIdentity" などを指定できます。 | 糸 |
| 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 |
| enablePerRegionPerPartitionAutoscale | アカウントでのパーティションごとの自動スケール プレビュー機能 Per-Region 有効または無効にすることを示すフラグ | bool |
| enablePriorityBasedExecution | アカウントでの優先度ベースの実行プレビュー機能の有効化/無効化を示すフラグ | bool |
| ipRules | IpRules の一覧。 | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | 仮想ネットワーク ACL 規則を有効または無効にするかどうかを示すフラグ。 | bool |
| keyVaultKeyUri | キー コンテナーの URI | 糸 |
| 場所 | Cosmos DB アカウントで有効になっている georeplication の場所を含む配列。 | Location[] (必須) |
| minimalTlsVersion | 許可される Tls の最小バージョンを示します。 既定は Tls 1.0 です。Cassandra と Mongo API は除き、Tls 1.2 でのみ機能します。 | 'Tls' 'Tls11' 'Tls12' |
| networkAclBypass | ファイアウォール チェックをバイパスできるサービスを示します。 | 'AzureServices' 'None' |
| networkAclBypassResourceIds | Cosmos DB アカウントのネットワーク ACL バイパスのリソース ID を含む配列。 | string[] |
| publicNetworkAccess | パブリック ネットワークからの要求が許可されるかどうか | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
| restoreParameters | 復元に関する情報を示すパラメーター。 | RestoreParameters |
| virtualNetworkRules | Cosmos DB アカウント用に構成された仮想ネットワーク ACL 規則の一覧。 | VirtualNetworkRule[] |
DatabaseRestoreResource
| 名前 | 形容 | 価値 |
|---|---|---|
| collectionNames | 復元に使用できるコレクションの名前。 | string[] |
| databaseName | 復元に使用できるデータベースの名前。 | 糸 |
DiagnosticLogSettings
| 名前 | 形容 | 価値 |
|---|---|---|
| enableFullTextQuery | クエリのログ記録に使用する詳細レベルについて説明します。 | 'False' 'None' 'True' |
GremlinDatabaseRestoreResource
| 名前 | 形容 | 価値 |
|---|---|---|
| databaseName | 復元に使用できる gremlin データベースの名前。 | 糸 |
| graphNames | 復元に使用できるグラフの名前。 | string[] |
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"。 | 糸 |
場所
| 名前 | 形容 | 価値 |
|---|---|---|
| failoverPriority | リージョンのフェールオーバーの優先順位。 フェールオーバーの優先度が 0 の場合は、書き込みリージョンを示します。 フェールオーバー優先度の最大値 = (リージョンの合計数 - 1)。 フェールオーバー優先度の値は、データベース アカウントが存在するリージョンごとに一意である必要があります。 | int 制約： 最小値 = 0 |
| isZoneRedundant | このリージョンが AvailabilityZone リージョンかどうかを示すフラグ | bool |
| locationName | リージョンの名前。 | 糸 |
ManagedServiceIdentity
| 名前 | 形容 | 価値 |
|---|---|---|
| 種類 | リソースに使用される 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
| 名前 | 形容 | 価値 |
|---|
Microsoft.DocumentDB/databaseAccounts
| 名前 | 形容 | 価値 |
|---|---|---|
| apiVersion | API のバージョン | '2024-12-01-preview' |
| 同一性 | リソースの ID。 | ManagedServiceIdentity の |
| 種類 | データベース アカウントの種類を示します。 これは、データベース アカウントの作成時にのみ設定できます。 | 'GlobalDocumentDB' 'MongoDB' 'Parse' |
| 場所 | リソースが属するリソース グループの場所。 | 糸 |
| 名前 | リソース名 | 糸 制約： 最小長 = 3 最大長 = 3 パターン = ^[a-z0-9]+(-[a-z0-9]+)* (必須) |
| プロパティ | Azure Cosmos DB データベース アカウントを作成および更新するためのプロパティ。 | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (必須) |
| タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
| 種類 | リソースの種類 | 'Microsoft.DocumentDB/databaseAccounts' |
PeriodicModeBackupPolicy
| 名前 | 形容 | 価値 |
|---|---|---|
| periodicModeProperties | 定期モード バックアップの構成値 | PeriodicModeProperties |
| 種類 | バックアップのモードについて説明します。 | 'Periodic' (必須) |
PeriodicModeProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| backupIntervalInMinutes | 2 つのバックアップ間の間隔を分単位で表す整数 | int 制約： 最小値 = 0 |
| backupRetentionIntervalInHours | 各バックアップが保持される時間 (時間単位) を表す整数 | int 制約： 最小値 = 0 |
| backupStorageRedundancy | バックアップの保存場所の種類を示す列挙型 | 'Geo' 'Local' 'Zone' |
RestoreParameters
| 名前 | 形容 | 価値 |
|---|---|---|
| databasesToRestore | 復元に使用できる特定のデータベースの一覧。 | DatabaseRestoreResource[] |
| gremlinDatabasesToRestore | 復元に使用できる特定の gremlin データベースの一覧。 | GremlinDatabaseRestoreResource[] |
| restoreMode | 復元のモードについて説明します。 | 'PointInTime' |
| restoreSource | 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | 糸 |
| restoreTimestampInUtc | アカウントを復元する必要がある時間 (ISO-8601 形式)。 | 糸 |
| restoreWithTtlDisabled | 復元が成功した時点で、復元されたアカウントに Time-To-Live を無効にするかどうかを指定します。 | bool |
| sourceBackupLocation | 復元のソース バックアップの場所。 | 糸 |
| tablesToRestore | 復元に使用できる特定のテーブルの一覧。 | string[] |
タグ
| 名前 | 形容 | 価値 |
|---|
VirtualNetworkRule
| 名前 | 形容 | 価値 |
|---|---|---|
| 身分証明書 | サブネットのリソース ID (例: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName})。 | 糸 |
| ignoreMissingVNetServiceEndpoint | 仮想ネットワークで vnet サービス エンドポイントが有効になる前に、ファイアウォール規則を作成します。 | bool |
クイック スタート テンプレート
次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。
| テンプレート | 形容 |
|---|---|
| 分析ストア を使用して Azure Cosmos DB アカウント SQL API を Azure |
このテンプレートは、分析ストアで構成されたデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。 |
| Web App を使用して Azure Cosmos DB アカウントを Azure |
このテンプレートは、Azure Cosmos DB アカウントと App Service プランをデプロイし、App Service プランに Web アプリを作成します。 また、Azure Cosmos DB アカウント エンドポイントを参照する 2 つのアプリケーション設定を Web アプリに追加します。 このように、Web アプリにデプロイされたソリューションは、これらの設定を使用して Azure Cosmos DB アカウント エンドポイントに接続できます。 |
| Azure Container Service (AKS) で Jenkins を使用して CI/CD を Azure |
コンテナーを使用すると、アプリケーションを継続的にビルドしてデプロイすることが非常に簡単になります。 Azure Container Service で Kubernetes を使用してこれらのコンテナーのデプロイを調整することで、コンテナーのレプリケート可能で管理しやすいクラスターを実現できます。 コンテナー イメージとオーケストレーションを生成するように継続的ビルドを設定することで、デプロイの速度と信頼性を向上させることができます。 |
|
Microsoft Defender が有効な を使用して Cosmos DB アカウントを作成する Azure にデプロイする |
この ARM テンプレートを使用すると、Microsoft Defender for Azure Cosmos DB が有効になっている Azure Cosmos DB アカウントをデプロイできます。 Microsoft Defender for Azure Cosmos DB は、Azure Cosmos DB アカウント内のデータベースを悪用しようとする試みを検出する、Azure ネイティブのセキュリティ レイヤーです。 Microsoft Defender for Azure Cosmos DB は、潜在的な SQL インジェクション、Microsoft 脅威インテリジェンスに基づく既知の悪意のあるアクター、疑わしいアクセス パターン、および侵害された ID または悪意のある内部関係者によるデータベースの潜在的な悪用を検出します。 |
|
Free レベルの Azure Cosmos DB アカウント を作成する Azure にデプロイする |
このテンプレートは、共有スループットとコンテナーを持つデータベースを使用して、SQL API 用の Free レベルの Azure Cosmos DB アカウントを作成します。 |
|
Core (SQL) API 用に最小限の Azure Cosmos DB アカウントを作成する Azure にデプロイする |
このテンプレートでは、必要最小限のリソース プロパティのみを指定しながら、コア (SQL) API 用の Azure Cosmos DB アカウントを作成します。 |
|
SQL API 用のサーバーレス Azure Cosmos DB アカウントを作成する Azure にデプロイする |
このテンプレートは、Core (SQL) API 用のサーバーレス Azure Cosmos DB アカウントを作成します。 |
|
ゼロ タッチの Azure Cosmos アカウントと Azure Web App を作成する Azure にデプロイする |
このテンプレートは、Azure Cosmos アカウントを作成し、Cosmos DB エンドポイントとキーを Azure Web App の設定に挿入してから、GitHub から ASP MVC Web アプリをデプロイします。 |
|
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 つのリージョンに作成します。 |
|
Table API 用の Azure Cosmos アカウントを作成する Azure にデプロイする |
このテンプレートでは、Table API 用の Azure Cosmos DB アカウントが 2 つのリージョンに作成され、スループットがプロビジョニングされた 1 つのテーブルが作成されます。 |
|
自動スケール を使用して Table API 用の Azure Cosmos アカウントを作成する Azure にデプロイする |
このテンプレートは、2 つのリージョンに Table API 用の Azure Cosmos DB アカウントを作成し、自動スケール スループットを持つ 1 つのテーブルを作成します。 |
|
Cassandra API 用の Azure Cosmos DB アカウントを作成する Azure にデプロイする |
このテンプレートは、専用スループットのキースペースとテーブルを持つ 2 つのリージョンに Cassandra API 用の Azure Cosmos DB アカウントを作成します。 |
|
Core (SQL) API 用の Azure Cosmos DB アカウントを作成する Azure にデプロイする |
このテンプレートでは、他の複数のオプションを含むスループットを持つデータベースとコンテナーを使用して、コア (SQL) API 用の Azure Cosmos アカウントを作成します。 |
|
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 アカウントを作成します。 |
|
複数のリージョンに Azure Cosmos DB アカウントを作成 Azure にデプロイする |
このテンプレートでは、整合性レベルとフェールオーバーの種類を選択して、プライマリ リージョンとセカンダリ リージョンを使用して、任意のデータベース API の種類に対して Azure Cosmos DB アカウントを作成します。 |
|
自動スケール を使用して Azure Cosmos DB アカウント SQL API を作成する Azure にデプロイする |
このテンプレートでは、他の複数のオプションを使用して、自動スケーリング スループットを使用するデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。 |
|
プライベート エンドポイント を使用して Azure Cosmos DB アカウントを作成する Azure にデプロイする |
このテンプレートでは、Cosmos アカウント、仮想ネットワーク、および仮想ネットワークに Cosmos アカウントを公開するプライベート エンドポイントが作成されます。 |
|
データ プレーン RBAC を使用して Azure Cosmos DB SQL アカウントを作成する Azure にデプロイする |
このテンプレートでは、SQL Cosmos アカウント、ネイティブに管理されるロール定義、および AAD ID のネイティブに管理されるロールの割り当てが作成されます。 |
| Azure CosmosDB アカウント を作成 Azure |
この ARM テンプレートは、最小限の必須値で CosmosDB アカウントをすばやく作成することを目的としています |
|
Cassandra API の自動スケーリング Azure Cosmos DB アカウントを作成する Azure にデプロイする |
このテンプレートは、キースペースと自動スケール スループットを持つテーブルを持つ 2 つのリージョンに Cassandra API 用の Azure Cosmos DB アカウントを作成します。 |
|
Azure Cosmos DB Core (SQL) API ストアド プロシージャを作成 Azure にデプロイする |
このテンプレートでは、Core (SQL) API 用の Azure Cosmos DB アカウントと、ストアド プロシージャ、トリガー、およびユーザー定義関数を含むコンテナーが作成されます。 |
|
SQL API と複数のコンテナーを使用して Azure Cosmos を作成 Azure にデプロイする |
このテンプレートでは、SQL API を使用して Cosmos コンテナーを作成し、複数のコンテナーを追加できます。 |
|
Container Apps を使用して Dapr マイクロサービス アプリを作成する Azure にデプロイする |
Container Apps を使用して Dapr マイクロサービス アプリを作成します。 |
|
Container Apps を使用して Dapr pub-sub servicebus アプリを作成します Azure にデプロイする |
Container Apps を使用して Dapr pub-sub servicebus アプリを作成します。 |
|
Cosmos DB 接続 を使用して Azure Data Explorer DB をデプロイする Azure にデプロイする |
Cosmos DB 接続を使用して Azure Data Explorer DB をデプロイします。 |
| SQL Database、Azure Cosmos DB、Azure Search を使用した Web アプリの Azure |
このテンプレートは、Web アプリ、SQL Database、Azure Cosmos DB、Azure Search、Application Insights をプロビジョニングします。 |
Terraform (AzAPI プロバイダー) リソース定義
databaseAccounts リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループの
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.DocumentDB/databaseAccounts リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts@2024-12-01-preview"
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
}
capacityMode = "string"
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"
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
enablePerRegionPerPartitionAutoscale = 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 = "string"
restoreSource = "string"
restoreTimestampInUtc = "string"
restoreWithTtlDisabled = bool
sourceBackupLocation = "string"
tablesToRestore = [
"string"
]
}
virtualNetworkRules = [
{
id = "string"
ignoreMissingVNetServiceEndpoint = bool
}
]
}
})
}
BackupPolicy オブジェクト
型 プロパティを設定して、オブジェクトの型を指定します。
連続 の場合は、次の値を使用します。
{
continuousModeProperties = {
tier = "string"
}
type = "Continuous"
}
定期的な
{
periodicModeProperties = {
backupIntervalInMinutes = int
backupRetentionIntervalInHours = int
backupStorageRedundancy = "string"
}
type = "Periodic"
}
プロパティ値
AnalyticalStorageConfiguration
| 名前 | 形容 | 価値 |
|---|---|---|
| schemaType | 分析ストレージのスキーマの種類について説明します。 | 'FullFidelity' 'WellDefined' |
ApiProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| serverVersion | MongoDB アカウントのバージョンについて説明します。 | '3.2' '3.6' '4.0' '4.2' '5.0' '6.0' '7.0' |
BackupPolicy
| 名前 | 形容 | 価値 |
|---|---|---|
| migrationState | バックアップ ポリシー間の移行の状態を表すオブジェクト。 | BackupPolicyMigrationState |
| 種類 | ContinuousModeBackupPolicy型 |
'Continuous' 'Periodic' (必須) |
BackupPolicyMigrationState
| 名前 | 形容 | 価値 |
|---|---|---|
| startTime | バックアップ ポリシーの移行が開始された時刻 (ISO-8601 形式)。 | 糸 |
| 地位 | バックアップ ポリシーの種類間の移行の状態について説明します。 | 'Completed' 'Failed' 'InProgress' 'Invalid' |
| targetType | バックアップ ポリシー移行のターゲット バックアップ ポリシーの種類について説明します。 | 'Continuous' 'Periodic' |
力
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | Cosmos DB 機能の名前。 たとえば、"name": "EnableCassandra" です。 現在の値には、"EnableTable" と "EnableGremlin" も含まれます。 | 糸 |
能力
| 名前 | 形容 | 価値 |
|---|---|---|
| totalThroughputLimit | アカウントに課される合計スループット制限。 totalThroughputLimit が 2000 の場合、そのアカウントでプロビジョニングできる最大スループットの厳密な制限は 2000 になります。 totalThroughputLimit の -1 は、スループットのプロビジョニングに制限がないことを示します。 | int 制約： 最小値 = -1 |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| 名前 | 形容 | 価値 |
|---|
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 |
ContinuousModeBackupPolicy
| 名前 | 形容 | 価値 |
|---|---|---|
| continuousModeProperties | 連続モード バックアップの構成値 | ContinuousModeProperties の |
| 種類 | バックアップのモードについて説明します。 | 'Continuous' (必須) |
ContinuousModeProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 層 | Continuos バックアップ モードの種類を示す列挙型 | 'Continuous30Days' 'Continuous7Days' |
CorsPolicy
| 名前 | 形容 | 価値 |
|---|---|---|
| allowedHeaders | 配信元ドメインが CORS 要求で指定できる要求ヘッダー。 | 糸 |
| allowedMethods | 配信元ドメインが CORS 要求に使用できるメソッド (HTTP 要求動詞)。 | 糸 |
| allowedOrigins | CORS 経由でサービスに対して要求を行うことができます。 | string (必須) |
| exposedHeaders | CORS 要求への応答で送信され、ブラウザーによって要求発行者に公開される可能性がある応答ヘッダー。 | 糸 |
| maxAgeInSeconds | ブラウザーがプレフライト OPTIONS 要求をキャッシュする最大時間。 | int 制約： 最小値 = 1 最大値 = 2147483647 |
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| analyticalStorageConfiguration | 分析ストレージ固有のプロパティ。 | AnalyticalStorageConfiguration |
| apiProperties | API 固有のプロパティ。 現在、MongoDB API でのみサポートされています。 | ApiProperties |
| backupPolicy | アカウントでバックアップを作成するためのポリシーを表すオブジェクト。 | BackupPolicy |
| 資格 | アカウントの Cosmos DB 機能の一覧 | 機能[] |
| 能力 | アカウントの容量の適用に関連するすべてのプロパティを表すオブジェクト。 | 容量 の |
| capacityMode | Cosmos DB アカウントの capacityMode を示します。 | 'None' 'Provisioned' 'サーバーレス' |
| connectorOffer | Cosmos DB データベース C* アカウントの cassandra コネクタ オファーの種類。 | 'Small' |
| consistencyPolicy | Cosmos DB アカウントの整合性ポリシー。 | ConsistencyPolicy |
| cors | Cosmos DB データベース アカウントの CORS ポリシー。 | CorsPolicy[] |
| createMode | アカウント作成モードを示す列挙型。 | 'Default' 'Restore' |
| customerManagedKeyStatus | アカウントのカスタマー マネージド キー機能の状態を示します。 エラーが発生した場合、このプロパティはトラブルシューティング のガイダンスを提供します。 | 糸 |
| databaseAccountOfferType | データベースのオファーの種類 | 'Standard' (必須) |
| defaultIdentity | カスタマー マネージド キーなどの機能で使用されるキー コンテナーにアクセスするための既定の ID。 既定の ID は、ユーザーが明示的に設定する必要があります。 "FirstPartyIdentity"、"SystemAssignedIdentity" などを指定できます。 | 糸 |
| 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 |
| enablePerRegionPerPartitionAutoscale | アカウントでのパーティションごとの自動スケール プレビュー機能 Per-Region 有効または無効にすることを示すフラグ | bool |
| enablePriorityBasedExecution | アカウントでの優先度ベースの実行プレビュー機能の有効化/無効化を示すフラグ | bool |
| ipRules | IpRules の一覧。 | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | 仮想ネットワーク ACL 規則を有効または無効にするかどうかを示すフラグ。 | bool |
| keyVaultKeyUri | キー コンテナーの URI | 糸 |
| 場所 | Cosmos DB アカウントで有効になっている georeplication の場所を含む配列。 | Location[] (必須) |
| minimalTlsVersion | 許可される Tls の最小バージョンを示します。 既定は Tls 1.0 です。Cassandra と Mongo API は除き、Tls 1.2 でのみ機能します。 | 'Tls' 'Tls11' 'Tls12' |
| networkAclBypass | ファイアウォール チェックをバイパスできるサービスを示します。 | 'AzureServices' 'None' |
| networkAclBypassResourceIds | Cosmos DB アカウントのネットワーク ACL バイパスのリソース ID を含む配列。 | string[] |
| publicNetworkAccess | パブリック ネットワークからの要求が許可されるかどうか | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
| restoreParameters | 復元に関する情報を示すパラメーター。 | RestoreParameters |
| virtualNetworkRules | Cosmos DB アカウント用に構成された仮想ネットワーク ACL 規則の一覧。 | VirtualNetworkRule[] |
DatabaseRestoreResource
| 名前 | 形容 | 価値 |
|---|---|---|
| collectionNames | 復元に使用できるコレクションの名前。 | string[] |
| databaseName | 復元に使用できるデータベースの名前。 | 糸 |
DiagnosticLogSettings
| 名前 | 形容 | 価値 |
|---|---|---|
| enableFullTextQuery | クエリのログ記録に使用する詳細レベルについて説明します。 | 'False' 'None' 'True' |
GremlinDatabaseRestoreResource
| 名前 | 形容 | 価値 |
|---|---|---|
| databaseName | 復元に使用できる gremlin データベースの名前。 | 糸 |
| graphNames | 復元に使用できるグラフの名前。 | string[] |
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"。 | 糸 |
場所
| 名前 | 形容 | 価値 |
|---|---|---|
| failoverPriority | リージョンのフェールオーバーの優先順位。 フェールオーバーの優先度が 0 の場合は、書き込みリージョンを示します。 フェールオーバー優先度の最大値 = (リージョンの合計数 - 1)。 フェールオーバー優先度の値は、データベース アカウントが存在するリージョンごとに一意である必要があります。 | int 制約： 最小値 = 0 |
| isZoneRedundant | このリージョンが AvailabilityZone リージョンかどうかを示すフラグ | bool |
| locationName | リージョンの名前。 | 糸 |
ManagedServiceIdentity
| 名前 | 形容 | 価値 |
|---|---|---|
| 種類 | リソースに使用される 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
| 名前 | 形容 | 価値 |
|---|
Microsoft.DocumentDB/databaseAccounts
| 名前 | 形容 | 価値 |
|---|---|---|
| 同一性 | リソースの ID。 | ManagedServiceIdentity の |
| 種類 | データベース アカウントの種類を示します。 これは、データベース アカウントの作成時にのみ設定できます。 | 'GlobalDocumentDB' 'MongoDB' 'Parse' |
| 場所 | リソースが属するリソース グループの場所。 | 糸 |
| 名前 | リソース名 | 糸 制約： 最小長 = 3 最大長 = 3 パターン = ^[a-z0-9]+(-[a-z0-9]+)* (必須) |
| プロパティ | Azure Cosmos DB データベース アカウントを作成および更新するためのプロパティ。 | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (必須) |
| タグ | リソース タグ | タグ名と値のディクショナリ。 |
| 種類 | リソースの種類 | "Microsoft.DocumentDB/databaseAccounts@2024-12-01-preview" |
PeriodicModeBackupPolicy
| 名前 | 形容 | 価値 |
|---|---|---|
| periodicModeProperties | 定期モード バックアップの構成値 | PeriodicModeProperties |
| 種類 | バックアップのモードについて説明します。 | 'Periodic' (必須) |
PeriodicModeProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| backupIntervalInMinutes | 2 つのバックアップ間の間隔を分単位で表す整数 | int 制約： 最小値 = 0 |
| backupRetentionIntervalInHours | 各バックアップが保持される時間 (時間単位) を表す整数 | int 制約： 最小値 = 0 |
| backupStorageRedundancy | バックアップの保存場所の種類を示す列挙型 | 'Geo' 'Local' 'Zone' |
RestoreParameters
| 名前 | 形容 | 価値 |
|---|---|---|
| databasesToRestore | 復元に使用できる特定のデータベースの一覧。 | DatabaseRestoreResource[] |
| gremlinDatabasesToRestore | 復元に使用できる特定の gremlin データベースの一覧。 | GremlinDatabaseRestoreResource[] |
| restoreMode | 復元のモードについて説明します。 | 'PointInTime' |
| restoreSource | 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | 糸 |
| restoreTimestampInUtc | アカウントを復元する必要がある時間 (ISO-8601 形式)。 | 糸 |
| restoreWithTtlDisabled | 復元が成功した時点で、復元されたアカウントに Time-To-Live を無効にするかどうかを指定します。 | bool |
| sourceBackupLocation | 復元のソース バックアップの場所。 | 糸 |
| tablesToRestore | 復元に使用できる特定のテーブルの一覧。 | string[] |
タグ
| 名前 | 形容 | 価値 |
|---|
VirtualNetworkRule
| 名前 | 形容 | 価値 |
|---|---|---|
| 身分証明書 | サブネットのリソース ID (例: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName})。 | 糸 |
| ignoreMissingVNetServiceEndpoint | 仮想ネットワークで vnet サービス エンドポイントが有効になる前に、ファイアウォール規則を作成します。 | bool |