Share via


Microsoft.DocumentDB databaseAccounts/gremlinDatabases/graphs 2021-03-15

Bicep リソース定義

databaseAccounts/gremlinDatabases/graphs リソースの種類は、次をターゲットとする操作でデプロイできます。

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

リソース形式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-03-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: '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
      }
      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
throughput 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 INT

AutoscaleSettings

名前 説明
maxThroughput リソースがスケールアップできる最大スループットを表します。 INT

GremlinGraphResourceOrGremlinGraphGetPropertiesResou...

名前 説明
conflictResolutionPolicy グラフの競合解決ポリシー。 ConflictResolutionPolicy
defaultTtl 既定の有効期間 INT
id Cosmos DB Gremlin グラフの名前 string (必須)
indexingPolicy インデックス作成ポリシーの構成。 既定では、グラフ内のすべてのドキュメント パスのインデックス作成は自動的に行われます IndexingPolicy
partitionKey 複数のパーティションにデータをパーティション分割するために使用するパーティション キーの構成 ContainerPartitionKey
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'
'降順'
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

UniqueKeyPolicy

名前 説明
uniqueKeys Azure Cosmos DB サービスのコレクション内のドキュメントに一意性制約を適用する の一意キーの一覧。 UniqueKey[]

UniqueKey

名前 説明
パス パスの一覧は、Azure Cosmos DB サービスのドキュメントごとに一意である必要があります string[]

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

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

Template 説明
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 アカウントを作成します。

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

databaseAccounts/gremlinDatabases/graphs リソースの種類は、次をターゲットとする操作でデプロイできます。

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

リソース形式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
  "apiVersion": "2021-03-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "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"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  }
}

プロパティ値

databaseAccounts/gremlinDatabases/graphs

名前 説明
type リソースの種類 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs'
apiVersion リソース API のバージョン '2021-03-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 自動スケーリングの設定を指定します。 AutoscaleSettings
throughput 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 INT

AutoscaleSettings

名前 説明
maxThroughput リソースをスケールアップできる最大スループットを表します。 INT

GremlinGraphResourceOrGremlinGraphGetPropertiesResou...

名前 説明
conflictResolutionPolicy グラフの競合解決ポリシー。 ConflictResolutionPolicy
defaultTtl 既定の有効期間 INT
id Cosmos DB Gremlin グラフの名前 string (必須)
indexingPolicy インデックス作成ポリシーの構成。 既定では、グラフ内のすべてのドキュメント パスに対してインデックス作成が自動的に行われます IndexingPolicy
partitionKey データを複数のパーティションにパーティション分割するために使用するパーティション キーの構成 ContainerPartitionKey
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

UniqueKeyPolicy

名前 説明
uniqueKeys Azure Cosmos DB サービスのコレクション内のドキュメントに一意性制約を適用する の一意キーの一覧。 UniqueKey[]

UniqueKey

名前 説明
パス パスの一覧は、Azure Cosmos DB サービスのドキュメントごとに一意である必要があります string[]

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

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

Template 説明
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 アカウントを作成します。

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

databaseAccounts/gremlinDatabases/graphs リソースの種類は、次をターゲットとする操作でデプロイできます。

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-03-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "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
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

プロパティ値

databaseAccounts/gremlinDatabases/graphs

名前 説明
type リソースの種類 "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-03-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 自動スケーリング設定を指定します。 AutoscaleSettings
throughput 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 INT

AutoscaleSettings

名前 説明
maxThroughput リソースがスケールアップできる最大スループットを表します。 INT

GremlinGraphResourceOrGremlinGraphGetPropertiesResou...

名前 説明
conflictResolutionPolicy グラフの競合解決ポリシー。 ConflictResolutionPolicy
defaultTtl 既定の有効期間 INT
id Cosmos DB Gremlin グラフの名前 string (必須)
indexingPolicy インデックス作成ポリシーの構成。 既定では、グラフ内のすべてのドキュメント パスのインデックス作成は自動的に行われます IndexingPolicy
partitionKey 複数のパーティションにデータをパーティション分割するために使用するパーティション キーの構成 ContainerPartitionKey
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

UniqueKeyPolicy

名前 説明
uniqueKeys Azure Cosmos DB サービスのコレクション内のドキュメントに一意性制約を適用する の一意キーの一覧。 UniqueKey[]

UniqueKey

名前 説明
パス パスの一覧は、Azure Cosmos DB サービスのドキュメントごとに一意である必要があります string[]