Gremlin Resources - List Gremlin Graphs

Service:: Cosmos DB Resource Provider

API Version:: 2024-11-15

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs?api-version=2024-11-15

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB database account name.
databaseName	path	True	string	Cosmos DB database name.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	GremlinGraphListResult	The Gremlin graph properties were retrieved successfully.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Impersonate your user account

Examples

CosmosDBGremlinGraphList

Sample request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/graphs?api-version=2024-11-15


/**
 * Samples for GremlinResources ListGremlinGraphs.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBGremlinGraphList
     * .json
     */
    /**
     * Sample code: CosmosDBGremlinGraphList.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBGremlinGraphList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getGremlinResources().listGremlinGraphs("rgName", "ddb1",
            "databaseName", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_gremlin_graph_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.gremlin_resources.list_gremlin_graphs(
        resource_group_name="rgName",
        account_name="ddb1",
        database_name="databaseName",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBGremlinGraphList.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ded6306d00ae294c24211e5069c1f56b15ba8ef5/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBGremlinGraphList.json
func ExampleGremlinResourcesClient_NewListGremlinGraphsPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewGremlinResourcesClient().NewListGremlinGraphsPager("rgName", "ddb1", "databaseName", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.GremlinGraphListResult = armcosmos.GremlinGraphListResult{
		// 	Value: []*armcosmos.GremlinGraphGetResults{
		// 		{
		// 			Name: to.Ptr("testgrf"),
		// 			Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs"),
		// 			ID: to.Ptr("testgrf"),
		// 			Properties: &armcosmos.GremlinGraphGetProperties{
		// 				Resource: &armcosmos.GremlinGraphGetPropertiesResource{
		// 					Etag: to.Ptr("\"00005900-0000-0000-0000-56f9a2630000\""),
		// 					Rid: to.Ptr("PD5DALigDgw="),
		// 					Ts: to.Ptr[float32](1459200611),
		// 					ConflictResolutionPolicy: &armcosmos.ConflictResolutionPolicy{
		// 						ConflictResolutionPath: to.Ptr("/path"),
		// 						Mode: to.Ptr(armcosmos.ConflictResolutionModeLastWriterWins),
		// 					},
		// 					DefaultTTL: to.Ptr[int32](100),
		// 					ID: to.Ptr("testgrf"),
		// 					IndexingPolicy: &armcosmos.IndexingPolicy{
		// 						Automatic: to.Ptr(true),
		// 						ExcludedPaths: []*armcosmos.ExcludedPath{
		// 						},
		// 						IncludedPaths: []*armcosmos.IncludedPath{
		// 							{
		// 								Path: to.Ptr("/*"),
		// 								Indexes: []*armcosmos.Indexes{
		// 									{
		// 										DataType: to.Ptr(armcosmos.DataTypeString),
		// 										Kind: to.Ptr(armcosmos.IndexKindRange),
		// 										Precision: to.Ptr[int32](-1),
		// 									},
		// 									{
		// 										DataType: to.Ptr(armcosmos.DataTypeNumber),
		// 										Kind: to.Ptr(armcosmos.IndexKindRange),
		// 										Precision: to.Ptr[int32](-1),
		// 								}},
		// 						}},
		// 						IndexingMode: to.Ptr(armcosmos.IndexingModeConsistent),
		// 					},
		// 					PartitionKey: &armcosmos.ContainerPartitionKey{
		// 						Kind: to.Ptr(armcosmos.PartitionKindHash),
		// 						Paths: []*string{
		// 							to.Ptr("/AccountNumber")},
		// 						},
		// 						UniqueKeyPolicy: &armcosmos.UniqueKeyPolicy{
		// 							UniqueKeys: []*armcosmos.UniqueKey{
		// 								{
		// 									Paths: []*string{
		// 										to.Ptr("/testPath")},
		// 								}},
		// 							},
		// 						},
		// 					},
		// 			}},
		// 		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists the Gremlin graph under an existing Azure Cosmos DB database account.
 *
 * @summary Lists the Gremlin graph under an existing Azure Cosmos DB database account.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBGremlinGraphList.json
 */
async function cosmosDbGremlinGraphList() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rgName";
  const accountName = "ddb1";
  const databaseName = "databaseName";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.gremlinResources.listGremlinGraphs(
    resourceGroupName,
    accountName,
    databaseName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "testgrf",
      "name": "testgrf",
      "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs",
      "properties": {
        "resource": {
          "id": "testgrf",
          "indexingPolicy": {
            "indexingMode": "consistent",
            "automatic": true,
            "includedPaths": [
              {
                "path": "/*",
                "indexes": [
                  {
                    "kind": "Range",
                    "dataType": "String",
                    "precision": -1
                  },
                  {
                    "kind": "Range",
                    "dataType": "Number",
                    "precision": -1
                  }
                ]
              }
            ],
            "excludedPaths": []
          },
          "partitionKey": {
            "paths": [
              "/AccountNumber"
            ],
            "kind": "Hash"
          },
          "defaultTtl": 100,
          "uniqueKeyPolicy": {
            "uniqueKeys": [
              {
                "paths": [
                  "/testPath"
                ]
              }
            ]
          },
          "conflictResolutionPolicy": {
            "mode": "LastWriterWins",
            "conflictResolutionPath": "/path"
          },
          "_rid": "PD5DALigDgw=",
          "_ts": 1459200611,
          "_etag": "\"00005900-0000-0000-0000-56f9a2630000\""
        }
      }
    }
  ]
}

Definitions

Name	Description
AutoscaleSettings
CompositePath
CompositePathSortOrder	Sort order for composite paths.
ConflictResolutionMode	Indicates the conflict resolution mode.
ConflictResolutionPolicy	The conflict resolution policy for the container.
ContainerPartitionKey	The configuration of the partition key to be used for partitioning data into multiple partitions
CreateMode	Enum to indicate the mode of account creation.
DataType	The datatype for which the indexing behavior is applied to.
ExcludedPath
GremlinGraphGetResults	List of graphs and their properties.
GremlinGraphListResult	The List operation response, that contains the graphs and their properties.
IncludedPath	The paths that are included in indexing
Indexes	The indexes for the path.
IndexingMode	Indicates the indexing mode.
IndexingPolicy	Cosmos DB indexing policy
IndexKind	Indicates the type of index.
Options
PartitionKind	Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
Resource
ResourceRestoreParameters	Parameters to indicate the information about the restore.
SpatialSpec
SpatialType	Indicates the spatial type of index.
UniqueKey	The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
UniqueKeyPolicy	The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
VectorIndex
VectorIndexType	The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.

AutoscaleSettings

Object

Name	Type	Description
maxThroughput	integer	Represents maximum throughput, the resource can scale up to.

CompositePath

Object

Name	Type	Description
order	CompositePathSortOrder	Sort order for composite paths.
path	string	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

CompositePathSortOrder

Enumeration

Sort order for composite paths.

Value	Description
ascending
descending

ConflictResolutionMode

Enumeration

Indicates the conflict resolution mode.

Value	Description
LastWriterWins
Custom

ConflictResolutionPolicy

Object

The conflict resolution policy for the container.

Name	Type	Default value	Description
conflictResolutionPath	string		The conflict resolution path in the case of LastWriterWins mode.
conflictResolutionProcedure	string		The procedure to resolve conflicts in the case of custom mode.
mode	ConflictResolutionMode	LastWriterWins	Indicates the conflict resolution mode.

ContainerPartitionKey

Object

The configuration of the partition key to be used for partitioning data into multiple partitions

Name	Type	Default value	Description
kind	PartitionKind	Hash	Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
paths	string[]		List of paths using which data within the container can be partitioned
systemKey	boolean		Indicates if the container is using a system generated partition key
version	integer (int32) minimum: 1 maximum: 2		Indicates the version of the partition key definition

CreateMode

Enumeration

Enum to indicate the mode of account creation.

Value	Description
Default
Restore

DataType

Enumeration

The datatype for which the indexing behavior is applied to.

Value	Description
String
Number
Point
Polygon
LineString
MultiPolygon

ExcludedPath

Object

Name	Type	Description
path	string	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

GremlinGraphGetResults

Object

List of graphs and their properties.

Name	Type	Description
id	string	The unique resource identifier of the ARM resource.
location	string	The location of the resource group to which the resource belongs.
name	string	The name of the ARM resource.
properties.options	Options
properties.resource	Resource
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 Azure resource.

GremlinGraphListResult

Object

The List operation response, that contains the graphs and their properties.

Name	Type	Description
value	GremlinGraphGetResults[]	List of graphs and their properties.

IncludedPath

Object

The paths that are included in indexing

Name	Type	Description
indexes	Indexes[]	List of indexes for this path
path	string	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

Indexes

Object

The indexes for the path.

Name	Type	Default value	Description
dataType	DataType	String	The datatype for which the indexing behavior is applied to.
kind	IndexKind	Hash	Indicates the type of index.
precision	integer		The precision of the index. -1 is maximum precision.

IndexingMode

Enumeration

Indicates the indexing mode.

Value	Description
consistent
lazy
none

IndexingPolicy

Object

Cosmos DB indexing policy

Name	Type	Default value	Description
automatic	boolean		Indicates if the indexing policy is automatic
compositeIndexes	CompositePath[]		List of composite path list
excludedPaths	ExcludedPath[]		List of paths to exclude from indexing
includedPaths	IncludedPath[]		List of paths to include in the indexing
indexingMode	IndexingMode	consistent	Indicates the indexing mode.
spatialIndexes	SpatialSpec[]		List of spatial specifics
vectorIndexes	VectorIndex[]		List of paths to include in the vector indexing

IndexKind

Enumeration

Indicates the type of index.

Value	Description
Hash
Range
Spatial

Options

Object

Name	Type	Description
autoscaleSettings	AutoscaleSettings	Specifies the Autoscale settings.
throughput	integer	Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.

PartitionKind

Enumeration

Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create

Value	Description
Hash
Range
MultiHash

Resource

Object

Name	Type	Default value	Description
_etag	string		A system generated property representing the resource etag required for optimistic concurrency control.
_rid	string		A system generated property. A unique identifier.
_ts	number		A system generated property that denotes the last updated timestamp of the resource.
analyticalStorageTtl	integer (int64)		Analytical TTL.
conflictResolutionPolicy	ConflictResolutionPolicy		The conflict resolution policy for the graph.
createMode	CreateMode	Default	Enum to indicate the mode of resource creation.
defaultTtl	integer		Default time to live
id	string		Name of the Cosmos DB Gremlin graph
indexingPolicy	IndexingPolicy		The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
partitionKey	ContainerPartitionKey		The configuration of the partition key to be used for partitioning data into multiple partitions
restoreParameters	ResourceRestoreParameters		Parameters to indicate the information about the restore
uniqueKeyPolicy	UniqueKeyPolicy		The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.

ResourceRestoreParameters

Object

Parameters to indicate the information about the restore.

Name	Type	Description
restoreSource	string	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}
restoreTimestampInUtc	string (date-time)	Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled	boolean	Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.

SpatialSpec

Object

Name	Type	Description
path	string	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
types	SpatialType[]	List of path's spatial type

SpatialType

Enumeration

Indicates the spatial type of index.

Value	Description
Point
LineString
Polygon
MultiPolygon

UniqueKey

Object

The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

Name	Type	Description
paths	string[]	List of paths must be unique for each document in the Azure Cosmos DB service

UniqueKeyPolicy

Object

The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.

Name	Type	Description
uniqueKeys	UniqueKey[]	List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

VectorIndex

Object

Name	Type	Description
path	string	The path to the vector field in the document.
type	VectorIndexType	The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.

VectorIndexType

Enumeration

The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.

Value	Description
flat
diskANN
quantizedFlat

Share via

Gremlin Resources - List Gremlin Graphs

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

CosmosDBGremlinGraphList

Sample request

Sample response

Definitions

AutoscaleSettings

CompositePath

CompositePathSortOrder

ConflictResolutionMode

ConflictResolutionPolicy

ContainerPartitionKey

CreateMode

DataType

ExcludedPath

GremlinGraphGetResults

GremlinGraphListResult

IncludedPath

Indexes

IndexingMode

IndexingPolicy

IndexKind

Options

PartitionKind

Resource

ResourceRestoreParameters

SpatialSpec

SpatialType

UniqueKey

UniqueKeyPolicy

VectorIndex

VectorIndexType