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

• 最新の を する
• 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

Bicep リソース定義

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

• リソース グループの - リソース グループのデプロイ コマンド 参照

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

リソースの形式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2023-03-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      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'
            ]
          }
        ]
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

AutoscaleSettings

名前	形容	価値
maxThroughput	リソースをスケールアップできる最大スループットを表します。	int

CompositePath

名前	形容	価値
命令	複合パスの並べ替え順序。	'ascending' 'descending'
パス	インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる	糸

ConflictResolutionPolicy

名前	形容	価値
conflictResolutionPath	LastWriterWins モードの場合の競合解決パス。	糸
conflictResolutionProcedure	カスタム モードの場合の競合を解決する手順。	糸
モード	競合解決モードを示します。	'Custom' 'LastWriterWins'

ContainerPartitionKey

名前	形容	価値
種類	パーティション分割に使用されるアルゴリズムの種類を示します。 MultiHash の場合、コンテナーの作成では複数のパーティション キー (最大 3 つ) がサポートされます	'Hash' 'MultiHash' 'Range'
パス	コンテナー内のどのデータをパーティション分割できるかを使用するパスの一覧	string[]
バージョン	パーティション キー定義のバージョンを示します	int 制約： 最小値 = 1 最大値 = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

名前	形容	価値
autoscaleSettings	自動スケール設定を指定します。	AutoscaleSettings
スループット	1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。	int

ExcludedPath

名前	形容	価値
パス	インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる	糸

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

名前	形容	価値
オプション	要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されたヘッダーに対応します。	CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions の
資源	Gremlin グラフの標準 JSON 形式	GremlinGraphResourceOrGremlinGraphGetPropertiesResource (必須)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

名前	形容	価値
analyticalStorageTtl	分析 TTL。	int
conflictResolutionPolicy	グラフの競合解決ポリシー。	ConflictResolutionPolicy
defaultTtl	既定の有効期間	int
身分証明書	Cosmos DB Gremlin グラフの名前	string (必須)
indexingPolicy	インデックス作成ポリシーの構成。 既定では、グラフ内のすべてのドキュメント パスに対してインデックス作成が自動的に行われます	IndexingPolicy
partitionKey	複数のパーティションにデータをパーティション分割するために使用するパーティション キーの構成	ContainerPartitionKey
uniqueKeyPolicy	Azure Cosmos DB サービス内のコレクション内のドキュメントに対する一意性制約を指定するための一意キー ポリシー構成。	UniqueKeyPolicy

IncludedPath

名前	形容	価値
索引	このパスのインデックスの一覧	インデックス[]
パス	インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる	糸

索引

名前	形容	価値
dataType	インデックス作成の動作が適用されるデータ型。	'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String'
種類	インデックスの種類を示します。	'Hash' 'Range' 'Spatial'
精度	インデックスの有効桁数。 -1 は最大有効桁数です。	int

IndexingPolicy

名前	形容	価値
自動	インデックス作成ポリシーが自動かどうかを示します	bool
compositeIndexes	複合パス リストの一覧	CompositePath[][]
excludedPaths	インデックス作成から除外するパスの一覧	ExcludedPath[] を する
includedPaths	インデックス作成に含めるパスの一覧	IncludedPath[]
indexingMode	インデックス作成モードを示します。	'consistent' 'lazy' 'none'
spatialIndexes	空間の詳細の一覧	SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

名前	形容	価値
場所	リソースが属するリソース グループの場所。	糸
名前	リソース名	string (必須)
親	Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 子リソース」を参照してください。	種類のリソースのシンボリック名: databaseAccounts/gremlinDatabases
プロパティ	Azure Cosmos DB Gremlin グラフを作成および更新するためのプロパティ。	GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (必須)
タグ	リソース タグ	タグ名と値のディクショナリ。 テンプレート の タグを参照してください

SpatialSpec

名前	形容	価値
パス	インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる	糸
種類	パスの空間型の一覧	次のいずれかを含む文字列配列: 'LineString' 'MultiPolygon' 'Point' 'Polygon'

タグ

名前	形容	価値

UniqueKey

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

UniqueKeyPolicy

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

クイック スタートのサンプル

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

Bicep ファイル	形容
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": "2023-03-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "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" ]
          }
        ]
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

AutoscaleSettings

名前	形容	価値
maxThroughput	リソースをスケールアップできる最大スループットを表します。	int

CompositePath

名前	形容	価値
命令	複合パスの並べ替え順序。	'ascending' 'descending'
パス	インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる	糸

ConflictResolutionPolicy

名前	形容	価値
conflictResolutionPath	LastWriterWins モードの場合の競合解決パス。	糸
conflictResolutionProcedure	カスタム モードの場合の競合を解決する手順。	糸
モード	競合解決モードを示します。	'Custom' 'LastWriterWins'

ContainerPartitionKey

名前	形容	価値
種類	パーティション分割に使用されるアルゴリズムの種類を示します。 MultiHash の場合、コンテナーの作成では複数のパーティション キー (最大 3 つ) がサポートされます	'Hash' 'MultiHash' 'Range'
パス	コンテナー内のどのデータをパーティション分割できるかを使用するパスの一覧	string[]
バージョン	パーティション キー定義のバージョンを示します	int 制約： 最小値 = 1 最大値 = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

名前	形容	価値
autoscaleSettings	自動スケール設定を指定します。	AutoscaleSettings
スループット	1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。	int

ExcludedPath

名前	形容	価値
パス	インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる	糸

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

名前	形容	価値
オプション	要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されたヘッダーに対応します。	CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions の
資源	Gremlin グラフの標準 JSON 形式	GremlinGraphResourceOrGremlinGraphGetPropertiesResource (必須)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

名前	形容	価値
analyticalStorageTtl	分析 TTL。	int
conflictResolutionPolicy	グラフの競合解決ポリシー。	ConflictResolutionPolicy
defaultTtl	既定の有効期間	int
身分証明書	Cosmos DB Gremlin グラフの名前	string (必須)
indexingPolicy	インデックス作成ポリシーの構成。 既定では、グラフ内のすべてのドキュメント パスに対してインデックス作成が自動的に行われます	IndexingPolicy
partitionKey	複数のパーティションにデータをパーティション分割するために使用するパーティション キーの構成	ContainerPartitionKey
uniqueKeyPolicy	Azure Cosmos DB サービス内のコレクション内のドキュメントに対する一意性制約を指定するための一意キー ポリシー構成。	UniqueKeyPolicy

IncludedPath

名前	形容	価値
索引	このパスのインデックスの一覧	インデックス[]
パス	インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる	糸

索引

名前	形容	価値
dataType	インデックス作成の動作が適用されるデータ型。	'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String'
種類	インデックスの種類を示します。	'Hash' 'Range' 'Spatial'
精度	インデックスの有効桁数。 -1 は最大有効桁数です。	int

IndexingPolicy

名前	形容	価値
自動	インデックス作成ポリシーが自動かどうかを示します	bool
compositeIndexes	複合パス リストの一覧	CompositePath[][]
excludedPaths	インデックス作成から除外するパスの一覧	ExcludedPath[] を する
includedPaths	インデックス作成に含めるパスの一覧	IncludedPath[]
indexingMode	インデックス作成モードを示します。	'consistent' 'lazy' 'none'
spatialIndexes	空間の詳細の一覧	SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

名前	形容	価値
apiVersion	API のバージョン	'2023-03-15'
場所	リソースが属するリソース グループの場所。	糸
名前	リソース名	string (必須)
プロパティ	Azure Cosmos DB Gremlin グラフを作成および更新するためのプロパティ。	GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (必須)
タグ	リソース タグ	タグ名と値のディクショナリ。 テンプレート の タグを参照してください
種類	リソースの種類	'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs'

SpatialSpec

名前	形容	価値
パス	インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる	糸
種類	パスの空間型の一覧	次のいずれかを含む文字列配列: 'LineString' 'MultiPolygon' 'Point' 'Polygon'

タグ

名前	形容	価値

UniqueKey

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

UniqueKeyPolicy

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

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

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

テンプレート	形容
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@2023-03-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        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"
              ]
            }
          ]
        }
      }
    }
  })
}

プロパティ値

AutoscaleSettings

名前	形容	価値
maxThroughput	リソースをスケールアップできる最大スループットを表します。	int

CompositePath

名前	形容	価値
命令	複合パスの並べ替え順序。	'ascending' 'descending'
パス	インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる	糸

ConflictResolutionPolicy

名前	形容	価値
conflictResolutionPath	LastWriterWins モードの場合の競合解決パス。	糸
conflictResolutionProcedure	カスタム モードの場合の競合を解決する手順。	糸
モード	競合解決モードを示します。	'Custom' 'LastWriterWins'

ContainerPartitionKey

名前	形容	価値
種類	パーティション分割に使用されるアルゴリズムの種類を示します。 MultiHash の場合、コンテナーの作成では複数のパーティション キー (最大 3 つ) がサポートされます	'Hash' 'MultiHash' 'Range'
パス	コンテナー内のどのデータをパーティション分割できるかを使用するパスの一覧	string[]
バージョン	パーティション キー定義のバージョンを示します	int 制約： 最小値 = 1 最大値 = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

名前	形容	価値
autoscaleSettings	自動スケール設定を指定します。	AutoscaleSettings
スループット	1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。	int

ExcludedPath

名前	形容	価値
パス	インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる	糸

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

名前	形容	価値
オプション	要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されたヘッダーに対応します。	CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions の
資源	Gremlin グラフの標準 JSON 形式	GremlinGraphResourceOrGremlinGraphGetPropertiesResource (必須)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

名前	形容	価値
analyticalStorageTtl	分析 TTL。	int
conflictResolutionPolicy	グラフの競合解決ポリシー。	ConflictResolutionPolicy
defaultTtl	既定の有効期間	int
身分証明書	Cosmos DB Gremlin グラフの名前	string (必須)
indexingPolicy	インデックス作成ポリシーの構成。 既定では、グラフ内のすべてのドキュメント パスに対してインデックス作成が自動的に行われます	IndexingPolicy
partitionKey	複数のパーティションにデータをパーティション分割するために使用するパーティション キーの構成	ContainerPartitionKey
uniqueKeyPolicy	Azure Cosmos DB サービス内のコレクション内のドキュメントに対する一意性制約を指定するための一意キー ポリシー構成。	UniqueKeyPolicy

IncludedPath

名前	形容	価値
索引	このパスのインデックスの一覧	インデックス[]
パス	インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる	糸

索引

名前	形容	価値
dataType	インデックス作成の動作が適用されるデータ型。	'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String'
種類	インデックスの種類を示します。	'Hash' 'Range' 'Spatial'
精度	インデックスの有効桁数。 -1 は最大有効桁数です。	int

IndexingPolicy

名前	形容	価値
自動	インデックス作成ポリシーが自動かどうかを示します	bool
compositeIndexes	複合パス リストの一覧	CompositePath[][]
excludedPaths	インデックス作成から除外するパスの一覧	ExcludedPath[] を する
includedPaths	インデックス作成に含めるパスの一覧	IncludedPath[]
indexingMode	インデックス作成モードを示します。	'consistent' 'lazy' 'none'
spatialIndexes	空間の詳細の一覧	SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

名前	形容	価値
場所	リソースが属するリソース グループの場所。	糸
名前	リソース名	string (必須)
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: databaseAccounts/gremlinDatabases
プロパティ	Azure Cosmos DB Gremlin グラフを作成および更新するためのプロパティ。	GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (必須)
タグ	リソース タグ	タグ名と値のディクショナリ。
種類	リソースの種類	"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2023-03-15"

SpatialSpec

名前	形容	価値
パス	インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる	糸
種類	パスの空間型の一覧	次のいずれかを含む文字列配列: 'LineString' 'MultiPolygon' 'Point' 'Polygon'

タグ

名前	形容	価値

UniqueKey

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

UniqueKeyPolicy

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