Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers 2024-02-15-preview
- 最新
- 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
Bicep リソース定義
databaseAccounts/sqlDatabases/containers リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-02-15-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
analyticalStorageTtl: int
clientEncryptionPolicy: {
includedPaths: [
{
clientEncryptionKeyId: 'string'
encryptionAlgorithm: 'string'
encryptionType: 'string'
path: 'string'
}
]
policyFormatVersion: int
}
computedProperties: [
{
name: 'string'
query: 'string'
}
]
conflictResolutionPolicy: {
conflictResolutionPath: 'string'
conflictResolutionProcedure: 'string'
mode: 'string'
}
createMode: 'string'
defaultTtl: int
id: 'string'
indexingPolicy: {
automatic: bool
compositeIndexes: [
{
order: 'string'
path: 'string'
}
]
excludedPaths: [
{
path: 'string'
}
]
includedPaths: [
{
indexes: [
{
dataType: 'string'
kind: 'string'
precision: int
}
]
path: 'string'
}
]
indexingMode: 'string'
spatialIndexes: [
{
path: 'string'
types: [
'string'
]
}
]
}
materializedViewDefinition: {
definition: 'string'
sourceCollectionId: 'string'
}
partitionKey: {
kind: 'string'
paths: [
'string'
]
version: int
}
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
restoreWithTtlDisabled: bool
}
uniqueKeyPolicy: {
uniqueKeys: [
{
paths: [
'string'
]
}
]
}
}
}
}
プロパティ値
databaseAccounts/sqlDatabases/containers
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
| location | リソースが属しているリソース グループの場所。 | string |
| tags | タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
| parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部の子リソース」を参照してください。 |
型のリソースのシンボル名: sqlDatabases |
| identity | リソースの ID。 | ManagedServiceIdentity |
| properties | Azure Cosmos DB コンテナーを作成および更新するためのプロパティ。 | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (必須) |
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 です。
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
| 名前 | 説明 | 値 |
|---|---|---|
| options | 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されるヘッダーに対応します。 | CreateUpdateOptionsOrSqlContainerGetPropertiesOption... |
| resource | コンテナーの標準的な JSON 形式 | SqlContainerResourceOrSqlContainerGetPropertiesResou... (必須) |
CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
| 名前 | 説明 | 値 |
|---|---|---|
| autoscaleSettings | 自動スケーリング設定を指定します。 注: スループットまたは autoscaleSettings が必要ですが、両方は必要ありません。 | AutoscaleSettings |
| throughput | 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 | INT |
AutoscaleSettings
| 名前 | 説明 | 値 |
|---|---|---|
| maxThroughput | リソースがスケールアップできる最大スループットを表します。 | INT |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| 名前 | 説明 | 値 |
|---|---|---|
| analyticalStorageTtl | 分析 TTL。 | INT |
| clientEncryptionPolicy | コンテナーのクライアント暗号化ポリシー。 | ClientEncryptionPolicy |
| computedProperties | 計算されたプロパティの一覧 | ComputedProperty[] |
| conflictResolutionPolicy | コンテナーの競合解決ポリシー。 | ConflictResolutionPolicy |
| createMode | リソースの作成モードを示す列挙型。 | 'Default' 'PointInTimeRestore' 'Restore' |
| defaultTtl | 既定の有効期間 | INT |
| id | Cosmos DB SQL コンテナーの名前 | string (必須) |
| indexingPolicy | インデックス作成ポリシーの構成。 既定では、コンテナー内のすべてのドキュメント パスのインデックス作成は自動的に行われます | IndexingPolicy |
| materializedViewDefinition | 具体化されたビューを定義するための構成。 これは、具体化されたビュー コンテナーを作成する場合にのみ指定する必要があります。 | MaterializedViewDefinition |
| partitionKey | 複数のパーティションにデータをパーティション分割するために使用するパーティション キーの構成 | ContainerPartitionKey |
| restoreParameters | 復元に関する情報を示すパラメーター | ResourceRestoreParameters |
| uniqueKeyPolicy | Azure Cosmos DB サービスのコレクション内のドキュメントに対する一意性制約を指定するための一意キー ポリシー構成。 | UniqueKeyPolicy |
ClientEncryptionPolicy
| 名前 | 説明 | 値 |
|---|---|---|
| includedPaths | パス固有の設定と共に暗号化が必要な項目のパス。 | ClientEncryptionIncludedPath[] (必須) |
| policyFormatVersion | クライアント暗号化ポリシー定義のバージョン。 サポートされているバージョンは 1 と 2 です。 バージョン 2 では、ID とパーティション キーパスの暗号化がサポートされています。 | int (必須) 制約: 最小値 = 1 最大値 = 2 |
ClientEncryptionIncludedPath
| 名前 | 説明 | 値 |
|---|---|---|
| clientEncryptionKeyId | パスの暗号化に使用するクライアント暗号化キーの識別子。 | string (必須) |
| encryptionAlgorithm | 使用される暗号化アルゴリズム。 例: AEAD_AES_256_CBC_HMAC_SHA256。 | string (必須) |
| encryptionType | 実行する暗号化の種類。 例: 決定論的、ランダム化。 | string (必須) |
| path | 暗号化する必要があるパス。 | string (必須) |
ComputedProperty
| 名前 | 説明 | 値 |
|---|---|---|
| name | 計算されたプロパティの名前 (例: "cp_lowerName" | string |
| query | 計算されたプロパティの値を評価するクエリ (例: "SELECT VALUE LOWER(c.name) FROM c" | string |
ConflictResolutionPolicy
| 名前 | 説明 | 値 |
|---|---|---|
| conflictResolutionPath | LastWriterWins モードの場合の競合解決パス。 | string |
| conflictResolutionProcedure | カスタム モードの場合の競合を解決する手順。 | string |
| mode | 競合解決モードを示します。 | 'Custom' 'LastWriterWins' |
IndexingPolicy
| 名前 | 説明 | 値 |
|---|---|---|
| automatic | インデックス作成ポリシーが自動かどうかを示します | [bool] |
| compositeIndexes | 複合パス リストの一覧 | CompositePath[] |
| excludedPaths | インデックス作成から除外するパスの一覧 | ExcludedPath[] |
| includedPaths | インデックス作成に含めるパスの一覧 | IncludedPath[] |
| indexingMode | インデックス作成モードを示します。 | 'consistent' 'lazy' 'none' |
| spatialIndexes | 空間の詳細の一覧 | SpatialSpec[] |
CompositePath
| 名前 | 説明 | 値 |
|---|---|---|
| 順序 | 複合パスの並べ替え順序。 | 'ascending' '降順' |
| path | インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる | string |
ExcludedPath
| 名前 | 説明 | 値 |
|---|---|---|
| path | インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる | string |
IncludedPath
| 名前 | 説明 | 値 |
|---|---|---|
| インデックス | このパスのインデックスの一覧 | Indexes[] |
| path | インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる | string |
インデックス
| 名前 | 説明 | 値 |
|---|---|---|
| dataType | インデックス作成の動作が適用されるデータ型。 | 'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String' |
| kind | インデックスの種類を示します。 | 'Hash' 'Range' 'Spatial' |
| 精度 | インデックスの有効桁数。 -1 は最大精度です。 | INT |
SpatialSpec
| 名前 | 説明 | 値 |
|---|---|---|
| path | インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる | string |
| types | パスの空間型の一覧 | 次のいずれかを含む文字列配列: 'LineString' 'MultiPolygon' 'Point' 'Polygon' |
MaterializedViewDefinition
| 名前 | 説明 | 値 |
|---|---|---|
| 定義 | この定義は、ソース コンテナーからデータをフェッチして具体化されたビュー コンテナーに入力するために使用される SQL クエリである必要があります。 | string (必須) |
| sourceCollectionId | 具体化されたビューが作成されるソース コンテナーの名前。 | string (必須) |
ContainerPartitionKey
| 名前 | 説明 | 値 |
|---|---|---|
| kind | パーティション分割に使用されるアルゴリズムの種類を示します。 MultiHash の場合、コンテナーの作成では複数のパーティション キー (最大 3 つ) がサポートされます | 'Hash' 'MultiHash' 'Range' |
| パス | コンテナー内のどのデータをパーティション分割できるかを使用するパスの一覧 | string[] |
| version | パーティション キー定義のバージョンを示します | INT 制約: 最小値 = 1 最大値 = 2 |
ResourceRestoreParameters
| 名前 | 説明 | 値 |
|---|---|---|
| restoreSource | 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | アカウントを復元する必要がある時間 (ISO-8601 形式)。 | string |
| restoreWithTtlDisabled | 復元が成功したときに、復元されたアカウントで Time-To-Live を無効にするかどうかを指定します。 | [bool] |
UniqueKeyPolicy
| 名前 | 説明 | 値 |
|---|---|---|
| uniqueKeys | Azure Cosmos DB サービスのコレクション内のドキュメントに一意性制約を適用する の一意キーの一覧。 | UniqueKey[] |
UniqueKey
| 名前 | 説明 | 値 |
|---|---|---|
| パス | パスの一覧は、Azure Cosmos DB サービスのドキュメントごとに一意である必要があります | string[] |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
Free レベルの Azure Cosmos DB アカウントを作成する |
このテンプレートでは、共有スループットとコンテナーを持つデータベースを使用して、SQL API 用の Free レベルの Azure Cosmos DB アカウントを作成します。 |
| Core (SQL) API 用の Azure Cosmos DB アカウントを作成する |
このテンプレートでは、他の複数のオプションを含むスループットを持つデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。 |
| 分析ストアを使用した Azure Cosmos DB アカウント SQL API |
このテンプレートは、分析ストアで構成されたデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。 |
| 自動スケーリングを使用して Azure Cosmos DB アカウント SQL API を作成する |
このテンプレートでは、他の複数のオプションを使用して、自動スケーリング スループットを持つデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。 |
| Azure Cosmos DB Core (SQL) API ストアド プロシージャを作成する |
このテンプレートでは、Core (SQL) API 用の Azure Cosmos DB アカウントと、ストアド プロシージャ、トリガー、およびユーザー定義関数を含むコンテナーを作成します。 |
| Cosmos DB 接続を使用して Azure Data Explorer DB をデプロイする |
Cosmos DB 接続を使用して Azure Data Explorer DB をデプロイします。 |
ARM テンプレート リソース定義
databaseAccounts/sqlDatabases/containers リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
"apiVersion": "2024-02-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"analyticalStorageTtl": "int",
"clientEncryptionPolicy": {
"includedPaths": [
{
"clientEncryptionKeyId": "string",
"encryptionAlgorithm": "string",
"encryptionType": "string",
"path": "string"
}
],
"policyFormatVersion": "int"
},
"computedProperties": [
{
"name": "string",
"query": "string"
}
],
"conflictResolutionPolicy": {
"conflictResolutionPath": "string",
"conflictResolutionProcedure": "string",
"mode": "string"
},
"createMode": "string",
"defaultTtl": "int",
"id": "string",
"indexingPolicy": {
"automatic": "bool",
"compositeIndexes": [
{
"order": "string",
"path": "string"
}
],
"excludedPaths": [
{
"path": "string"
}
],
"includedPaths": [
{
"indexes": [
{
"dataType": "string",
"kind": "string",
"precision": "int"
}
],
"path": "string"
}
],
"indexingMode": "string",
"spatialIndexes": [
{
"path": "string",
"types": [ "string" ]
}
]
},
"materializedViewDefinition": {
"definition": "string",
"sourceCollectionId": "string"
},
"partitionKey": {
"kind": "string",
"paths": [ "string" ],
"version": "int"
},
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string",
"restoreWithTtlDisabled": "bool"
},
"uniqueKeyPolicy": {
"uniqueKeys": [
{
"paths": [ "string" ]
}
]
}
}
}
}
プロパティ値
databaseAccounts/sqlDatabases/containers
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers' |
| apiVersion | リソース API のバージョン | '2024-02-15-preview' |
| name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
| location | リソースが属しているリソース グループの場所。 | string |
| tags | タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
| identity | リソースの ID。 | ManagedServiceIdentity |
| properties | Azure Cosmos DB コンテナーを作成および更新するためのプロパティ。 | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (必須) |
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 です。
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
| 名前 | 説明 | 値 |
|---|---|---|
| options | 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されるヘッダーに対応します。 | CreateUpdateOptionsOrSqlContainerGetPropertiesOption... |
| resource | コンテナーの標準的な JSON 形式 | SqlContainerResourceOrSqlContainerGetPropertiesResou... (必須) |
CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
| 名前 | 説明 | 値 |
|---|---|---|
| autoscaleSettings | 自動スケーリング設定を指定します。 注: スループットまたは autoscaleSettings が必要ですが、両方は必要ありません。 | AutoscaleSettings |
| throughput | 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 | INT |
AutoscaleSettings
| 名前 | 説明 | 値 |
|---|---|---|
| maxThroughput | リソースがスケールアップできる最大スループットを表します。 | INT |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| 名前 | 説明 | 値 |
|---|---|---|
| analyticalStorageTtl | 分析 TTL。 | INT |
| clientEncryptionPolicy | コンテナーのクライアント暗号化ポリシー。 | ClientEncryptionPolicy |
| computedProperties | 計算されたプロパティの一覧 | ComputedProperty[] |
| conflictResolutionPolicy | コンテナーの競合解決ポリシー。 | ConflictResolutionPolicy |
| createMode | リソースの作成モードを示す列挙型。 | 'Default' 'PointInTimeRestore' 'Restore' |
| defaultTtl | 既定の有効期間 | INT |
| id | Cosmos DB SQL コンテナーの名前 | string (必須) |
| indexingPolicy | インデックス作成ポリシーの構成。 既定では、コンテナー内のすべてのドキュメント パスのインデックス作成は自動的に行われます | IndexingPolicy |
| materializedViewDefinition | 具体化されたビューを定義するための構成。 これは、具体化されたビュー コンテナーを作成する場合にのみ指定する必要があります。 | MaterializedViewDefinition |
| partitionKey | 複数のパーティションにデータをパーティション分割するために使用するパーティション キーの構成 | ContainerPartitionKey |
| restoreParameters | 復元に関する情報を示すパラメーター | ResourceRestoreParameters |
| uniqueKeyPolicy | Azure Cosmos DB サービスのコレクション内のドキュメントに対する一意性制約を指定するための一意キー ポリシー構成。 | UniqueKeyPolicy |
ClientEncryptionPolicy
| 名前 | 説明 | 値 |
|---|---|---|
| includedPaths | パス固有の設定と共に暗号化が必要な項目のパス。 | ClientEncryptionIncludedPath[] (必須) |
| policyFormatVersion | クライアント暗号化ポリシー定義のバージョン。 サポートされているバージョンは 1 と 2 です。 バージョン 2 では、ID とパーティション キーパスの暗号化がサポートされています。 | int (必須) 制約: 最小値 = 1 最大値 = 2 |
ClientEncryptionIncludedPath
| 名前 | 説明 | 値 |
|---|---|---|
| clientEncryptionKeyId | パスの暗号化に使用するクライアント暗号化キーの識別子。 | string (必須) |
| encryptionAlgorithm | 使用される暗号化アルゴリズム。 例: AEAD_AES_256_CBC_HMAC_SHA256。 | string (必須) |
| encryptionType | 実行する暗号化の種類。 例: 決定論的、ランダム化。 | string (必須) |
| path | 暗号化する必要があるパス。 | string (必須) |
ComputedProperty
| 名前 | 説明 | 値 |
|---|---|---|
| name | 計算されたプロパティの名前 (例: "cp_lowerName" | string |
| query | 計算されたプロパティの値を評価するクエリ (例: "SELECT VALUE LOWER(c.name) FROM c" | string |
ConflictResolutionPolicy
| 名前 | 説明 | 値 |
|---|---|---|
| conflictResolutionPath | LastWriterWins モードの場合の競合解決パス。 | string |
| conflictResolutionProcedure | カスタム モードの場合の競合を解決する手順。 | string |
| mode | 競合解決モードを示します。 | 'Custom' 'LastWriterWins' |
IndexingPolicy
| 名前 | 説明 | 値 |
|---|---|---|
| automatic | インデックス作成ポリシーが自動かどうかを示します | [bool] |
| compositeIndexes | 複合パス リストの一覧 | CompositePath[] |
| excludedPaths | インデックス作成から除外するパスの一覧 | ExcludedPath[] |
| includedPaths | インデックス作成に含めるパスの一覧 | IncludedPath[] |
| indexingMode | インデックス作成モードを示します。 | 'consistent' 'lazy' 'none' |
| spatialIndexes | 空間の詳細の一覧 | SpatialSpec[] |
CompositePath
| 名前 | 説明 | 値 |
|---|---|---|
| 順序 | 複合パスの並べ替え順序。 | 'ascending' '降順' |
| path | インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる | string |
ExcludedPath
| 名前 | 説明 | 値 |
|---|---|---|
| path | インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる | string |
IncludedPath
| 名前 | 説明 | 値 |
|---|---|---|
| インデックス | このパスのインデックスの一覧 | Indexes[] |
| path | インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる | string |
インデックス
| 名前 | 説明 | 値 |
|---|---|---|
| dataType | インデックス作成の動作が適用されるデータ型。 | 'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String' |
| kind | インデックスの種類を示します。 | 'Hash' 'Range' 'Spatial' |
| 精度 | インデックスの有効桁数。 -1 は最大有効桁数です。 | INT |
SpatialSpec
| 名前 | 説明 | 値 |
|---|---|---|
| path | インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる | string |
| types | パスの空間型の一覧 | 次のいずれかを含む文字列配列: 'LineString' 'MultiPolygon' 'Point' 'Polygon' |
MaterializedViewDefinition
| 名前 | 説明 | 値 |
|---|---|---|
| 定義 | 定義は、ソース コンテナーからデータをフェッチして具体化されたビュー コンテナーにデータを入力するために使用される SQL クエリである必要があります。 | string (必須) |
| sourceCollectionId | 具体化されたビューが作成されるソース コンテナーの名前。 | string (必須) |
ContainerPartitionKey
| 名前 | 説明 | 値 |
|---|---|---|
| kind | パーティション分割に使用されるアルゴリズムの種類を示します。 MultiHash の場合、コンテナーの作成では複数のパーティション キー (最大 3 つ) がサポートされます | 'Hash' 'MultiHash' 'Range' |
| パス | コンテナー内のどのデータをパーティション分割できるかを使用するパスの一覧 | string[] |
| version | パーティション キー定義のバージョンを示します | INT 制約: 最小値 = 1 最大値 = 2 |
ResourceRestoreParameters
| 名前 | 説明 | 値 |
|---|---|---|
| restoreSource | 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | アカウントを復元する必要がある時間 (ISO-8601 形式)。 | string |
| restoreWithTtlDisabled | 復元が正常に行われると、復元されたアカウントで Time-To-Live が無効になるかどうかを指定します。 | [bool] |
UniqueKeyPolicy
| 名前 | 説明 | 値 |
|---|---|---|
| uniqueKeys | Azure Cosmos DB サービスのコレクション内のドキュメントに一意性制約を適用する の一意キーの一覧。 | UniqueKey[] |
UniqueKey
| 名前 | 説明 | 値 |
|---|---|---|
| パス | パスの一覧は、Azure Cosmos DB サービスのドキュメントごとに一意である必要があります | string[] |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
| Free レベルの Azure Cosmos DB アカウントを作成する |
このテンプレートでは、共有スループットとコンテナーを持つデータベースを使用して、SQL API 用の Free レベルの Azure Cosmos DB アカウントを作成します。 |
| Core (SQL) API 用の Azure Cosmos DB アカウントを作成する |
このテンプレートでは、他の複数のオプションを含むスループットを持つデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。 |
| 分析ストアを使用した Azure Cosmos DB アカウント SQL API |
このテンプレートでは、分析ストアで構成されたデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。 |
| 自動スケーリングを使用して Azure Cosmos DB アカウント SQL API を作成する |
このテンプレートでは、他の複数のオプションを使用して、自動スケーリング スループットを持つデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。 |
| Azure Cosmos DB Core (SQL) API ストアド プロシージャを作成する |
このテンプレートでは、Core (SQL) API 用の Azure Cosmos DB アカウントと、ストアド プロシージャ、トリガー、およびユーザー定義関数を含むコンテナーを作成します。 |
| Cosmos DB 接続を使用して Azure Data Explorer DB をデプロイする |
Cosmos DB 接続を使用して Azure Data Explorer DB をデプロイします。 |
Terraform (AzAPI プロバイダー) リソース定義
databaseAccounts/sqlDatabases/containers リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-02-15-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
options = {
autoscaleSettings = {
maxThroughput = int
}
throughput = int
}
resource = {
analyticalStorageTtl = int
clientEncryptionPolicy = {
includedPaths = [
{
clientEncryptionKeyId = "string"
encryptionAlgorithm = "string"
encryptionType = "string"
path = "string"
}
]
policyFormatVersion = int
}
computedProperties = [
{
name = "string"
query = "string"
}
]
conflictResolutionPolicy = {
conflictResolutionPath = "string"
conflictResolutionProcedure = "string"
mode = "string"
}
createMode = "string"
defaultTtl = int
id = "string"
indexingPolicy = {
automatic = bool
compositeIndexes = [
{
order = "string"
path = "string"
}
]
excludedPaths = [
{
path = "string"
}
]
includedPaths = [
{
indexes = [
{
dataType = "string"
kind = "string"
precision = int
}
]
path = "string"
}
]
indexingMode = "string"
spatialIndexes = [
{
path = "string"
types = [
"string"
]
}
]
}
materializedViewDefinition = {
definition = "string"
sourceCollectionId = "string"
}
partitionKey = {
kind = "string"
paths = [
"string"
]
version = int
}
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
restoreWithTtlDisabled = bool
}
uniqueKeyPolicy = {
uniqueKeys = [
{
paths = [
"string"
]
}
]
}
}
}
})
}
プロパティ値
databaseAccounts/sqlDatabases/containers
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-02-15-preview" |
| name | リソース名 | string (必須) |
| location | リソースが属しているリソース グループの場所。 | string |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: sqlDatabases |
| tags | タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 | タグの名前と値のディクショナリ。 |
| identity | リソースの ID。 | ManagedServiceIdentity |
| properties | Azure Cosmos DB コンテナーを作成および更新するためのプロパティ。 | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (必須) |
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 です。
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
| 名前 | 説明 | 値 |
|---|---|---|
| options | 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されるヘッダーに対応します。 | CreateUpdateOptionsOrSqlContainerGetPropertiesOption... |
| resource | コンテナーの標準 JSON 形式 | SqlContainerResourceOrSqlContainerGetPropertiesResou... (必須) |
CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
| 名前 | 説明 | 値 |
|---|---|---|
| autoscaleSettings | 自動スケーリングの設定を指定します。 注: スループットまたは自動scaleSettings は必須ですが、両方は必要ありません。 | AutoscaleSettings |
| throughput | 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 | INT |
AutoscaleSettings
| 名前 | 説明 | 値 |
|---|---|---|
| maxThroughput | リソースをスケールアップできる最大スループットを表します。 | INT |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| 名前 | 説明 | 値 |
|---|---|---|
| analyticalStorageTtl | 分析 TTL。 | INT |
| clientEncryptionPolicy | コンテナーのクライアント暗号化ポリシー。 | ClientEncryptionPolicy |
| computedProperties | 計算プロパティの一覧 | ComputedProperty[] |
| conflictResolutionPolicy | コンテナーの競合解決ポリシー。 | ConflictResolutionPolicy |
| createMode | リソースの作成モードを示す列挙型。 | "Default" "PointInTimeRestore" "復元" |
| defaultTtl | 既定の有効期間 | INT |
| id | Cosmos DB SQL コンテナーの名前 | string (必須) |
| indexingPolicy | インデックス作成ポリシーの構成。 既定では、コンテナー内のすべてのドキュメント パスに対してインデックス作成が自動的に行われます | IndexingPolicy |
| materializedViewDefinition | 具体化されたビューを定義するための構成。 これは、具体化されたビュー コンテナーを作成する場合にのみ指定する必要があります。 | MaterializedViewDefinition |
| partitionKey | データを複数のパーティションにパーティション分割するために使用するパーティション キーの構成 | ContainerPartitionKey |
| restoreParameters | 復元に関する情報を示すパラメーター | ResourceRestoreParameters |
| uniqueKeyPolicy | Azure Cosmos DB サービスのコレクション内のドキュメントに対して一意性制約を指定するための一意キー ポリシー構成。 | UniqueKeyPolicy |
ClientEncryptionPolicy
| 名前 | 説明 | 値 |
|---|---|---|
| includedPaths | パス固有の設定と共に暗号化が必要な項目のパス。 | ClientEncryptionIncludedPath[] (必須) |
| policyFormatVersion | クライアント暗号化ポリシー定義のバージョン。 サポートされているバージョンは 1 と 2 です。 バージョン 2 では、ID とパーティション キーパスの暗号化がサポートされています。 | int (必須) 制約: 最小値 = 1 最大値 = 2 |
ClientEncryptionIncludedPath
| 名前 | 説明 | 値 |
|---|---|---|
| clientEncryptionKeyId | パスの暗号化に使用するクライアント暗号化キーの識別子。 | string (必須) |
| encryptionAlgorithm | 使用される暗号化アルゴリズム。 例: AEAD_AES_256_CBC_HMAC_SHA256。 | string (必須) |
| encryptionType | 実行する暗号化の種類。 例 : 決定論的、ランダム化。 | string (必須) |
| path | 暗号化する必要があるパス。 | string (必須) |
ComputedProperty
| 名前 | 説明 | 値 |
|---|---|---|
| name | 計算されたプロパティの名前 (例: "cp_lowerName" | string |
| query | 計算されたプロパティの値を評価するクエリ (例: "SELECT VALUE LOWER(c.name) FROM c" | string |
ConflictResolutionPolicy
| 名前 | 説明 | 値 |
|---|---|---|
| conflictResolutionPath | LastWriterWins モードの場合の競合解決パス。 | string |
| conflictResolutionProcedure | カスタム モードの場合の競合を解決する手順。 | string |
| mode | 競合解決モードを示します。 | "Custom" "LastWriterWins" |
IndexingPolicy
| 名前 | 説明 | 値 |
|---|---|---|
| automatic | インデックス作成ポリシーが自動かどうかを示します | [bool] |
| compositeIndexes | 複合パス リストの一覧 | CompositePath[] |
| excludedPaths | インデックス作成から除外するパスの一覧 | ExcludedPath[] |
| includedPaths | インデックス作成に含めるパスの一覧 | IncludedPath[] |
| indexingMode | インデックス作成モードを示します。 | "一貫性" "lazy" "none" |
| spatialIndexes | 空間の詳細の一覧 | SpatialSpec[] |
CompositePath
| 名前 | 説明 | 値 |
|---|---|---|
| 順序 | 複合パスの並べ替え順序。 | "昇順" "降順" |
| path | インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる | string |
ExcludedPath
| 名前 | 説明 | 値 |
|---|---|---|
| path | インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる | string |
IncludedPath
| 名前 | 説明 | 値 |
|---|---|---|
| インデックス | このパスのインデックスの一覧 | Indexes[] |
| path | インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる | string |
インデックス
| 名前 | 説明 | 値 |
|---|---|---|
| dataType | インデックス作成の動作が適用されるデータ型。 | "LineString" "MultiPolygon" "Number" "Point" "Polygon" "String" |
| kind | インデックスの種類を示します。 | "Hash" "Range" "Spatial" |
| 精度 | インデックスの有効桁数。 -1 は最大有効桁数です。 | INT |
SpatialSpec
| 名前 | 説明 | 値 |
|---|---|---|
| path | インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる | string |
| types | パスの空間型の一覧 | 次のいずれかを含む文字列配列: "LineString" "MultiPolygon" "Point" "Polygon" |
MaterializedViewDefinition
| 名前 | 説明 | 値 |
|---|---|---|
| 定義 | 定義は、ソース コンテナーからデータをフェッチして具体化されたビュー コンテナーにデータを入力するために使用される SQL クエリである必要があります。 | string (必須) |
| sourceCollectionId | 具体化されたビューが作成されるソース コンテナーの名前。 | string (必須) |
ContainerPartitionKey
| 名前 | 説明 | 値 |
|---|---|---|
| kind | パーティション分割に使用されるアルゴリズムの種類を示します。 MultiHash の場合、コンテナーの作成では複数のパーティション キー (最大 3 つ) がサポートされます | "Hash" "MultiHash" "Range" |
| パス | コンテナー内のどのデータをパーティション分割できるかを使用するパスの一覧 | string[] |
| version | パーティション キー定義のバージョンを示します | INT 制約: 最小値 = 1 最大値 = 2 |
ResourceRestoreParameters
| 名前 | 説明 | 値 |
|---|---|---|
| restoreSource | 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | アカウントを復元する必要がある時間 (ISO-8601 形式)。 | string |
| restoreWithTtlDisabled | 復元が正常に行われると、復元されたアカウントで Time-To-Live が無効になるかどうかを指定します。 | [bool] |
UniqueKeyPolicy
| 名前 | 説明 | 値 |
|---|---|---|
| uniqueKeys | Azure Cosmos DB サービスのコレクション内のドキュメントに一意性制約を適用する の一意キーの一覧。 | UniqueKey[] |
UniqueKey
| 名前 | 説明 | 値 |
|---|---|---|
| パス | パスの一覧は、Azure Cosmos DB サービスのドキュメントごとに一意である必要があります | string[] |