Microsoft.DocumentDB databaseAccounts/gremlinDatabases/graphs
- 最新
- 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/gremlinDatabases/graphs リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2024-05-15' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
analyticalStorageTtl: int
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'
]
}
]
}
partitionKey: {
kind: 'string'
paths: [
'string'
]
version: int
}
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
}
uniqueKeyPolicy: {
uniqueKeys: [
{
paths: [
'string'
]
}
]
}
}
}
}
プロパティ値
databaseAccounts/gremlinDatabases/graphs
名前 | 説明 | 値 |
---|---|---|
name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
location | リソースが属しているリソース グループの場所。 | string |
tags | タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部の子リソース」を参照してください。 |
種類のリソースのシンボル名: gremlinDatabases |
properties | Azure Cosmos DB Gremlin グラフを作成および更新するためのプロパティ。 | GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (必須) |
GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...
名前 | 説明 | 値 |
---|---|---|
options | 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されるヘッダーに対応します。 | CreateUpdateOptionsOrGremlinGraphGetPropertiesOption... |
resource | Gremlin グラフの標準 JSON 形式 | GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (必須) |
CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...
名前 | 説明 | 値 |
---|---|---|
autoscaleSettings | 自動スケーリング設定を指定します。 注: スループットまたは autoscaleSettings が必要ですが、両方は必要ありません。 | AutoscaleSettings |
throughput | 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 | INT |
AutoscaleSettings
名前 | 説明 | 値 |
---|---|---|
maxThroughput | リソースをスケールアップできる最大スループットを表します。 | INT |
GremlinGraphResourceOrGremlinGraphGetPropertiesResou...
名前 | 説明 | 値 |
---|---|---|
analyticalStorageTtl | 分析 TTL。 | INT |
conflictResolutionPolicy | グラフの競合解決ポリシー。 | ConflictResolutionPolicy |
createMode | リソースの作成モードを示す列挙型。 | 'Default' 'Restore' |
defaultTtl | 既定の有効期間 | INT |
id | Cosmos DB Gremlin グラフの名前 | string (必須) |
indexingPolicy | インデックス作成ポリシーの構成。 既定では、グラフ内のすべてのドキュメント パスに対してインデックス作成が自動的に行われます | IndexingPolicy |
partitionKey | データを複数のパーティションにパーティション分割するために使用するパーティション キーの構成 | ContainerPartitionKey |
restoreParameters | 復元に関する情報を示すパラメーター | ResourceRestoreParameters |
uniqueKeyPolicy | Azure Cosmos DB サービスのコレクション内のドキュメントに対して一意性制約を指定するための一意キー ポリシー構成。 | UniqueKeyPolicy |
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' 'descending' |
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' |
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 |
UniqueKeyPolicy
名前 | 説明 | 値 |
---|---|---|
uniqueKeys | Azure Cosmos DB サービスのコレクション内のドキュメントに一意性制約を適用する の一意キーの一覧。 | UniqueKey[] |
UniqueKey
名前 | 説明 | 値 |
---|---|---|
パス | パスの一覧は、Azure Cosmos DB サービスのドキュメントごとに一意である必要があります | string[] |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
Template | 説明 |
---|---|
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 アカウントを作成します。 |
ARM テンプレート リソース定義
databaseAccounts/gremlinDatabases/graphs リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
"apiVersion": "2024-05-15",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"analyticalStorageTtl": "int",
"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" ]
}
]
},
"partitionKey": {
"kind": "string",
"paths": [ "string" ],
"version": "int"
},
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string"
},
"uniqueKeyPolicy": {
"uniqueKeys": [
{
"paths": [ "string" ]
}
]
}
}
}
}
プロパティ値
databaseAccounts/gremlinDatabases/graphs
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs' |
apiVersion | リソース API のバージョン | '2024-05-15' |
name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
location | リソースが属しているリソース グループの場所。 | string |
tags | タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 | タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください |
properties | Azure Cosmos DB Gremlin グラフを作成および更新するためのプロパティ。 | GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (必須) |
GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...
名前 | 説明 | 値 |
---|---|---|
options | 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されるヘッダーに対応します。 | CreateUpdateOptionsOrGremlinGraphGetPropertiesOption... |
resource | Gremlin グラフの標準 JSON 形式 | GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (必須) |
CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...
名前 | 説明 | 値 |
---|---|---|
autoscaleSettings | 自動スケーリングの設定を指定します。 注: スループットまたは自動scaleSettings は必須ですが、両方は必要ありません。 | AutoscaleSettings |
throughput | 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 | INT |
AutoscaleSettings
名前 | 説明 | 値 |
---|---|---|
maxThroughput | リソースをスケールアップできる最大スループットを表します。 | INT |
GremlinGraphResourceOrGremlinGraphGetPropertiesResou...
名前 | 説明 | 値 |
---|---|---|
analyticalStorageTtl | 分析 TTL。 | INT |
conflictResolutionPolicy | グラフの競合解決ポリシー。 | ConflictResolutionPolicy |
createMode | リソースの作成モードを示す列挙型。 | 'Default' 'Restore' |
defaultTtl | 既定の有効期間 | INT |
id | Cosmos DB Gremlin グラフの名前 | string (必須) |
indexingPolicy | インデックス作成ポリシーの構成。 既定では、グラフ内のすべてのドキュメント パスに対してインデックス作成が自動的に行われます | IndexingPolicy |
partitionKey | データを複数のパーティションにパーティション分割するために使用するパーティション キーの構成 | ContainerPartitionKey |
restoreParameters | 復元に関する情報を示すパラメーター | ResourceRestoreParameters |
uniqueKeyPolicy | Azure Cosmos DB サービスのコレクション内のドキュメントに対して一意性制約を指定するための一意キー ポリシー構成。 | UniqueKeyPolicy |
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' 'descending' |
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' |
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 |
UniqueKeyPolicy
名前 | 説明 | 値 |
---|---|---|
uniqueKeys | Azure Cosmos DB サービスのコレクション内のドキュメントに一意性制約を適用する の一意キーの一覧。 | UniqueKey[] |
UniqueKey
名前 | 説明 | 値 |
---|---|---|
パス | パスの一覧は、Azure Cosmos DB サービスのドキュメントごとに一意である必要があります | string[] |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
Template | 説明 |
---|---|
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 アカウントを作成します。 |
Terraform (AzAPI プロバイダー) リソース定義
databaseAccounts/gremlinDatabases/graphs リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2024-05-15"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
options = {
autoscaleSettings = {
maxThroughput = int
}
throughput = int
}
resource = {
analyticalStorageTtl = int
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"
]
}
]
}
partitionKey = {
kind = "string"
paths = [
"string"
]
version = int
}
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
}
uniqueKeyPolicy = {
uniqueKeys = [
{
paths = [
"string"
]
}
]
}
}
}
})
}
プロパティ値
databaseAccounts/gremlinDatabases/graphs
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2024-05-15" |
name | リソース名 | string (必須) |
location | リソースが属しているリソース グループの場所。 | string |
parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: gremlinDatabases |
tags | タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 | タグ名と値のディクショナリ。 |
properties | Azure Cosmos DB Gremlin グラフを作成および更新するためのプロパティ。 | GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (必須) |
GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...
名前 | 説明 | 値 |
---|---|---|
options | 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されるヘッダーに対応します。 | CreateUpdateOptionsOrGremlinGraphGetPropertiesOption... |
resource | Gremlin グラフの標準 JSON 形式 | GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (必須) |
CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...
名前 | 説明 | 値 |
---|---|---|
autoscaleSettings | 自動スケーリングの設定を指定します。 注: スループットまたは自動scaleSettings は必須ですが、両方は必要ありません。 | AutoscaleSettings |
throughput | 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 | INT |
AutoscaleSettings
名前 | 説明 | 値 |
---|---|---|
maxThroughput | リソースをスケールアップできる最大スループットを表します。 | INT |
GremlinGraphResourceOrGremlinGraphGetPropertiesResou...
名前 | 説明 | 値 |
---|---|---|
analyticalStorageTtl | 分析 TTL。 | INT |
conflictResolutionPolicy | グラフの競合解決ポリシー。 | ConflictResolutionPolicy |
createMode | リソースの作成モードを示す列挙型。 | "Default" "復元" |
defaultTtl | 既定の有効期間 | INT |
id | Cosmos DB Gremlin グラフの名前 | string (必須) |
indexingPolicy | インデックス作成ポリシーの構成。 既定では、グラフ内のすべてのドキュメント パスに対してインデックス作成が自動的に行われます | IndexingPolicy |
partitionKey | データを複数のパーティションにパーティション分割するために使用するパーティション キーの構成 | ContainerPartitionKey |
restoreParameters | 復元に関する情報を示すパラメーター | ResourceRestoreParameters |
uniqueKeyPolicy | Azure Cosmos DB サービスのコレクション内のドキュメントに対して一意性制約を指定するための一意キー ポリシー構成。 | UniqueKeyPolicy |
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" |
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 |
UniqueKeyPolicy
名前 | 説明 | 値 |
---|---|---|
uniqueKeys | Azure Cosmos DB サービスのコレクション内のドキュメントに一意性制約を適用する の一意キーの一覧。 | UniqueKey[] |
UniqueKey
名前 | 説明 | 値 |
---|---|---|
パス | パスの一覧は、Azure Cosmos DB サービスのドキュメントごとに一意である必要があります | string[] |