Gremlin Resources - List Gremlin Graphs

Service:

Cosmos DB Resource Provider

API Version:

2023-11-15

Lists grafik Gremlin di bawah akun database Azure Cosmos DB yang sudah ada.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountName	path	True	string	Nama akun database Cosmos DB. Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*
databaseName	path	True	string	Nama database Cosmos DB.
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	GremlinGraphListResult	Properti grafik Gremlin berhasil diambil.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
user_impersonation	Meniru akun pengguna Anda

Contoh

CosmosDBGremlinGraphList

Sample Request

HTTP

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

Java

/**
 * 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

Python

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

Go

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

JavaScript

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

Definisi

Nama	Deskripsi
AutoscaleSettings
CompositePath
CompositePathSortOrder	Urutkan urutan untuk jalur komposit.
ConflictResolutionMode	Menunjukkan mode resolusi konflik.
ConflictResolutionPolicy	Kebijakan resolusi konflik untuk kontainer.
ContainerPartitionKey	Konfigurasi kunci partisi yang akan digunakan untuk mempartisi data ke dalam beberapa partisi
CreateMode	Enum untuk menunjukkan mode pembuatan akun.
DataType	Jenis data tempat perilaku pengindeksan diterapkan.
ExcludedPath
GremlinGraphGetResults	Daftar grafik dan propertinya.
GremlinGraphListResult	Respons operasi Daftar, yang berisi grafik dan propertinya.
IncludedPath	Jalur yang disertakan dalam pengindeksan
Indexes	Indeks untuk jalur.
IndexingMode	Menunjukkan mode pengindeksan.
IndexingPolicy	Kebijakan pengindeksan Cosmos DB
IndexKind	Menunjukkan jenis indeks.
Options
PartitionKind	Menunjukkan jenis algoritma yang digunakan untuk pemartisian. Untuk MultiHash, beberapa kunci partisi (hingga tiga maksimum) didukung untuk pembuatan kontainer
Resource
ResourceRestoreParameters	Parameter untuk menunjukkan informasi tentang pemulihan.
SpatialSpec
SpatialType	Menunjukkan jenis spasial indeks.
UniqueKey	Kunci unik pada yang memberlakukan batasan keunikan pada dokumen dalam koleksi di layanan Azure Cosmos DB.
UniqueKeyPolicy	Konfigurasi kebijakan kunci unik untuk menentukan batasan keunikan pada dokumen dalam koleksi di layanan Azure Cosmos DB.

AutoscaleSettings

Nama	Jenis	Deskripsi
maxThroughput	integer	Mewakili throughput maksimum, sumber daya dapat ditingkatkan skalanya.

CompositePath

Nama	Jenis	Deskripsi
order	CompositePathSortOrder	Urutkan urutan untuk jalur komposit.
path	string	Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhir dengan wildcard (/path/*)

CompositePathSortOrder

Urutkan urutan untuk jalur komposit.

Nama	Jenis	Deskripsi
ascending	string
descending	string

ConflictResolutionMode

Menunjukkan mode resolusi konflik.

Nama	Jenis	Deskripsi
Custom	string
LastWriterWins	string

ConflictResolutionPolicy

Kebijakan resolusi konflik untuk kontainer.

Nama	Jenis	Nilai Default	Deskripsi
conflictResolutionPath	string		Jalur resolusi konflik dalam kasus mode LastWriterWins.
conflictResolutionProcedure	string		Prosedur untuk mengatasi konflik dalam kasus mode kustom.
mode	ConflictResolutionMode	LastWriterWins	Menunjukkan mode resolusi konflik.

ContainerPartitionKey

Konfigurasi kunci partisi yang akan digunakan untuk mempartisi data ke dalam beberapa partisi

Nama	Jenis	Nilai Default	Deskripsi
kind	PartitionKind	Hash	Menunjukkan jenis algoritma yang digunakan untuk pemartisian. Untuk MultiHash, beberapa kunci partisi (hingga tiga maksimum) didukung untuk pembuatan kontainer
paths	string[]		Daftar jalur yang menggunakan data mana dalam kontainer yang dapat dipartisi
systemKey	boolean		Menunjukkan apakah kontainer menggunakan kunci partisi yang dihasilkan sistem
version	integer		Menunjukkan versi definisi kunci partisi

CreateMode

Enum untuk menunjukkan mode pembuatan akun.

Nama	Jenis	Deskripsi
Default	string
Restore	string

DataType

Jenis data tempat perilaku pengindeksan diterapkan.

Nama	Jenis	Deskripsi
LineString	string
MultiPolygon	string
Number	string
Point	string
Polygon	string
String	string

ExcludedPath

Nama	Jenis	Deskripsi
path	string	Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhir dengan wildcard (/path/*)

GremlinGraphGetResults

Daftar grafik dan propertinya.

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi sumber daya unik sumber daya ARM.
location	string	Lokasi grup sumber daya tempat sumber daya berada.
name	string	Nama sumber daya ARM.
properties.options	Options
properties.resource	Resource
tags	object	Tag adalah daftar pasangan kunci-nilai yang menjelaskan sumber daya. Tag ini dapat digunakan dalam melihat dan mengelompokkan sumber daya ini (di seluruh grup sumber daya). Maksimal 15 tag dapat disediakan untuk sumber daya. Setiap tag harus memiliki kunci yang tidak lebih besar dari 128 karakter dan nilai tidak lebih besar dari 256 karakter. Misalnya, pengalaman default untuk jenis templat diatur dengan "defaultExperience": "Cassandra". Nilai "defaultExperience" saat ini juga mencakup "Table", "Graph", "DocumentDB", dan "MongoDB".
type	string	Jenis sumber daya Azure.

GremlinGraphListResult

Respons operasi Daftar, yang berisi grafik dan propertinya.

Nama	Jenis	Deskripsi
value	GremlinGraphGetResults[]	Daftar grafik dan propertinya.

IncludedPath

Jalur yang disertakan dalam pengindeksan

Nama	Jenis	Deskripsi
indexes	Indexes[]	Daftar indeks untuk jalur ini
path	string	Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhir dengan wildcard (/path/*)

Indexes

Indeks untuk jalur.

Nama	Jenis	Nilai Default	Deskripsi
dataType	DataType	String	Jenis data tempat perilaku pengindeksan diterapkan.
kind	IndexKind	Hash	Menunjukkan jenis indeks.
precision	integer		Presisi indeks. -1 adalah presisi maksimum.

IndexingMode

Menunjukkan mode pengindeksan.

Nama	Jenis	Deskripsi
consistent	string
lazy	string
none	string

IndexingPolicy

Kebijakan pengindeksan Cosmos DB

Nama	Jenis	Nilai Default	Deskripsi
automatic	boolean		Menunjukkan apakah kebijakan pengindeksan bersifat otomatis
compositeIndexes	CompositePath[]		Daftar daftar jalur komposit
excludedPaths	ExcludedPath[]		Daftar jalur yang akan dikecualikan dari pengindeksan
includedPaths	IncludedPath[]		Daftar jalur yang akan disertakan dalam pengindeksan
indexingMode	IndexingMode	consistent	Menunjukkan mode pengindeksan.
spatialIndexes	SpatialSpec[]		Daftar spesifikasi spasial

IndexKind

Menunjukkan jenis indeks.

Nama	Jenis	Deskripsi
Hash	string
Range	string
Spatial	string

Options

Nama	Jenis	Deskripsi
autoscaleSettings	AutoscaleSettings	Menentukan pengaturan Autoscale.
throughput	integer	Nilai throughput sumber daya Cosmos DB atau autoscaleSettings. Gunakan sumber daya ThroughputSetting saat mengambil detail penawaran.

PartitionKind

Menunjukkan jenis algoritma yang digunakan untuk pemartisian. Untuk MultiHash, beberapa kunci partisi (hingga tiga maksimum) didukung untuk pembuatan kontainer

Nama	Jenis	Deskripsi
Hash	string
MultiHash	string
Range	string

Resource

Nama	Jenis	Nilai Default	Deskripsi
_etag	string		Properti yang dihasilkan sistem yang mewakili etag sumber daya yang diperlukan untuk kontrol konkurensi optimis.
_rid	string		Properti yang dihasilkan sistem. Pengidentifikasi unik.
_ts	number		Properti yang dihasilkan sistem yang menunjukkan tanda waktu terakhir yang diperbarui dari sumber daya.
analyticalStorageTtl	integer		TTL analitis.
conflictResolutionPolicy	ConflictResolutionPolicy		Kebijakan resolusi konflik untuk grafik.
createMode	CreateMode	Default	Enum untuk menunjukkan mode pembuatan sumber daya.
defaultTtl	integer		Waktu hidup default
id	string		Nama grafik Cosmos DB Gremlin
indexingPolicy	IndexingPolicy		Konfigurasi kebijakan pengindeksan. Secara default, pengindeksan otomatis untuk semua jalur dokumen dalam grafik
partitionKey	ContainerPartitionKey		Konfigurasi kunci partisi yang akan digunakan untuk mempartisi data ke dalam beberapa partisi
restoreParameters	ResourceRestoreParameters		Parameter untuk menunjukkan informasi tentang pemulihan
uniqueKeyPolicy	UniqueKeyPolicy		Konfigurasi kebijakan kunci unik untuk menentukan batasan keunikan pada dokumen dalam koleksi di layanan Azure Cosmos DB.

ResourceRestoreParameters

Parameter untuk menunjukkan informasi tentang pemulihan.

Nama	Jenis	Deskripsi
restoreSource	string	Id akun database yang dapat dipulihkan tempat pemulihan harus dimulai. Misalnya: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	Waktu di mana akun harus dipulihkan (format ISO-8601).

SpatialSpec

Nama	Jenis	Deskripsi
path	string	Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhir dengan wildcard (/path/*)
types	SpatialType[]	Daftar jenis spasial jalur

SpatialType

Menunjukkan jenis spasial indeks.

Nama	Jenis	Deskripsi
LineString	string
MultiPolygon	string
Point	string
Polygon	string

UniqueKey

Kunci unik pada yang memberlakukan batasan keunikan pada dokumen dalam koleksi di layanan Azure Cosmos DB.

Nama	Jenis	Deskripsi
paths	string[]	Daftar jalur harus unik untuk setiap dokumen dalam layanan Azure Cosmos DB

UniqueKeyPolicy

Konfigurasi kebijakan kunci unik untuk menentukan batasan keunikan pada dokumen dalam koleksi di layanan Azure Cosmos DB.

Nama	Jenis	Deskripsi
uniqueKeys	UniqueKey[]	Daftar kunci unik pada yang memberlakukan batasan keunikan pada dokumen dalam koleksi di layanan Azure Cosmos DB.