Gremlin Resources - List Gremlin Graphs

Mencantumkan 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=2021-04-01-preview

Parameter URI

Name In Required Type Description
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

Name Type Description
200 OK

Properti grafik Gremlin berhasil diambil.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation Meniru akun pengguna Anda

Contoh

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

Definisi

AutoscaleSettings
ConflictResolutionMode

Menunjukkan mode resolusi konflik.

ConflictResolutionPolicy

Kebijakan penyelesaian konflik untuk kontainer.

ContainerPartitionKey

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

DataType

Jenis data tempat perilaku pengindeksan diterapkan.

ExcludedPath
GremlinGraphGetResults

Grafik Azure Cosmos DB Gremlin.

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.

ManagedServiceIdentity

Identitas untuk sumber daya.

Options
PartitionKind

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

Resource
ResourceIdentityType

Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned,UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun dari layanan.

SpatialSpec
UniqueKey

Kunci unik 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.

UserAssignedIdentities

Daftar identitas pengguna yang terkait dengan sumber daya. Referensi kunci kamus identitas pengguna akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

AutoscaleSettings

Name Type Description
maxThroughput
  • integer

Mewakili throughput maksimum, sumber daya dapat ditingkatkan skalanya.

ConflictResolutionMode

Menunjukkan mode resolusi konflik.

Name Type Description
Custom
  • string
LastWriterWins
  • string

ConflictResolutionPolicy

Kebijakan penyelesaian konflik untuk kontainer.

Name Type Default Value Description
conflictResolutionPath
  • string

Jalur resolusi konflik dalam kasus mode LastWriterWins.

conflictResolutionProcedure
  • string

Prosedur untuk mengatasi konflik dalam kasus mode kustom.

mode LastWriterWins

Menunjukkan mode resolusi konflik.

ContainerPartitionKey

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

Name Type Default Value Description
kind 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

DataType

Jenis data tempat perilaku pengindeksan diterapkan.

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

ExcludedPath

Name Type Description
path
  • string

Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhpuni dengan wildcard (/path/*)

GremlinGraphGetResults

Grafik Azure Cosmos DB Gremlin.

Name Type Description
id
  • string

Pengidentifikasi sumber daya unik sumber daya ARM.

identity

Identitas untuk sumber daya.

location
  • string

Lokasi grup sumber daya tempat sumber daya berada.

name
  • string

Nama sumber daya ARM.

properties.options
properties.resource
tags
  • object

Tag adalah daftar pasangan kunci-nilai yang menjelaskan sumber daya. Tag ini dapat digunakan dalam menampilkan 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.

Name Type Description
value

Daftar grafik dan propertinya.

IncludedPath

Jalur yang disertakan dalam pengindeksan

Name Type Description
indexes

Daftar indeks untuk jalur ini

path
  • string

Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhpuni dengan wildcard (/path/*)

Indexes

Indeks untuk jalur.

Name Type Default Value Description
dataType String

Jenis data tempat perilaku pengindeksan diterapkan.

kind Hash

Menunjukkan jenis indeks.

precision
  • integer

Presisi indeks. -1 adalah presisi maksimum.

IndexingMode

Menunjukkan mode pengindeksan.

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

IndexingPolicy

Kebijakan pengindeksan Cosmos DB

Name Type Default Value Description
automatic
  • boolean

Menunjukkan apakah kebijakan pengindeksan bersifat otomatis

compositeIndexes
  • array[]

Daftar daftar jalur komposit

excludedPaths

Daftar jalur yang akan dikecualikan dari pengindeksan

includedPaths

Daftar jalur yang akan disertakan dalam pengindeksan

indexingMode consistent

Menunjukkan mode pengindeksan.

spatialIndexes

Daftar spesifikasi spasial

IndexKind

Menunjukkan jenis indeks.

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

ManagedServiceIdentity

Identitas untuk sumber daya.

Name Type Description
principalId
  • string

Id utama dari identitas yang ditetapkan sistem. Properti ini hanya akan disediakan untuk identitas yang ditetapkan sistem.

tenantId
  • string

Id penyewa dari identitas yang ditetapkan sistem. Properti ini hanya akan disediakan untuk identitas yang ditetapkan sistem.

type

Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned,UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun dari layanan.

userAssignedIdentities

Daftar identitas pengguna yang terkait dengan sumber daya. Referensi kunci kamus identitas pengguna akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Options

Name Type Description
autoscaleSettings

Menentukan pengaturan Skala Otomatis.

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

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

Resource

Name Type Description
_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.

conflictResolutionPolicy

Kebijakan penyelesaian konflik untuk grafik.

defaultTtl
  • integer

Waktu hidup default

id
  • string

Nama grafik Cosmos DB Gremlin

indexingPolicy

Konfigurasi kebijakan pengindeksan. Secara default, pengindeksan otomatis untuk semua jalur dokumen dalam grafik

partitionKey

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

uniqueKeyPolicy

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

ResourceIdentityType

Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned,UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun dari layanan.

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

SpatialSpec

Name Type Description
path
  • string

Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhpuni dengan wildcard (/path/*)

types
  • string[]

Daftar jenis spasial jalur

UniqueKey

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

Name Type Description
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.

Name Type Description
uniqueKeys

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

UserAssignedIdentities

Daftar identitas pengguna yang terkait dengan sumber daya. Referensi kunci kamus identitas pengguna akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name Type Description