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.
To create a Microsoft.DocumentDB/databaseAccounts/gremlinDatabases resource, add the following JSON to your template.
{
"type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases",
"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": {
"createMode": "string",
"id": "string",
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string",
"restoreWithTtlDisabled": "bool"
}
}
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases' |
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 database. | GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (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. | CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt... |
resource | The standard JSON format of a Gremlin database | GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (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 |
---|---|---|
createMode | Enum to indicate the mode of resource creation. | 'Default' 'PointInTimeRestore' 'Restore' |
id | Name of the Cosmos DB Gremlin database | string (required) |
restoreParameters | Parameters to indicate the information about the restore | 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 |
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. |