gremlin_resources

Creates, updates, deletes, gets or lists a gremlin_resources resource.

Overview

Name	gremlin_resources
Type	Resource
Id	azure.cosmos_db.gremlin_resources

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
retrieve_continuous_backup_information	exec	subscriptionId, resourceGroupName, accountName, databaseName, graphName		Retrieves continuous backup information for a gremlin graph.
migrate_gremlin_database_to_autoscale	exec	subscriptionId, resourceGroupName, accountName, databaseName		Migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale
migrate_gremlin_database_to_manual_throughput	exec	subscriptionId, resourceGroupName, accountName, databaseName		Migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput
migrate_gremlin_graph_to_autoscale	exec	subscriptionId, resourceGroupName, accountName, databaseName, graphName		Migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale
migrate_gremlin_graph_to_manual_throughput	exec	subscriptionId, resourceGroupName, accountName, databaseName, graphName		Migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
accountName	string	Cosmos DB database account name.
databaseName	string	Cosmos DB database name.
graphName	string	Cosmos DB graph name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

Lifecycle Methods

retrieve_continuous_backup_information

Retrieves continuous backup information for a gremlin graph.

EXEC azure.cosmos_db.gremlin_resources.retrieve_continuous_backup_information 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@graphName='{{ graphName }}' --required 
@@json=
'{
"location": "{{ location }}"
}'
;

migrate_gremlin_database_to_autoscale

Migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale

EXEC azure.cosmos_db.gremlin_resources.migrate_gremlin_database_to_autoscale 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required
;

migrate_gremlin_database_to_manual_throughput

Migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput

EXEC azure.cosmos_db.gremlin_resources.migrate_gremlin_database_to_manual_throughput 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required
;

migrate_gremlin_graph_to_autoscale

Migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale

EXEC azure.cosmos_db.gremlin_resources.migrate_gremlin_graph_to_autoscale 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@graphName='{{ graphName }}' --required
;

migrate_gremlin_graph_to_manual_throughput

Migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput

EXEC azure.cosmos_db.gremlin_resources.migrate_gremlin_graph_to_manual_throughput 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@graphName='{{ graphName }}' --required
;