Gremlin Resources - List Gremlin Graphs

Service:

Cosmos DB Resource Provider

API Version:

2023-11-15

기존 Azure Cosmos DB 데이터베이스 계정에서 Gremlin 그래프를 Lists.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
accountName	path	True	string	Cosmos DB 데이터베이스 계정 이름입니다. Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*
databaseName	path	True	string	Cosmos DB 데이터베이스 이름입니다.
resourceGroupName	path	True	string	리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
subscriptionId	path	True	string	대상 구독의 ID입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	GremlinGraphListResult	Gremlin 그래프 속성이 성공적으로 검색되었습니다.

보안

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	사용자 계정 가장

예제

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

정의

Name	Description
AutoscaleSettings
CompositePath
CompositePathSortOrder	복합 경로의 정렬 순서입니다.
ConflictResolutionMode	충돌 해결 모드를 나타냅니다.
ConflictResolutionPolicy	컨테이너에 대한 충돌 해결 정책입니다.
ContainerPartitionKey	데이터를 여러 파티션으로 분할하는 데 사용할 파티션 키 구성
CreateMode	계정 만들기 모드를 나타내는 열거형입니다.
DataType	인덱싱 동작이 적용되는 데이터 형식입니다.
ExcludedPath
GremlinGraphGetResults	그래프 및 해당 속성 목록입니다.
GremlinGraphListResult	그래프 및 해당 속성을 포함하는 목록 작업 응답입니다.
IncludedPath	인덱싱에 포함된 경로
Indexes	경로의 인덱스입니다.
IndexingMode	인덱싱 모드를 나타냅니다.
IndexingPolicy	Cosmos DB 인덱싱 정책
IndexKind	인덱스의 유형을 나타냅니다.
Options
PartitionKind	분할에 사용되는 알고리즘의 종류를 나타냅니다. MultiHash의 경우 컨테이너 만들기에 대해 여러 파티션 키(최대 3개)가 지원됩니다.
Resource
ResourceRestoreParameters	복원에 대한 정보를 나타내는 매개 변수입니다.
SpatialSpec
SpatialType	인덱스의 공간 형식을 나타냅니다.
UniqueKey	Azure Cosmos DB 서비스의 컬렉션에 있는 문서에 고유성 제약 조건을 적용하는 의 고유 키입니다.
UniqueKeyPolicy	Azure Cosmos DB 서비스의 컬렉션에 있는 문서에 고유성 제약 조건을 지정하기 위한 고유 키 정책 구성입니다.

AutoscaleSettings

Name	형식	Description
maxThroughput	integer	최대 처리량을 나타내며 리소스를 확장할 수 있습니다.

CompositePath

Name	형식	Description
order	CompositePathSortOrder	복합 경로의 정렬 순서입니다.
path	string	인덱싱 동작이 적용되는 경로입니다. 인덱스 경로는 일반적으로 루트로 시작하고 와일드카드(/path/*)로 끝납니다.

CompositePathSortOrder

복합 경로의 정렬 순서입니다.

Name	형식	Description
ascending	string
descending	string

ConflictResolutionMode

충돌 해결 모드를 나타냅니다.

Name	형식	Description
Custom	string
LastWriterWins	string

ConflictResolutionPolicy

컨테이너에 대한 충돌 해결 정책입니다.

Name	형식	기본값	Description
conflictResolutionPath	string		LastWriterWins 모드의 경우 충돌 해결 경로입니다.
conflictResolutionProcedure	string		사용자 지정 모드의 경우 충돌을 resolve 프로시저입니다.
mode	ConflictResolutionMode	LastWriterWins	충돌 해결 모드를 나타냅니다.

ContainerPartitionKey

데이터를 여러 파티션으로 분할하는 데 사용할 파티션 키 구성

Name	형식	기본값	Description
kind	PartitionKind	Hash	분할에 사용되는 알고리즘의 종류를 나타냅니다. MultiHash의 경우 컨테이너 만들기에 대해 여러 파티션 키(최대 3개)가 지원됩니다.
paths	string[]		컨테이너 내에서 분할할 수 있는 데이터를 사용하는 경로 목록
systemKey	boolean		컨테이너가 시스템 생성 파티션 키를 사용하고 있는지를 나타냅니다.
version	integer		파티션 키 정의의 버전을 나타냅니다.

CreateMode

계정 만들기 모드를 나타내는 열거형입니다.

Name	형식	Description
Default	string
Restore	string

DataType

인덱싱 동작이 적용되는 데이터 형식입니다.

Name	형식	Description
LineString	string
MultiPolygon	string
Number	string
Point	string
Polygon	string
String	string

ExcludedPath

Name	형식	Description
path	string	인덱싱 동작이 적용되는 경로입니다. 인덱스 경로는 일반적으로 루트로 시작하고 와일드카드(/path/*)로 끝납니다.

GremlinGraphGetResults

그래프 및 해당 속성 목록입니다.

Name	형식	Description
id	string	ARM 리소스의 고유 리소스 식별자입니다.
location	string	리소스가 속한 리소스 그룹의 위치입니다.
name	string	ARM 리소스의 이름입니다.
properties.options	Options
properties.resource	Resource
tags	object	태그는 리소스를 설명하는 키-값 쌍의 목록입니다. 여러 리소스 그룹에서 이 리소스를 보고 그룹화할 때 이러한 태그를 사용할 수 있습니다. 리소스에 대해 최대 15개의 태그를 제공할 수 있습니다. 각 태그에는 128자 이하의 키와 256자 이하의 값이 포함되어야 합니다. 예를 들어 템플릿 형식의 기본 환경은 "defaultExperience": "Cassandra"로 설정됩니다. 현재 "defaultExperience" 값에는 "Table", "Graph", "DocumentDB" 및 "MongoDB"도 포함됩니다.
type	string	Azure 리소스의 유형입니다.

GremlinGraphListResult

그래프 및 해당 속성을 포함하는 목록 작업 응답입니다.

Name	형식	Description
value	GremlinGraphGetResults[]	그래프 및 해당 속성 목록입니다.

IncludedPath

인덱싱에 포함된 경로

Name	형식	Description
indexes	Indexes[]	이 경로에 대한 인덱스 목록
path	string	인덱싱 동작이 적용되는 경로입니다. 인덱스 경로는 일반적으로 루트로 시작하고 와일드카드(/path/*)로 끝납니다.

Indexes

경로의 인덱스입니다.

Name	형식	기본값	Description
dataType	DataType	String	인덱싱 동작이 적용되는 데이터 형식입니다.
kind	IndexKind	Hash	인덱스의 유형을 나타냅니다.
precision	integer		인덱스의 전체 자릿수입니다. -1은 최대 정밀도입니다.

IndexingMode

인덱싱 모드를 나타냅니다.

Name	형식	Description
consistent	string
lazy	string
none	string

IndexingPolicy

Cosmos DB 인덱싱 정책

Name	형식	기본값	Description
automatic	boolean		인덱싱 정책이 자동인지를 나타냅니다.
compositeIndexes	CompositePath[]		복합 경로 목록 목록
excludedPaths	ExcludedPath[]		인덱싱에서 제외할 경로 목록
includedPaths	IncludedPath[]		인덱싱에 포함할 경로 목록
indexingMode	IndexingMode	consistent	인덱싱 모드를 나타냅니다.
spatialIndexes	SpatialSpec[]		공간 세부 정보 목록

IndexKind

인덱스의 유형을 나타냅니다.

Name	형식	Description
Hash	string
Range	string
Spatial	string

Options

Name	형식	Description
autoscaleSettings	AutoscaleSettings	자동 크기 조정 설정을 지정합니다.
throughput	integer	Cosmos DB 리소스 처리량 또는 autoscaleSettings의 값입니다. 제품 세부 정보를 검색할 때는 ThroughputSetting 리소스를 사용합니다.

PartitionKind

분할에 사용되는 알고리즘의 종류를 나타냅니다. MultiHash의 경우 컨테이너 만들기에 대해 여러 파티션 키(최대 3개)가 지원됩니다.

Name	형식	Description
Hash	string
MultiHash	string
Range	string

Resource

Name	형식	기본값	Description
_etag	string		낙관적 동시성 제어에 필요한 리소스 etag를 나타내는 시스템 생성 속성입니다.
_rid	string		시스템 생성 속성입니다. 고유 식별자입니다.
_ts	number		리소스의 마지막으로 업데이트된 타임스탬프를 나타내는 시스템 생성 속성입니다.
analyticalStorageTtl	integer		분석 TTL.
conflictResolutionPolicy	ConflictResolutionPolicy		그래프에 대한 충돌 해결 정책입니다.
createMode	CreateMode	Default	리소스 생성 모드를 나타내는 열거형입니다.
defaultTtl	integer		기본 TL(Time to Live)
id	string		Cosmos DB Gremlin 그래프의 이름
indexingPolicy	IndexingPolicy		인덱싱 정책의 구성입니다. 기본적으로 인덱싱은 그래프 내의 모든 문서 경로에 대해 자동으로 수행됩니다.
partitionKey	ContainerPartitionKey		데이터를 여러 파티션으로 분할하는 데 사용할 파티션 키 구성
restoreParameters	ResourceRestoreParameters		복원에 대한 정보를 나타내는 매개 변수
uniqueKeyPolicy	UniqueKeyPolicy		Azure Cosmos DB 서비스의 컬렉션에 있는 문서에 고유성 제약 조건을 지정하기 위한 고유 키 정책 구성입니다.

ResourceRestoreParameters

복원에 대한 정보를 나타내는 매개 변수입니다.

Name	형식	Description
restoreSource	string	복원을 시작해야 하는 복원 가능한 데이터베이스 계정의 ID입니다. 예: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	계정을 복원해야 하는 시간(ISO-8601 형식).

SpatialSpec

Name	형식	Description
path	string	인덱싱 동작이 적용되는 경로입니다. 인덱스 경로는 일반적으로 루트로 시작하고 와일드카드(/path/*)로 끝납니다.
types	SpatialType[]	경로의 공간 형식 목록

SpatialType

인덱스의 공간 형식을 나타냅니다.

Name	형식	Description
LineString	string
MultiPolygon	string
Point	string
Polygon	string

UniqueKey

Azure Cosmos DB 서비스의 컬렉션에 있는 문서에 고유성 제약 조건을 적용하는 의 고유 키입니다.

Name	형식	Description
paths	string[]	경로 목록은 Azure Cosmos DB 서비스의 각 문서에 대해 고유해야 합니다.

UniqueKeyPolicy

Azure Cosmos DB 서비스의 컬렉션에 있는 문서에 고유성 제약 조건을 지정하기 위한 고유 키 정책 구성입니다.

Name	형식	Description
uniqueKeys	UniqueKey[]	Azure Cosmos DB 서비스의 컬렉션에 있는 문서에 고유성 제약 조건을 적용하는 의 고유 키 목록입니다.