Microsoft.DocumentDB databaseAccounts/gremlinDatabases

  • Article

Bicep resource definition

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

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

Resource format

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-05-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      createMode: 'string'
      id: 'string'
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
      }
    }
  }
}

Property values

databaseAccounts/gremlinDatabases

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: databaseAccounts
properties Properties to create and update Azure Cosmos DB Gremlin database. GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (required)

GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...

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. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
resource The standard JSON format of a Gremlin database GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (required)

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...

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

GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...

Name Description Value
createMode Enum to indicate the mode of resource creation. 'Default'
'Restore'
id Name of the Cosmos DB Gremlin database string (required)
restoreParameters Parameters to indicate the information about the restore ResourceRestoreParameters

ResourceRestoreParameters

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an Azure Cosmos DB account for Gremlin API

Deploy to Azure		 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

Deploy to Azure		 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 resource type can be deployed with operations that target:

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

Resource format

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases",
  "apiVersion": "2024-05-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "createMode": "string",
      "id": "string",
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string"
      }
    }
  }
}

Property values

databaseAccounts/gremlinDatabases

Name Description Value
type The resource type 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases'
apiVersion The resource api version '2024-05-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 database. GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (required)

GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...

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. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
resource The standard JSON format of a Gremlin database GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (required)

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...

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

GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...

Name Description Value
createMode Enum to indicate the mode of resource creation. 'Default'
'Restore'
id Name of the Cosmos DB Gremlin database string (required)
restoreParameters Parameters to indicate the information about the restore ResourceRestoreParameters

ResourceRestoreParameters

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an Azure Cosmos DB account for Gremlin API

Deploy to Azure		 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

Deploy to Azure		 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 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 resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@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 = {
        createMode = "string"
        id = "string"
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
        }
      }
    }
  })
}

Property values

databaseAccounts/gremlinDatabases

Name Description Value
type The resource type "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-05-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: databaseAccounts
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 database. GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (required)

GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...

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. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
resource The standard JSON format of a Gremlin database GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (required)

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...

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

GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...

Name Description Value
createMode Enum to indicate the mode of resource creation. "Default"
"Restore"
id Name of the Cosmos DB Gremlin database string (required)
restoreParameters Parameters to indicate the information about the restore ResourceRestoreParameters

ResourceRestoreParameters

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