gremlin_resources

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

Overview

Name	gremlin_resources
Type	Resource
Id	azure.cosmosdb.gremlin_resources

Fields

The following fields are returned by SELECT queries:

get_gremlin_graph_throughput

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
identity	object	Identity for the resource.
location	string	The location of the resource group to which the resource belongs.
resource	object	:vartype resource: ~azure.mgmt.cosmosdb.models.ThroughputSettingsGetPropertiesResource
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	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".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_gremlin_graphs

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
identity	object	Identity for the resource.
location	string	The location of the resource group to which the resource belongs.
options	object	:vartype options: ~azure.mgmt.cosmosdb.models.GremlinGraphGetPropertiesOptions
resource	object	:vartype resource: ~azure.mgmt.cosmosdb.models.GremlinGraphGetPropertiesResource
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	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".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_gremlin_role_definition

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
assignableScopes	array	A set of fully qualified Scopes at or below which Gremlin Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist.
permissions	array	The set of operations allowed through this Role Definition.
roleName	string	A user-friendly name for the Role Definition. Must be unique for the database account.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_gremlin_role_assignment

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
principalId	string	The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Gremlin Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.
provisioningState	string	Provisioning state of the resource.
roleDefinitionId	string	The unique identifier for the associated Role Definition.
scope	string	The data plane resource path for which access is being granted through this Gremlin Role Assignment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_gremlin_databases

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
identity	object	Identity for the resource.
location	string	The location of the resource group to which the resource belongs.
options	object	:vartype options: ~azure.mgmt.cosmosdb.models.GremlinDatabaseGetPropertiesOptions
resource	object	:vartype resource: ~azure.mgmt.cosmosdb.models.GremlinDatabaseGetPropertiesResource
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	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".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_gremlin_graph_throughput	select	resource_group_name, account_name, database_name, graph_name, subscription_id		Gets the Gremlin graph throughput under an existing Azure Cosmos DB database account with the provided name.
list_gremlin_graphs	select	resource_group_name, account_name, database_name, subscription_id		Lists the Gremlin graph under an existing Azure Cosmos DB database account.
get_gremlin_role_definition	select	resource_group_name, account_name, role_definition_id, subscription_id		Retrieves the properties of an existing Azure Cosmos DB Gremlin Role Definition with the given Id.
get_gremlin_role_assignment	select	resource_group_name, account_name, role_assignment_id, subscription_id		Retrieves the properties of an existing Azure Cosmos DB Gremlin Role Assignment with the given Id.
list_gremlin_databases	select	resource_group_name, account_name, subscription_id		Lists the Gremlin databases under an existing Azure Cosmos DB database account.
list_gremlin_role_definitions	exec	resource_group_name, account_name, subscription_id		Retrieves the list of all Azure Cosmos DB Gremlin Role Definitions.
list_gremlin_role_assignments	exec	resource_group_name, account_name, subscription_id		Retrieves the list of all Azure Cosmos DB Gremlin Role Assignments.
get_gremlin_database_throughput	exec	resource_group_name, account_name, database_name, subscription_id		Gets the RUs per second of the Gremlin database under an existing Azure Cosmos DB database account with the provided name.
update_gremlin_database_throughput	exec	resource_group_name, account_name, database_name, subscription_id, properties		Update RUs per second of an Azure Cosmos DB Gremlin database.
update_gremlin_graph_throughput	exec	resource_group_name, account_name, database_name, graph_name, subscription_id, properties		Update RUs per second of an Azure Cosmos DB Gremlin graph.
get_gremlin_database	exec	resource_group_name, account_name, database_name, subscription_id		Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name.
create_update_gremlin_database	exec	resource_group_name, account_name, database_name, subscription_id, properties		Create or update an Azure Cosmos DB Gremlin database.
delete_gremlin_database	exec	resource_group_name, account_name, database_name, subscription_id		Deletes an existing Azure Cosmos DB Gremlin database.
get_gremlin_graph	exec	resource_group_name, account_name, database_name, graph_name, subscription_id		Gets the Gremlin graph under an existing Azure Cosmos DB database account.
create_update_gremlin_graph	exec	resource_group_name, account_name, database_name, graph_name, subscription_id, properties		Create or update an Azure Cosmos DB Gremlin graph.
delete_gremlin_graph	exec	resource_group_name, account_name, database_name, graph_name, subscription_id		Deletes an existing Azure Cosmos DB Gremlin graph.
create_update_gremlin_role_definition	exec	resource_group_name, account_name, role_definition_id, subscription_id		Creates or updates an Azure Cosmos DB Gremlin Role Definition.
delete_gremlin_role_definition	exec	resource_group_name, account_name, role_definition_id, subscription_id		Deletes an existing Azure Cosmos DB Gremlin Role Definition.
create_update_gremlin_role_assignment	exec	resource_group_name, account_name, role_assignment_id, subscription_id		Creates or updates an Azure Cosmos DB Gremlin Role Assignment.
delete_gremlin_role_assignment	exec	resource_group_name, account_name, role_assignment_id, subscription_id		Deletes an existing Azure Cosmos DB Gremlin Role Assignment.
migrate_gremlin_database_to_autoscale	exec	resource_group_name, account_name, database_name, subscription_id		Migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale.
migrate_gremlin_database_to_manual_throughput	exec	resource_group_name, account_name, database_name, subscription_id		Migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput.
migrate_gremlin_graph_to_autoscale	exec	resource_group_name, account_name, database_name, graph_name, subscription_id		Migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale.
migrate_gremlin_graph_to_manual_throughput	exec	resource_group_name, account_name, database_name, graph_name, subscription_id		Migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput.
retrieve_continuous_backup_information	exec	resource_group_name, account_name, database_name, graph_name, subscription_id		Retrieves continuous backup information for a gremlin graph.

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
account_name	string	Cosmos DB database account name. Required.
database_name	string	Cosmos DB database name. Required.
graph_name	string	Cosmos DB graph name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
role_assignment_id	string	The GUID for the Role Assignment. Required.
role_definition_id	string	The GUID for the Role Definition. Required.
subscription_id	string

SELECT examples

get_gremlin_graph_throughput

Gets the Gremlin graph throughput under an existing Azure Cosmos DB database account with the provided name.

SELECT
id,
name,
identity,
location,
resource,
systemData,
tags,
type
FROM azure.cosmosdb.gremlin_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND graph_name = '{{ graph_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_gremlin_graphs

Lists the Gremlin graph under an existing Azure Cosmos DB database account.

SELECT
id,
name,
identity,
location,
options,
resource,
systemData,
tags,
type
FROM azure.cosmosdb.gremlin_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_gremlin_role_definition

Retrieves the properties of an existing Azure Cosmos DB Gremlin Role Definition with the given Id.

SELECT
id,
name,
assignableScopes,
permissions,
roleName,
systemData,
type
FROM azure.cosmosdb.gremlin_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND role_definition_id = '{{ role_definition_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_gremlin_role_assignment

Retrieves the properties of an existing Azure Cosmos DB Gremlin Role Assignment with the given Id.

SELECT
id,
name,
principalId,
provisioningState,
roleDefinitionId,
scope,
systemData,
type
FROM azure.cosmosdb.gremlin_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND role_assignment_id = '{{ role_assignment_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_gremlin_databases

Lists the Gremlin databases under an existing Azure Cosmos DB database account.

SELECT
id,
name,
identity,
location,
options,
resource,
systemData,
tags,
type
FROM azure.cosmosdb.gremlin_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

list_gremlin_role_definitions

Retrieves the list of all Azure Cosmos DB Gremlin Role Definitions.

EXEC azure.cosmosdb.gremlin_resources.list_gremlin_role_definitions 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_gremlin_role_assignments

Retrieves the list of all Azure Cosmos DB Gremlin Role Assignments.

EXEC azure.cosmosdb.gremlin_resources.list_gremlin_role_assignments 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_gremlin_database_throughput

Gets the RUs per second of the Gremlin database under an existing Azure Cosmos DB database account with the provided name.

EXEC azure.cosmosdb.gremlin_resources.get_gremlin_database_throughput 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update_gremlin_database_throughput

Update RUs per second of an Azure Cosmos DB Gremlin database.

EXEC azure.cosmosdb.gremlin_resources.update_gremlin_database_throughput 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}", 
"properties": "{{ properties }}"
}'
;

update_gremlin_graph_throughput

Update RUs per second of an Azure Cosmos DB Gremlin graph.

EXEC azure.cosmosdb.gremlin_resources.update_gremlin_graph_throughput 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@graph_name='{{ graph_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}", 
"properties": "{{ properties }}"
}'
;

get_gremlin_database

Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name.

EXEC azure.cosmosdb.gremlin_resources.get_gremlin_database 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_update_gremlin_database

Create or update an Azure Cosmos DB Gremlin database.

EXEC azure.cosmosdb.gremlin_resources.create_update_gremlin_database 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}", 
"properties": "{{ properties }}"
}'
;

delete_gremlin_database

Deletes an existing Azure Cosmos DB Gremlin database.

EXEC azure.cosmosdb.gremlin_resources.delete_gremlin_database 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_gremlin_graph

Gets the Gremlin graph under an existing Azure Cosmos DB database account.

EXEC azure.cosmosdb.gremlin_resources.get_gremlin_graph 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@graph_name='{{ graph_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_update_gremlin_graph

Create or update an Azure Cosmos DB Gremlin graph.

EXEC azure.cosmosdb.gremlin_resources.create_update_gremlin_graph 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@graph_name='{{ graph_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}", 
"properties": "{{ properties }}"
}'
;

delete_gremlin_graph

Deletes an existing Azure Cosmos DB Gremlin graph.

EXEC azure.cosmosdb.gremlin_resources.delete_gremlin_graph 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@graph_name='{{ graph_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_update_gremlin_role_definition

Creates or updates an Azure Cosmos DB Gremlin Role Definition.

EXEC azure.cosmosdb.gremlin_resources.create_update_gremlin_role_definition 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@role_definition_id='{{ role_definition_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

delete_gremlin_role_definition

Deletes an existing Azure Cosmos DB Gremlin Role Definition.

EXEC azure.cosmosdb.gremlin_resources.delete_gremlin_role_definition 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@role_definition_id='{{ role_definition_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_update_gremlin_role_assignment

Creates or updates an Azure Cosmos DB Gremlin Role Assignment.

EXEC azure.cosmosdb.gremlin_resources.create_update_gremlin_role_assignment 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@role_assignment_id='{{ role_assignment_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

delete_gremlin_role_assignment

Deletes an existing Azure Cosmos DB Gremlin Role Assignment.

EXEC azure.cosmosdb.gremlin_resources.delete_gremlin_role_assignment 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@role_assignment_id='{{ role_assignment_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

migrate_gremlin_database_to_autoscale

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

EXEC azure.cosmosdb.gremlin_resources.migrate_gremlin_database_to_autoscale 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

migrate_gremlin_database_to_manual_throughput

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

EXEC azure.cosmosdb.gremlin_resources.migrate_gremlin_database_to_manual_throughput 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

migrate_gremlin_graph_to_autoscale

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

EXEC azure.cosmosdb.gremlin_resources.migrate_gremlin_graph_to_autoscale 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@graph_name='{{ graph_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

migrate_gremlin_graph_to_manual_throughput

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

EXEC azure.cosmosdb.gremlin_resources.migrate_gremlin_graph_to_manual_throughput 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@graph_name='{{ graph_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

retrieve_continuous_backup_information

Retrieves continuous backup information for a gremlin graph.

EXEC azure.cosmosdb.gremlin_resources.retrieve_continuous_backup_information 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@graph_name='{{ graph_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}"
}'
;