Share via

Microsoft.DocumentDB databaseAccounts/gremlinDatabases/throughputSettings 2019-08-01

  • Article

Bicep resource definition

The databaseAccounts/gremlinDatabases/throughputSettings 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/throughputSettings resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2019-08-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'default'
  properties: {
    resource: {
      throughput: int
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings

Name Description Value
location The location of the resource group to which the resource belongs. string
name The resource name 'default' (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/gremlinDatabases
properties Properties to update Azure Cosmos DB resource throughput. ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

Tags

Name Description Value

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

Name Description Value
throughput Value of the Cosmos DB resource throughput int (required)

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

Name Description Value
resource The standard JSON format of a resource throughput ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (required)

ARM template resource definition

The databaseAccounts/gremlinDatabases/throughputSettings 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/throughputSettings resource, add the following JSON to your template.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings",
  "apiVersion": "2019-08-01",
  "name": "string",
  "location": "string",
  "properties": {
    "resource": {
      "throughput": "int"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings

Name Description Value
apiVersion The api version '2019-08-01'
location The location of the resource group to which the resource belongs. string
name The resource name 'default' (required)
properties Properties to update Azure Cosmos DB resource throughput. ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings'

Tags

Name Description Value

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

Name Description Value
throughput Value of the Cosmos DB resource throughput int (required)

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

Name Description Value
resource The standard JSON format of a resource throughput ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (required)

Terraform (AzAPI provider) resource definition

The databaseAccounts/gremlinDatabases/throughputSettings 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/throughputSettings resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2019-08-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      resource = {
        throughput = int
      }
    }
  })
}

Property values

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings

Name Description Value
location The location of the resource group to which the resource belongs. string
name The resource name 'default' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: databaseAccounts/gremlinDatabases
properties Properties to update Azure Cosmos DB resource throughput. ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2019-08-01"

Tags

Name Description Value

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

Name Description Value
throughput Value of the Cosmos DB resource throughput int (required)

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

Name Description Value
resource The standard JSON format of a resource throughput ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (required)