Gremlin Resources - List Gremlin Graphs

Referência

Service:: Cosmos DB Resource Provider

API Version:: 2023-11-15

Listas o grafo do Gremlin em uma conta de banco de dados existente do Azure Cosmos DB.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
accountName	path	True	string	Nome da conta de banco de dados do Cosmos DB. Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
databaseName	path	True	string	Nome do banco de dados do Cosmos DB.
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	GremlinGraphListResult	As propriedades do grafo gremlin foram recuperadas com êxito.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	Representar sua conta de usuário

Exemplos

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\""
        }
      }
    }
  ]
}

Definições

Nome	Description
AutoscaleSettings
CompositePath
CompositePathSortOrder	Ordem de classificação para caminhos compostos.
ConflictResolutionMode	Indica o modo de resolução de conflitos.
ConflictResolutionPolicy	A política de resolução de conflitos para o contêiner.
ContainerPartitionKey	A configuração da chave de partição a ser usada para particionar dados em várias partições
CreateMode	Enumerar para indicar o modo de criação da conta.
DataType	O tipo de dados ao qual o comportamento de indexação é aplicado.
ExcludedPath
GremlinGraphGetResults	Lista de grafos e suas propriedades.
GremlinGraphListResult	A resposta da operação Lista, que contém os grafos e suas propriedades.
IncludedPath	Os caminhos incluídos na indexação
Indexes	Os índices do caminho.
IndexingMode	Indica o modo de indexação.
IndexingPolicy	Política de indexação do Cosmos DB
IndexKind	Indica o tipo de índice.
Options
PartitionKind	Indica o tipo de algoritmo usado para particionamento. Para MultiHash, há suporte para várias chaves de partição (até três máximos) para criação de contêiner
Resource
ResourceRestoreParameters	Parâmetros para indicar as informações sobre a restauração.
SpatialSpec
SpatialType	Indica o tipo espacial de índice.
UniqueKey	A chave exclusiva no que impõe a restrição de exclusividade em documentos na coleção no serviço do Azure Cosmos DB.
UniqueKeyPolicy	A configuração de política de chave exclusiva para especificar restrições de exclusividade em documentos na coleção no serviço do Azure Cosmos DB.

AutoscaleSettings

Nome	Tipo	Description
maxThroughput	integer	Representa a taxa de transferência máxima, o recurso pode escalar verticalmente.

CompositePath

Nome	Tipo	Description
order	CompositePathSortOrder	Ordem de classificação para caminhos compostos.
path	string	O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*)

CompositePathSortOrder

Ordem de classificação para caminhos compostos.

Nome	Tipo	Description
ascending	string
descending	string

ConflictResolutionMode

Indica o modo de resolução de conflitos.

Nome	Tipo	Description
Custom	string
LastWriterWins	string

ConflictResolutionPolicy

A política de resolução de conflitos para o contêiner.

Nome	Tipo	Valor padrão	Description
conflictResolutionPath	string		O caminho de resolução de conflitos no caso do modo LastWriterWins.
conflictResolutionProcedure	string		O procedimento para resolve conflitos no caso do modo personalizado.
mode	ConflictResolutionMode	LastWriterWins	Indica o modo de resolução de conflitos.

ContainerPartitionKey

A configuração da chave de partição a ser usada para particionar dados em várias partições

Nome	Tipo	Valor padrão	Description
kind	PartitionKind	Hash	Indica o tipo de algoritmo usado para particionamento. Para MultiHash, há suporte para várias chaves de partição (até três máximos) para criação de contêiner
paths	string[]		Lista de caminhos usando quais dados dentro do contêiner podem ser particionados
systemKey	boolean		Indica se o contêiner está usando uma chave de partição gerada pelo sistema
version	integer		Indica a versão da definição da chave de partição

CreateMode

Enumerar para indicar o modo de criação da conta.

Nome	Tipo	Description
Default	string
Restore	string

DataType

O tipo de dados ao qual o comportamento de indexação é aplicado.

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

ExcludedPath

Nome	Tipo	Description
path	string	O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*)

GremlinGraphGetResults

Lista de grafos e suas propriedades.

Nome	Tipo	Description
id	string	O identificador de recurso exclusivo do recurso arm.
location	string	O local do grupo de recursos ao qual o recurso pertence.
name	string	O nome do recurso arm.
properties.options	Options
properties.resource	Resource
tags	object	As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). No máximo 15 marcas podem ser fornecidas para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB".
type	string	O tipo de recurso do Azure.

GremlinGraphListResult

A resposta da operação Lista, que contém os grafos e suas propriedades.

Nome	Tipo	Description
value	GremlinGraphGetResults[]	Lista de grafos e suas propriedades.

IncludedPath

Os caminhos incluídos na indexação

Nome	Tipo	Description
indexes	Indexes[]	Lista de índices para esse caminho
path	string	O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*)

Indexes

Os índices do caminho.

Nome	Tipo	Valor padrão	Description
dataType	DataType	String	O tipo de dados ao qual o comportamento de indexação é aplicado.
kind	IndexKind	Hash	Indica o tipo de índice.
precision	integer		A precisão do índice. -1 é precisão máxima.

IndexingMode

Indica o modo de indexação.

Nome	Tipo	Description
consistent	string
lazy	string
none	string

IndexingPolicy

Política de indexação do Cosmos DB

Nome	Tipo	Valor padrão	Description
automatic	boolean		Indica se a política de indexação é automática
compositeIndexes	CompositePath[]		Lista de lista de caminhos compostos
excludedPaths	ExcludedPath[]		Lista de caminhos a serem excluídos da indexação
includedPaths	IncludedPath[]		Lista de caminhos a serem incluídos na indexação
indexingMode	IndexingMode	consistent	Indica o modo de indexação.
spatialIndexes	SpatialSpec[]		Lista de especificações espaciais

IndexKind

Indica o tipo de índice.

Nome	Tipo	Description
Hash	string
Range	string
Spatial	string

Options

Nome	Tipo	Description
autoscaleSettings	AutoscaleSettings	Especifica as configurações de dimensionamento automático.
throughput	integer	Valor da taxa de transferência de recurso do Cosmos DB ou dimensionamento automáticoConfigurações. Use o recurso ThroughputSetting ao recuperar detalhes da oferta.

PartitionKind

Indica o tipo de algoritmo usado para particionamento. Para MultiHash, há suporte para várias chaves de partição (até três máximos) para criação de contêiner

Nome	Tipo	Description
Hash	string
MultiHash	string
Range	string

Resource

Nome	Tipo	Valor padrão	Description
_etag	string		Uma propriedade gerada pelo sistema que representa a etag de recurso necessária para o controle de simultaneidade otimista.
_rid	string		Uma propriedade gerada pelo sistema. Um identificador exclusivo.
_ts	number		Uma propriedade gerada pelo sistema que indica o último carimbo de data/hora atualizado do recurso.
analyticalStorageTtl	integer		TTL analítico.
conflictResolutionPolicy	ConflictResolutionPolicy		A política de resolução de conflitos para o grafo.
createMode	CreateMode	Default	Enumerar para indicar o modo de criação de recursos.
defaultTtl	integer		Tempo de vida padrão
id	string		Nome do grafo do Gremlin do Cosmos DB
indexingPolicy	IndexingPolicy		A configuração da política de indexação. Por padrão, a indexação é automática para todos os caminhos de documento no grafo
partitionKey	ContainerPartitionKey		A configuração da chave de partição a ser usada para particionar dados em várias partições
restoreParameters	ResourceRestoreParameters		Parâmetros para indicar as informações sobre a restauração
uniqueKeyPolicy	UniqueKeyPolicy		A configuração de política de chave exclusiva para especificar restrições de exclusividade em documentos na coleção no serviço do Azure Cosmos DB.

ResourceRestoreParameters

Parâmetros para indicar as informações sobre a restauração.

Nome	Tipo	Description
restoreSource	string	A ID da conta de banco de dados restaurável da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	Tempo para o qual a conta precisa ser restaurada (formato ISO-8601).

SpatialSpec

Nome	Tipo	Description
path	string	O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*)
types	SpatialType[]	Lista do tipo espacial do caminho

SpatialType

Indica o tipo espacial de índice.

Nome	Tipo	Description
LineString	string
MultiPolygon	string
Point	string
Polygon	string

UniqueKey

A chave exclusiva no que impõe a restrição de exclusividade em documentos na coleção no serviço do Azure Cosmos DB.

Nome	Tipo	Description
paths	string[]	A lista de caminhos deve ser exclusiva para cada documento no serviço do Azure Cosmos DB

UniqueKeyPolicy

A configuração de política de chave exclusiva para especificar restrições de exclusividade em documentos na coleção no serviço do Azure Cosmos DB.

Nome	Tipo	Description
uniqueKeys	UniqueKey[]	Lista de chaves exclusivas em que impõe a restrição de exclusividade em documentos na coleção no serviço do Azure Cosmos DB.

Gremlin Resources - List Gremlin Graphs

Parâmetros de URI

Respostas

Segurança

azure_auth

Scopes

Exemplos

CosmosDBGremlinGraphList

Sample Request

Sample Response

Definições

AutoscaleSettings

CompositePath

CompositePathSortOrder

ConflictResolutionMode

ConflictResolutionPolicy

ContainerPartitionKey

CreateMode

DataType

ExcludedPath

GremlinGraphGetResults

GremlinGraphListResult

IncludedPath

Indexes

IndexingMode

IndexingPolicy

IndexKind

Options

PartitionKind

Resource

ResourceRestoreParameters

SpatialSpec

SpatialType

UniqueKey

UniqueKeyPolicy

Recursos adicionais