Gremlin Resources - List Gremlin Graphs

Visar Gremlin-grafen under ett befintligt Azure Cosmos DB-databaskonto.

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

URI-parametrar

Name In Required Type Description
accountName
path True
  • string

Namn på Cosmos DB-databaskonto.

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

databaseName
path True
  • string

Cosmos DB-databasnamn.

resourceGroupName
path True
  • string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

subscriptionId
path True
  • string

ID för målprenumerationen.

api-version
query True
  • string

DEN API-version som ska användas för den här åtgärden.

Svar

Name Type Description
200 OK

Gremlin-diagramegenskaperna har hämtats.

Säkerhet

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 Personifiera ditt användarkonto

Exempel

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

Definitioner

AutoscaleSettings
ConflictResolutionMode

Anger konfliktlösningsläget.

ConflictResolutionPolicy

Konfliktlösningsprincipen för containern.

ContainerPartitionKey

Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner

DataType

Den datatyp som indexeringsbeteendet tillämpas på.

ExcludedPath
GremlinGraphGetResults

En Gremlin-graf för Azure Cosmos DB.

GremlinGraphListResult

Svar på liståtgärden som innehåller graferna och deras egenskaper.

IncludedPath

Sökvägarna som ingår i indexeringen

Indexes

Index för sökvägen.

IndexingMode

Anger indexeringsläget.

IndexingPolicy

Cosmos DB-indexeringsprincip

IndexKind

Anger typen av index.

ManagedServiceIdentity

Identitet för resursen.

Options
PartitionKind

Anger vilken typ av algoritm som används för partitionering. För MultiHash stöds flera partitionsnycklar (upp till högst tre) för containerskapande

Resource
ResourceIdentityType

Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.

SpatialSpec
UniqueKey

Den unika nyckeln på som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten.

UniqueKeyPolicy

Den unika nyckelprincipkonfigurationen för att ange unikhetsbegränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten.

UserAssignedIdentities

Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

AutoscaleSettings

Name Type Description
maxThroughput
  • integer

Representerar maximalt dataflöde, resursen kan skalas upp till.

ConflictResolutionMode

Anger konfliktlösningsläget.

Name Type Description
Custom
  • string
LastWriterWins
  • string

ConflictResolutionPolicy

Konfliktlösningsprincipen för containern.

Name Type Default Value Description
conflictResolutionPath
  • string

Konfliktlösningssökvägen i fallet LastWriterWins-läge.

conflictResolutionProcedure
  • string

Proceduren för att lösa konflikter i ett anpassat läge.

mode LastWriterWins

Anger konfliktlösningsläget.

ContainerPartitionKey

Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner

Name Type Default Value Description
kind Hash

Anger vilken typ av algoritm som används för partitionering. För MultiHash stöds flera partitionsnycklar (upp till högst tre) för containerskapande

paths
  • string[]

Lista över sökvägar som använder vilka data i containern som kan partitioneras

systemKey
  • boolean

Anger om containern använder en systemgenererad partitionsnyckel

version
  • integer

Anger versionen av partitionsnyckeldefinitionen

DataType

Den datatyp som indexeringsbeteendet tillämpas på.

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

ExcludedPath

Name Type Description
path
  • string

Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slutar med jokertecken (/sökväg/*)

GremlinGraphGetResults

En Gremlin-graf för Azure Cosmos DB.

Name Type Description
id
  • string

Den unika resursidentifieraren för ARM-resursen.

identity

Identitet för resursen.

location
  • string

Platsen för resursgruppen som resursen tillhör.

name
  • string

Namnet på ARM-resursen.

properties.options
properties.resource
tags
  • object

Taggar är en lista över nyckel/värde-par som beskriver resursen. De här taggarna kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB".

type
  • string

Typen av Azure-resurs.

GremlinGraphListResult

Svar på liståtgärden som innehåller graferna och deras egenskaper.

Name Type Description
value

Lista över grafer och deras egenskaper.

IncludedPath

Sökvägarna som ingår i indexeringen

Name Type Description
indexes

Lista över index för den här sökvägen

path
  • string

Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slutar med jokertecken (/sökväg/*)

Indexes

Index för sökvägen.

Name Type Default Value Description
dataType String

Den datatyp som indexeringsbeteendet tillämpas på.

kind Hash

Anger typen av index.

precision
  • integer

Precisionen för indexet. -1 är maximal precision.

IndexingMode

Anger indexeringsläget.

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

IndexingPolicy

Cosmos DB-indexeringsprincip

Name Type Default Value Description
automatic
  • boolean

Anger om indexeringsprincipen är automatisk

compositeIndexes
  • array[]

Lista över sammansatt sökvägslista

excludedPaths

Lista över sökvägar som ska undantas från indexering

includedPaths

Lista över sökvägar som ska ingå i indexeringen

indexingMode consistent

Anger indexeringsläget.

spatialIndexes

Lista över rumsliga detaljer

IndexKind

Anger typen av index.

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

ManagedServiceIdentity

Identitet för resursen.

Name Type Description
principalId
  • string

Huvud-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.

tenantId
  • string

Klient-ID:t för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.

type

Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.

userAssignedIdentities

Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Options

Name Type Description
autoscaleSettings

Anger inställningarna för autoskalning.

throughput
  • integer

Värdet för Cosmos DB-resursens dataflöde eller autoscaleSettings. Använd resursen ThroughputSetting när du hämtar information om erbjudandet.

PartitionKind

Anger vilken typ av algoritm som används för partitionering. För MultiHash stöds flera partitionsnycklar (upp till högst tre) för containerskapande

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

Resource

Name Type Description
_etag
  • string

En systemgenererad egenskap som representerar resursetaggen som krävs för optimistisk samtidighetskontroll.

_rid
  • string

En systemgenererad egenskap. En unik identifierare.

_ts
  • number

En systemgenererad egenskap som anger den senast uppdaterade tidsstämpeln för resursen.

conflictResolutionPolicy

Konfliktlösningsprincipen för diagrammet.

defaultTtl
  • integer

Standardtid till live

id
  • string

Namnet på Cosmos DB Gremlin-grafen

indexingPolicy

Konfigurationen av indexeringsprincipen. Som standard är indexeringen automatisk för alla dokumentsökvägar i diagrammet

partitionKey

Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner

uniqueKeyPolicy

Den unika nyckelprincipkonfigurationen för att ange unikhetsbegränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten.

ResourceIdentityType

Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.

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

SpatialSpec

Name Type Description
path
  • string

Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slutar med jokertecken (/sökväg/*)

types
  • string[]

Lista över sökvägens rumsliga typ

UniqueKey

Den unika nyckeln på som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten.

Name Type Description
paths
  • string[]

Listan över sökvägar måste vara unik för varje dokument i Azure Cosmos DB-tjänsten

UniqueKeyPolicy

Den unika nyckelprincipkonfigurationen för att ange unikhetsbegränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten.

Name Type Description
uniqueKeys

Lista över unika nycklar för som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten.

UserAssignedIdentities

Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name Type Description