Gremlin Resources - List Gremlin Graphs

Riferimento

Service:: Cosmos DB Resource Provider

API Version:: 2023-11-15

Elenchi il grafo Gremlin in un account di database Azure Cosmos DB esistente.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
accountName	path	True	string	Nome dell'account del database Cosmos DB. Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
databaseName	path	True	string	Nome del database Cosmos DB.
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	GremlinGraphListResult	Le proprietà del grafo Gremlin sono state recuperate correttamente.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	Rappresentare l'account utente

Esempio

CosmosDBGremlinGraphList

Sample Request

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


/**
 * Samples for GremlinResources ListGremlinGraphs.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-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/2023-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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-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/2023-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\""
        }
      }
    }
  ]
}

Definizioni

Nome	Descrizione
AutoscaleSettings
CompositePath
CompositePathSortOrder	Ordinare l'ordinamento per i percorsi compositi.
ConflictResolutionMode	Indica la modalità di risoluzione dei conflitti.
ConflictResolutionPolicy	Criteri di risoluzione dei conflitti per il contenitore.
ContainerPartitionKey	Configurazione della chiave di partizione da usare per il partizionamento dei dati in più partizioni
CreateMode	Enumerazione per indicare la modalità di creazione dell'account.
DataType	Tipo di dati a cui viene applicato il comportamento di indicizzazione.
ExcludedPath
GremlinGraphGetResults	Elenco di grafici e delle relative proprietà.
GremlinGraphListResult	Risposta dell'operazione List, che contiene i grafici e le relative proprietà.
IncludedPath	Percorsi inclusi nell'indicizzazione
Indexes	Indici per il percorso.
IndexingMode	Indica la modalità di indicizzazione.
IndexingPolicy	Criteri di indicizzazione di Cosmos DB
IndexKind	Indica il tipo di indice.
Options
PartitionKind	Indica il tipo di algoritmo utilizzato per il partizionamento. Per MultiHash sono supportate più chiavi di partizione (fino a tre al massimo) per la creazione del contenitore
Resource
ResourceRestoreParameters	Parametri per indicare le informazioni sul ripristino.
SpatialSpec
SpatialType	Indica il tipo spaziale di indice.
UniqueKey	Chiave univoca su che impone vincoli di univocità per i documenti nella raccolta nel servizio Azure Cosmos DB.
UniqueKeyPolicy	Configurazione dei criteri chiave univoca per specificare vincoli di univocità per i documenti nella raccolta nel servizio Azure Cosmos DB.

AutoscaleSettings

Nome	Tipo	Descrizione
maxThroughput	integer	Rappresenta la velocità effettiva massima, la risorsa può aumentare le prestazioni.

CompositePath

Nome	Tipo	Descrizione
order	CompositePathSortOrder	Ordinare l'ordinamento per i percorsi compositi.
path	string	Percorso a cui si applica il comportamento di indicizzazione. I percorsi di indice iniziano in genere con radice e terminano con caratteri jolly (/path/*)

CompositePathSortOrder

Ordinare l'ordinamento per i percorsi compositi.

Nome	Tipo	Descrizione
ascending	string
descending	string

ConflictResolutionMode

Indica la modalità di risoluzione dei conflitti.

Nome	Tipo	Descrizione
Custom	string
LastWriterWins	string

ConflictResolutionPolicy

Criteri di risoluzione dei conflitti per il contenitore.

Nome	Tipo	Valore predefinito	Descrizione
conflictResolutionPath	string		Percorso di risoluzione dei conflitti nel caso della modalità LastWriterWins.
conflictResolutionProcedure	string		Procedura per risolvere i conflitti in caso di modalità personalizzata.
mode	ConflictResolutionMode	LastWriterWins	Indica la modalità di risoluzione dei conflitti.

ContainerPartitionKey

Configurazione della chiave di partizione da usare per il partizionamento dei dati in più partizioni

Nome	Tipo	Valore predefinito	Descrizione
kind	PartitionKind	Hash	Indica il tipo di algoritmo utilizzato per il partizionamento. Per MultiHash sono supportate più chiavi di partizione (fino a tre al massimo) per la creazione del contenitore
paths	string[]		Elenco di percorsi che usano i dati all'interno del contenitore che possono essere partizionati
systemKey	boolean		Indica se il contenitore usa una chiave di partizione generata dal sistema
version	integer		Indica la versione della definizione della chiave di partizione

CreateMode

Enumerazione per indicare la modalità di creazione dell'account.

Nome	Tipo	Descrizione
Default	string
Restore	string

DataType

Tipo di dati a cui viene applicato il comportamento di indicizzazione.

Nome	Tipo	Descrizione
LineString	string
MultiPolygon	string
Number	string
Point	string
Polygon	string
String	string

ExcludedPath

Nome	Tipo	Descrizione
path	string	Percorso a cui si applica il comportamento di indicizzazione. I percorsi di indice iniziano in genere con radice e terminano con caratteri jolly (/path/*)

GremlinGraphGetResults

Elenco di grafici e delle relative proprietà.

Nome	Tipo	Descrizione
id	string	Identificatore univoco della risorsa arm.
location	string	Posizione del gruppo di risorse a cui appartiene la risorsa.
name	string	Nome della risorsa arm.
properties.options	Options
properties.resource	Resource
tags	object	I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB".
type	string	Tipo di risorsa di Azure.

GremlinGraphListResult

Risposta dell'operazione List, che contiene i grafici e le relative proprietà.

Nome	Tipo	Descrizione
value	GremlinGraphGetResults[]	Elenco di grafici e delle relative proprietà.

IncludedPath

Percorsi inclusi nell'indicizzazione

Nome	Tipo	Descrizione
indexes	Indexes[]	Elenco di indici per questo percorso
path	string	Percorso a cui si applica il comportamento di indicizzazione. I percorsi di indice iniziano in genere con radice e terminano con caratteri jolly (/path/*)

Indexes

Indici per il percorso.

Nome	Tipo	Valore predefinito	Descrizione
dataType	DataType	String	Tipo di dati a cui viene applicato il comportamento di indicizzazione.
kind	IndexKind	Hash	Indica il tipo di indice.
precision	integer		Precisione dell'indice. -1 è la precisione massima.

IndexingMode

Indica la modalità di indicizzazione.

Nome	Tipo	Descrizione
consistent	string
lazy	string
none	string

IndexingPolicy

Criteri di indicizzazione di Cosmos DB

Nome	Tipo	Valore predefinito	Descrizione
automatic	boolean		Indica se i criteri di indicizzazione sono automatici
compositeIndexes	CompositePath[]		Elenco di percorsi compositi
excludedPaths	ExcludedPath[]		Elenco di percorsi da escludere dall'indicizzazione
includedPaths	IncludedPath[]		Elenco di percorsi da includere nell'indicizzazione
indexingMode	IndexingMode	consistent	Indica la modalità di indicizzazione.
spatialIndexes	SpatialSpec[]		Elenco di specifiche spaziali

IndexKind

Indica il tipo di indice.

Nome	Tipo	Descrizione
Hash	string
Range	string
Spatial	string

Options

Nome	Tipo	Descrizione
autoscaleSettings	AutoscaleSettings	Specifica le impostazioni di scalabilità automatica.
throughput	integer	Valore della velocità effettiva della risorsa Cosmos DB o delle impostazioni di scalabilità automatica. Usare la risorsa ThroughputSetting durante il recupero dei dettagli dell'offerta.

PartitionKind

Indica il tipo di algoritmo utilizzato per il partizionamento. Per MultiHash sono supportate più chiavi di partizione (fino a tre al massimo) per la creazione del contenitore

Nome	Tipo	Descrizione
Hash	string
MultiHash	string
Range	string

Resource

Nome	Tipo	Valore predefinito	Descrizione
_etag	string		Proprietà generata dal sistema che rappresenta l'etag della risorsa necessaria per il controllo della concorrenza ottimistica.
_rid	string		Proprietà generata dal sistema. Identificatore univoco.
_ts	number		Proprietà generata dal sistema che indica il timestamp dell'ultimo aggiornamento della risorsa.
analyticalStorageTtl	integer		TTL analitico.
conflictResolutionPolicy	ConflictResolutionPolicy		Criteri di risoluzione dei conflitti per il grafico.
createMode	CreateMode	Default	Enumerazione per indicare la modalità di creazione delle risorse.
defaultTtl	integer		Durata predefinita
id	string		Nome del grafo Gremlin di Cosmos DB
indexingPolicy	IndexingPolicy		Configurazione dei criteri di indicizzazione. Per impostazione predefinita, l'indicizzazione è automatica per tutti i percorsi dei documenti all'interno del grafico
partitionKey	ContainerPartitionKey		Configurazione della chiave di partizione da usare per il partizionamento dei dati in più partizioni
restoreParameters	ResourceRestoreParameters		Parametri per indicare le informazioni sul ripristino
uniqueKeyPolicy	UniqueKeyPolicy		Configurazione dei criteri chiave univoca per specificare vincoli di univocità per i documenti nella raccolta nel servizio Azure Cosmos DB.

ResourceRestoreParameters

Parametri per indicare le informazioni sul ripristino.

Nome	Tipo	Descrizione
restoreSource	string	ID dell'account del database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	Ora in cui è necessario ripristinare l'account (formato ISO-8601).

SpatialSpec

Nome	Tipo	Descrizione
path	string	Percorso a cui si applica il comportamento di indicizzazione. I percorsi di indice iniziano in genere con radice e terminano con caratteri jolly (/path/*)
types	SpatialType[]	Elenco del tipo spaziale del percorso

SpatialType

Indica il tipo spaziale di indice.

Nome	Tipo	Descrizione
LineString	string
MultiPolygon	string
Point	string
Polygon	string

UniqueKey

Chiave univoca su che impone vincoli di univocità per i documenti nella raccolta nel servizio Azure Cosmos DB.

Nome	Tipo	Descrizione
paths	string[]	L'elenco dei percorsi deve essere univoco per ogni documento nel servizio Azure Cosmos DB

UniqueKeyPolicy

Configurazione dei criteri chiave univoca per specificare vincoli di univocità per i documenti nella raccolta nel servizio Azure Cosmos DB.

Nome	Tipo	Descrizione
uniqueKeys	UniqueKey[]	Elenco di chiavi univoche in che applicano vincoli di univocità per i documenti nella raccolta nel servizio Azure Cosmos DB.

Gremlin Resources - List Gremlin Graphs

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Scopes

Esempio

CosmosDBGremlinGraphList

Sample Request

Sample Response

Definizioni

AutoscaleSettings

CompositePath

CompositePathSortOrder

ConflictResolutionMode

ConflictResolutionPolicy

ContainerPartitionKey

CreateMode

DataType

ExcludedPath

GremlinGraphGetResults

GremlinGraphListResult

IncludedPath

Indexes

IndexingMode

IndexingPolicy

IndexKind

Options

PartitionKind

Resource

ResourceRestoreParameters

SpatialSpec

SpatialType

UniqueKey

UniqueKeyPolicy

Risorse aggiuntive