Partager via

Microsoft.DocumentDB databaseAccounts/gremlinDatabases 2024-12-01-preview

  • 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-12-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      createMode: 'string'
      id: 'string'
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

AutoscaleSettings

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name Description Value

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

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

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

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

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

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

ManagedServiceIdentity

Name Description Value
type 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. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
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

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Name Description Value
identity Identity for the resource. ManagedServiceIdentity
location The location of the resource group to which the resource belongs. string
name The resource name string (required)
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. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

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
restoreWithTtlDisabled Specifies whether the restored account will have Time-To-Live disabled upon the successful restore. bool

Tags

Name Description Value

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File 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 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-12-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "createMode": "string",
      "id": "string",
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

AutoscaleSettings

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name Description Value

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

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

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

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

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

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

ManagedServiceIdentity

Name Description Value
type 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. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
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

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Name Description Value
apiVersion The api version '2024-12-01-preview'
identity Identity for the resource. ManagedServiceIdentity
location The location of the resource group to which the resource belongs. string
name The resource name string (required)
properties Properties to create and update Azure Cosmos DB Gremlin database. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases'

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
restoreWithTtlDisabled Specifies whether the restored account will have Time-To-Live disabled upon the successful restore. bool

Tags

Name Description Value

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-12-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        createMode = "string"
        id = "string"
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
      }
    }
  })
}

Property values

AutoscaleSettings

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name Description Value

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

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

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

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

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

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

ManagedServiceIdentity

Name Description Value
type 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. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
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

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Name Description Value
identity Identity for the resource. ManagedServiceIdentity
location The location of the resource group to which the resource belongs. string
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: databaseAccounts
properties Properties to create and update Azure Cosmos DB Gremlin database. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-12-01-preview"

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
restoreWithTtlDisabled Specifies whether the restored account will have Time-To-Live disabled upon the successful restore. bool

Tags

Name Description Value