The databaseAccounts/gremlinDatabases/graphs resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs resource, add the following JSON to your template.
{
"type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
"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",
"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",
"restoreWithTtlDisabled": "bool"
},
"uniqueKeyPolicy": {
"uniqueKeys": [
{
"paths": [ "string" ]
}
]
}
}
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs' |
apiVersion | The resource api version | '2024-02-15-preview' |
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 |
identity | Identity for the resource. | ManagedServiceIdentity |
properties | Properties to create and update Azure Cosmos DB Gremlin graph. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (required) |
Name | Description | Value |
---|---|---|
type | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned': The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. |
|
userAssignedIdentities | The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | ManagedServiceIdentityUserAssignedIdentities |
Name | Description | Value |
---|---|---|
{customized property} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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) |
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 |
Name | Description | Value |
---|---|---|
maxThroughput | Represents maximum throughput, the resource can scale up to. | int |
Name | Description | Value |
---|---|---|
analyticalStorageTtl | Analytical TTL. | int |
conflictResolutionPolicy | The conflict resolution policy for the graph. | ConflictResolutionPolicy |
createMode | Enum to indicate the mode of resource creation. | 'Default' 'PointInTimeRestore' 'Restore' |
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 |
restoreParameters | Parameters to indicate the information about the restore | ResourceRestoreParameters |
uniqueKeyPolicy | The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. | UniqueKeyPolicy |
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' |
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[] |
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 |
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 |
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 |
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 |
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' |
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 |
Name | Description | Value |
---|---|---|
restoreSource | The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
restoreTimestampInUtc | Time to which the account has to be restored (ISO-8601 format). | string |
restoreWithTtlDisabled | Specifies whether the restored account will have Time-To-Live disabled upon the successful restore. | bool |
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[] |
Name | Description | Value |
---|---|---|
paths | List of paths must be unique for each document in the Azure Cosmos DB service | string[] |
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. |