Gremlin Resources - List Gremlin Graphs

기존 Azure Cosmos DB 데이터베이스 계정 아래에 Gremlin 그래프를 나열합니다.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs?api-version=2021-04-01-preview

URI 매개 변수

Name In Required Type Description
accountName
path True
  • string

DB 데이터베이스 계정 이름을 Cosmos.

Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*

databaseName
path True
  • string

DB 데이터베이스 이름을 Cosmos.

resourceGroupName
path True
  • string

리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.

subscriptionId
path True
  • string

대상 구독의 ID입니다.

api-version
query True
  • string

이 작업에 사용할 API 버전입니다.

응답

Name Type Description
200 OK

Gremlin 그래프 속성이 성공적으로 검색되었습니다.

보안

azure_auth

OAuth2 Flow Azure Active Directory

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

Scopes

Name Description
user_impersonation 사용자 계정 가장

예제

CosmosDBGremlinGraphList

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/graphs?api-version=2021-04-01-preview

Sample Response

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

정의

AutoscaleSettings
ConflictResolutionMode

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

ConflictResolutionPolicy

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

ContainerPartitionKey

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

DataType

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

ExcludedPath
GremlinGraphGetResults

Azure Cosmos DB Gremlin 그래프입니다.

GremlinGraphListResult

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

IncludedPath

인덱싱에 포함된 경로

Indexes

경로에 대한 인덱스입니다.

IndexingMode

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

IndexingPolicy

DB 인덱싱 정책 Cosmos

IndexKind

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

ManagedServiceIdentity

리소스의 ID입니다.

Options
PartitionKind

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

Resource
ResourceIdentityType

리소스에 사용되는 ID의 형식입니다. 'SystemAssigned,UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 서비스에서 ID를 제거합니다.

SpatialSpec
UniqueKey

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

UniqueKeyPolicy

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

UserAssignedIdentities

리소스와 연결된 사용자 ID 목록입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다.

AutoscaleSettings

Name Type Description
maxThroughput
  • integer

최대 처리량을 나타내며 리소스를 확장할 수 있습니다.

ConflictResolutionMode

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

Name Type Description
Custom
  • string
LastWriterWins
  • string

ConflictResolutionPolicy

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

Name Type Default Value Description
conflictResolutionPath
  • string

LastWriterWins 모드의 경우 충돌 해결 경로입니다.

conflictResolutionProcedure
  • string

사용자 지정 모드의 경우 충돌을 해결하는 절차입니다.

mode LastWriterWins

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

ContainerPartitionKey

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

Name Type Default Value Description
kind Hash

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

paths
  • string[]

컨테이너 내에서 분할할 수 있는 데이터를 사용하는 경로 목록

systemKey
  • boolean

컨테이너가 시스템 생성 파티션 키를 사용하고 있는지를 나타냅니다.

version
  • integer

파티션 키 정의의 버전을 나타냅니다.

DataType

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

Name Type Description
LineString
  • string
MultiPolygon
  • string
Number
  • string
Point
  • string
Polygon
  • string
String
  • string

ExcludedPath

Name Type Description
path
  • string

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

GremlinGraphGetResults

Azure Cosmos DB Gremlin 그래프입니다.

Name Type Description
id
  • string

ARM 리소스의 고유 리소스 식별자입니다.

identity

리소스의 ID입니다.

location
  • string

리소스가 속한 리소스 그룹의 위치입니다.

name
  • string

ARM 리소스의 이름입니다.

properties.options
properties.resource
tags
  • object

태그는 리소스를 설명하는 키-값 쌍의 목록입니다. 여러 리소스 그룹에서 이 리소스를 보고 그룹화할 때 이러한 태그를 사용할 수 있습니다. 리소스에 대해 최대 15개의 태그를 제공할 수 있습니다. 각 태그에는 128자 이하의 키와 256자 이하의 값이 포함되어야 합니다. 예를 들어 템플릿 형식의 기본 환경은 "defaultExperience": "Cassandra"로 설정됩니다. 현재 "defaultExperience" 값에는 "Table", "Graph", "DocumentDB" 및 "MongoDB"도 포함됩니다.

type
  • string

Azure 리소스의 유형입니다.

GremlinGraphListResult

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

Name Type Description
value

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

IncludedPath

인덱싱에 포함된 경로

Name Type Description
indexes

이 경로에 대한 인덱스 목록

path
  • string

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

Indexes

경로에 대한 인덱스입니다.

Name Type Default Value Description
dataType String

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

kind Hash

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

precision
  • integer

인덱스의 전체 자릿수입니다. -1은 최대 정밀도입니다.

IndexingMode

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

Name Type Description
consistent
  • string
lazy
  • string
none
  • string

IndexingPolicy

DB 인덱싱 정책 Cosmos

Name Type Default Value Description
automatic
  • boolean

인덱싱 정책이 자동인지를 나타냅니다.

compositeIndexes
  • array[]

복합 경로 목록 목록

excludedPaths

인덱싱에서 제외할 경로 목록

includedPaths

인덱싱에 포함할 경로 목록

indexingMode consistent

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

spatialIndexes

공간별 목록

IndexKind

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

Name Type Description
Hash
  • string
Range
  • string
Spatial
  • string

ManagedServiceIdentity

리소스의 ID입니다.

Name Type Description
principalId
  • string

시스템 할당 ID의 보안 주체 ID입니다. 이 속성은 시스템 할당 ID에 대해서만 제공됩니다.

tenantId
  • string

시스템 할당 ID의 테넌트 ID입니다. 이 속성은 시스템 할당 ID에 대해서만 제공됩니다.

type

리소스에 사용되는 ID의 형식입니다. 'SystemAssigned,UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 서비스에서 ID를 제거합니다.

userAssignedIdentities

리소스와 연결된 사용자 ID 목록입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다.

Options

Name Type Description
autoscaleSettings

자동 크기 조정 설정을 지정합니다.

throughput
  • integer

Cosmos DB 리소스 처리량 또는 autoscaleSettings의 값입니다. 제품 세부 정보를 검색할 때는 ThroughputSetting 리소스를 사용합니다.

PartitionKind

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

Name Type Description
Hash
  • string
MultiHash
  • string
Range
  • string

Resource

Name Type Description
_etag
  • string

낙관적 동시성 제어에 필요한 리소스 etag를 나타내는 시스템 생성 속성입니다.

_rid
  • string

시스템 생성 속성입니다. 고유 식별자입니다.

_ts
  • number

리소스의 마지막으로 업데이트된 타임스탬프를 나타내는 시스템 생성 속성입니다.

conflictResolutionPolicy

그래프에 대한 충돌 해결 정책입니다.

defaultTtl
  • integer

기본 사용 시간

id
  • string

Cosmos DB Gremlin 그래프의 이름

indexingPolicy

인덱싱 정책의 구성입니다. 기본적으로 인덱싱은 그래프 내의 모든 문서 경로에 대해 자동으로 수행됩니다.

partitionKey

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

uniqueKeyPolicy

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

ResourceIdentityType

리소스에 사용되는 ID의 형식입니다. 'SystemAssigned,UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 서비스에서 ID를 제거합니다.

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

SpatialSpec

Name Type Description
path
  • string

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

types
  • string[]

경로의 공간 유형 목록

UniqueKey

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

Name Type Description
paths
  • string[]

경로 목록은 Azure Cosmos DB 서비스의 각 문서에 대해 고유해야 합니다.

UniqueKeyPolicy

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

Name Type Description
uniqueKeys

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

UserAssignedIdentities

리소스와 연결된 사용자 ID 목록입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다.

Name Type Description