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

• Latest
• 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 resource definition

The databaseAccounts/gremlinDatabases/graphs resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2023-09-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'
      }
      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'
            ]
          }
        ]
      }
    }
  }
}

Property values

databaseAccounts/gremlinDatabases/graphs

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	string (required)
location	The location of the resource group to which the resource belongs.	string
tags	Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".	Dictionary of tag names and values. See Tags in templates
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: gremlinDatabases
properties	Properties to create and update Azure Cosmos DB Gremlin graph.	GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (required)

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...

Name	Description	Value
options	A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.	CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...
resource	The standard JSON format of a Gremlin graph	GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (required)

CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...

Name	Description	Value
autoscaleSettings	Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both.	AutoscaleSettings
throughput	Request Units per second. For example, "throughput": 10000.	int

AutoscaleSettings

Name	Description	Value
maxThroughput	Represents maximum throughput, the resource can scale up to.	int

GremlinGraphResourceOrGremlinGraphGetPropertiesResou...

Name	Description	Value
analyticalStorageTtl	Analytical TTL.	int
conflictResolutionPolicy	The conflict resolution policy for the graph.	ConflictResolutionPolicy
defaultTtl	Default time to live	int
id	Name of the Cosmos DB Gremlin graph	string (required)
indexingPolicy	The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph	IndexingPolicy
partitionKey	The configuration of the partition key to be used for partitioning data into multiple partitions	ContainerPartitionKey
uniqueKeyPolicy	The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.	UniqueKeyPolicy

ConflictResolutionPolicy

Name	Description	Value
conflictResolutionPath	The conflict resolution path in the case of LastWriterWins mode.	string
conflictResolutionProcedure	The procedure to resolve conflicts in the case of custom mode.	string
mode	Indicates the conflict resolution mode.	'Custom' 'LastWriterWins'

IndexingPolicy

Name	Description	Value
automatic	Indicates if the indexing policy is automatic	bool
compositeIndexes	List of composite path list	CompositePath[]
excludedPaths	List of paths to exclude from indexing	ExcludedPath[]
includedPaths	List of paths to include in the indexing	IncludedPath[]
indexingMode	Indicates the indexing mode.	'consistent' 'lazy' 'none'
spatialIndexes	List of spatial specifics	SpatialSpec[]

CompositePath

Name	Description	Value
order	Sort order for composite paths.	'ascending' 'descending'
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string

ExcludedPath

Name	Description	Value
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string

IncludedPath

Name	Description	Value
indexes	List of indexes for this path	Indexes[]
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string

Indexes

Name	Description	Value
dataType	The datatype for which the indexing behavior is applied to.	'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String'
kind	Indicates the type of index.	'Hash' 'Range' 'Spatial'
precision	The precision of the index. -1 is maximum precision.	int

SpatialSpec

Name	Description	Value
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string
types	List of path's spatial type	String array containing any of: 'LineString' 'MultiPolygon' 'Point' 'Polygon'

ContainerPartitionKey

Name	Description	Value
kind	Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create	'Hash' 'MultiHash' 'Range'
paths	List of paths using which data within the container can be partitioned	string[]
version	Indicates the version of the partition key definition	int Constraints: Min value = 1 Max value = 2

UniqueKeyPolicy

Name	Description	Value
uniqueKeys	List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.	UniqueKey[]

UniqueKey

Name	Description	Value
paths	List of paths must be unique for each document in the Azure Cosmos DB service	string[]

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create an Azure Cosmos DB account for Gremlin API	This template creates an Azure Cosmos DB account for Gremlin API in two regions with one database and one graph using dedicated throughput.
Create an Azure Cosmos DB account for Gremlin API autoscale	This template creates an Azure Cosmos DB account for Gremlin API in two regions with one database and one graph using autoscale throughput.

ARM template resource definition

The databaseAccounts/gremlinDatabases/graphs resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs resource, add the following JSON to your template.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
  "apiVersion": "2023-09-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"
      },
      "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" ]
          }
        ]
      }
    }
  }
}

Property values

databaseAccounts/gremlinDatabases/graphs

Name	Description	Value
type	The resource type	'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs'
apiVersion	The resource api version	'2023-09-15'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required)
location	The location of the resource group to which the resource belongs.	string
tags	Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".	Dictionary of tag names and values. See Tags in templates
properties	Properties to create and update Azure Cosmos DB Gremlin graph.	GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (required)

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...

Name	Description	Value
options	A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.	CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...
resource	The standard JSON format of a Gremlin graph	GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (required)

CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...

Name	Description	Value
autoscaleSettings	Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both.	AutoscaleSettings
throughput	Request Units per second. For example, "throughput": 10000.	int

AutoscaleSettings

Name	Description	Value
maxThroughput	Represents maximum throughput, the resource can scale up to.	int

GremlinGraphResourceOrGremlinGraphGetPropertiesResou...

Name	Description	Value
analyticalStorageTtl	Analytical TTL.	int
conflictResolutionPolicy	The conflict resolution policy for the graph.	ConflictResolutionPolicy
defaultTtl	Default time to live	int
id	Name of the Cosmos DB Gremlin graph	string (required)
indexingPolicy	The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph	IndexingPolicy
partitionKey	The configuration of the partition key to be used for partitioning data into multiple partitions	ContainerPartitionKey
uniqueKeyPolicy	The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.	UniqueKeyPolicy

ConflictResolutionPolicy

Name	Description	Value
conflictResolutionPath	The conflict resolution path in the case of LastWriterWins mode.	string
conflictResolutionProcedure	The procedure to resolve conflicts in the case of custom mode.	string
mode	Indicates the conflict resolution mode.	'Custom' 'LastWriterWins'

IndexingPolicy

Name	Description	Value
automatic	Indicates if the indexing policy is automatic	bool
compositeIndexes	List of composite path list	CompositePath[]
excludedPaths	List of paths to exclude from indexing	ExcludedPath[]
includedPaths	List of paths to include in the indexing	IncludedPath[]
indexingMode	Indicates the indexing mode.	'consistent' 'lazy' 'none'
spatialIndexes	List of spatial specifics	SpatialSpec[]

CompositePath

Name	Description	Value
order	Sort order for composite paths.	'ascending' 'descending'
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string

ExcludedPath

Name	Description	Value
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string

IncludedPath

Name	Description	Value
indexes	List of indexes for this path	Indexes[]
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string

Indexes

Name	Description	Value
dataType	The datatype for which the indexing behavior is applied to.	'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String'
kind	Indicates the type of index.	'Hash' 'Range' 'Spatial'
precision	The precision of the index. -1 is maximum precision.	int

SpatialSpec

Name	Description	Value
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string
types	List of path's spatial type	String array containing any of: 'LineString' 'MultiPolygon' 'Point' 'Polygon'

ContainerPartitionKey

Name	Description	Value
kind	Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create	'Hash' 'MultiHash' 'Range'
paths	List of paths using which data within the container can be partitioned	string[]
version	Indicates the version of the partition key definition	int Constraints: Min value = 1 Max value = 2

UniqueKeyPolicy

Name	Description	Value
uniqueKeys	List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.	UniqueKey[]

UniqueKey

Name	Description	Value
paths	List of paths must be unique for each document in the Azure Cosmos DB service	string[]

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create an Azure Cosmos DB account for Gremlin API	This template creates an Azure Cosmos DB account for Gremlin API in two regions with one database and one graph using dedicated throughput.
Create an Azure Cosmos DB account for Gremlin API autoscale	This template creates an Azure Cosmos DB account for Gremlin API in two regions with one database and one graph using autoscale throughput.

Terraform (AzAPI provider) resource definition

The databaseAccounts/gremlinDatabases/graphs resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2023-09-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"
        }
        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"
              ]
            }
          ]
        }
      }
    }
  })
}

Property values

databaseAccounts/gremlinDatabases/graphs

Name	Description	Value
type	The resource type	"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2023-09-15"
name	The resource name	string (required)
location	The location of the resource group to which the resource belongs.	string
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: gremlinDatabases
tags	Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".	Dictionary of tag names and values.
properties	Properties to create and update Azure Cosmos DB Gremlin graph.	GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (required)

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...

Name	Description	Value
options	A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.	CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...
resource	The standard JSON format of a Gremlin graph	GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (required)

CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...

Name	Description	Value
autoscaleSettings	Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both.	AutoscaleSettings
throughput	Request Units per second. For example, "throughput": 10000.	int

AutoscaleSettings

Name	Description	Value
maxThroughput	Represents maximum throughput, the resource can scale up to.	int

GremlinGraphResourceOrGremlinGraphGetPropertiesResou...

Name	Description	Value
analyticalStorageTtl	Analytical TTL.	int
conflictResolutionPolicy	The conflict resolution policy for the graph.	ConflictResolutionPolicy
defaultTtl	Default time to live	int
id	Name of the Cosmos DB Gremlin graph	string (required)
indexingPolicy	The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph	IndexingPolicy
partitionKey	The configuration of the partition key to be used for partitioning data into multiple partitions	ContainerPartitionKey
uniqueKeyPolicy	The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.	UniqueKeyPolicy

ConflictResolutionPolicy

Name	Description	Value
conflictResolutionPath	The conflict resolution path in the case of LastWriterWins mode.	string
conflictResolutionProcedure	The procedure to resolve conflicts in the case of custom mode.	string
mode	Indicates the conflict resolution mode.	"Custom" "LastWriterWins"

IndexingPolicy

Name	Description	Value
automatic	Indicates if the indexing policy is automatic	bool
compositeIndexes	List of composite path list	CompositePath[]
excludedPaths	List of paths to exclude from indexing	ExcludedPath[]
includedPaths	List of paths to include in the indexing	IncludedPath[]
indexingMode	Indicates the indexing mode.	"consistent" "lazy" "none"
spatialIndexes	List of spatial specifics	SpatialSpec[]

CompositePath

Name	Description	Value
order	Sort order for composite paths.	"ascending" "descending"
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string

ExcludedPath

Name	Description	Value
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string

IncludedPath

Name	Description	Value
indexes	List of indexes for this path	Indexes[]
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string

Indexes

Name	Description	Value
dataType	The datatype for which the indexing behavior is applied to.	"LineString" "MultiPolygon" "Number" "Point" "Polygon" "String"
kind	Indicates the type of index.	"Hash" "Range" "Spatial"
precision	The precision of the index. -1 is maximum precision.	int

SpatialSpec

Name	Description	Value
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string
types	List of path's spatial type	String array containing any of: "LineString" "MultiPolygon" "Point" "Polygon"

ContainerPartitionKey

Name	Description	Value
kind	Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create	"Hash" "MultiHash" "Range"
paths	List of paths using which data within the container can be partitioned	string[]
version	Indicates the version of the partition key definition	int Constraints: Min value = 1 Max value = 2

UniqueKeyPolicy

Name	Description	Value
uniqueKeys	List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.	UniqueKey[]

UniqueKey

Name	Description	Value
paths	List of paths must be unique for each document in the Azure Cosmos DB service	string[]