Gremlin Resources - List Gremlin Graphs

Elenca il grafo Gremlin in un account di database Azure Cosmos DB esistente.

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

Parametri dell'URI

Name In Required Type Description
accountName
path True
  • string

Cosmos DB nome dell'account di database.

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

databaseName
path True
  • string

Cosmos DB nome del database.

resourceGroupName
path True
  • string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

subscriptionId
path True
  • string

ID della sottoscrizione di destinazione.

api-version
query True
  • string

Versione dell'API da usare per questa operazione.

Risposte

Name Type Description
200 OK

Le proprietà del grafo Gremlin sono state recuperate correttamente.

Sicurezza

azure_auth

Azure Active Directory flusso OAuth2

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

Scopes

Name Description
user_impersonation Rappresentare l'account utente

Esempio

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

Definizioni

AutoscaleSettings
ConflictResolutionMode

Indica la modalità di risoluzione dei conflitti.

ConflictResolutionPolicy

Criteri di risoluzione dei conflitti per il contenitore.

ContainerPartitionKey

Configurazione della chiave di partizione da usare per il partizionamento dei dati in più partizioni

DataType

Tipo di dati a cui viene applicato il comportamento di indicizzazione.

ExcludedPath
GremlinGraphGetResults

Grafico Azure Cosmos DB Gremlin.

GremlinGraphListResult

Risposta dell'operazione List, che contiene i grafici e le relative proprietà.

IncludedPath

Percorsi inclusi nell'indicizzazione

Indexes

Indici per il percorso.

IndexingMode

Indica la modalità di indicizzazione.

IndexingPolicy

Cosmos DB criteri di indicizzazione

IndexKind

Indica il tipo di indice.

ManagedServiceIdentity

Identità per la risorsa.

Options
PartitionKind

Indica il tipo di algoritmo usato per il partizionamento. Per MultiHash, sono supportate più chiavi di partizione (fino a tre al massimo) per la creazione di contenitori

Resource
ResourceIdentityType

Tipo di identità usato per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'None' rimuoverà le identità dal servizio.

SpatialSpec
UniqueKey

Chiave univoca su che applica il vincolo di univocità ai documenti nella raccolta nel Azure Cosmos DB servizio.

UniqueKeyPolicy

Configurazione dei criteri di chiave univoca per specificare vincoli di univocità per i documenti nella raccolta nel Azure Cosmos DB servizio.

UserAssignedIdentities

Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario di identità utente saranno ID risorsa ARM nel formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

AutoscaleSettings

Name Type Description
maxThroughput
  • integer

Rappresenta la velocità effettiva massima, la risorsa può aumentare le prestazioni.

ConflictResolutionMode

Indica la modalità di risoluzione dei conflitti.

Name Type Description
Custom
  • string
LastWriterWins
  • string

ConflictResolutionPolicy

Criteri di risoluzione dei conflitti per il contenitore.

Name Type Description
conflictResolutionPath
  • string

Percorso di risoluzione dei conflitti nel caso della modalità LastWriterWins.

conflictResolutionProcedure
  • string

Procedura per risolvere i conflitti in caso di modalità personalizzata.

mode

Indica la modalità di risoluzione dei conflitti.

ContainerPartitionKey

Configurazione della chiave di partizione da usare per il partizionamento dei dati in più partizioni

Name Type Description
kind

Indica il tipo di algoritmo usato per il partizionamento. Per MultiHash, sono supportate più chiavi di partizione (fino a tre al massimo) per la creazione di contenitori

paths
  • string[]

Elenco di percorsi che usano i dati all'interno del contenitore che possono essere partizionati

systemKey
  • boolean

Indica se il contenitore usa una chiave di partizione generata dal sistema

version
  • integer

Indica la versione della definizione della chiave di partizione

DataType

Tipo di dati a cui viene applicato il comportamento di indicizzazione.

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

ExcludedPath

Name Type Description
path
  • string

Percorso a cui si applica il comportamento di indicizzazione. I percorsi di indice iniziano in genere con radice e terminano con caratteri jolly (/path/*)

GremlinGraphGetResults

Grafico Azure Cosmos DB Gremlin.

Name Type Description
id
  • string

Identificatore di risorsa univoco della risorsa arm.

identity

Identità per la risorsa.

location
  • string

Posizione del gruppo di risorse a cui appartiene la risorsa.

name
  • string

Nome della risorsa ARM.

properties.options
properties.resource
tags
  • object

I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti di "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB".

type
  • string

Tipo di risorsa di Azure.

GremlinGraphListResult

Risposta dell'operazione List, che contiene i grafici e le relative proprietà.

Name Type Description
value

Elenco di grafici e delle relative proprietà.

IncludedPath

Percorsi inclusi nell'indicizzazione

Name Type Description
indexes

Elenco di indici per questo percorso

path
  • string

Percorso a cui si applica il comportamento di indicizzazione. I percorsi di indice iniziano in genere con radice e terminano con caratteri jolly (/path/*)

Indexes

Indici per il percorso.

Name Type Description
dataType

Tipo di dati a cui viene applicato il comportamento di indicizzazione.

kind

Indica il tipo di indice.

precision
  • integer

Precisione dell'indice. -1 è la precisione massima.

IndexingMode

Indica la modalità di indicizzazione.

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

IndexingPolicy

Cosmos DB criteri di indicizzazione

Name Type Description
automatic
  • boolean

Indica se i criteri di indicizzazione sono automatici

compositeIndexes
  • array[]

Elenco di percorsi compositi

excludedPaths

Elenco di percorsi da escludere dall'indicizzazione

includedPaths

Elenco di percorsi da includere nell'indicizzazione

indexingMode

Indica la modalità di indicizzazione.

spatialIndexes

Elenco di specifiche spaziali

IndexKind

Indica il tipo di indice.

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

ManagedServiceIdentity

Identità per la risorsa.

Name Type Description
principalId
  • string

ID entità dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.

tenantId
  • string

ID tenant dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.

type

Tipo di identità usato per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'None' rimuoverà le identità dal servizio.

userAssignedIdentities

Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario di identità utente saranno ID risorsa ARM nel formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Options

Name Type Description
autoscaleSettings

Specifica le impostazioni di scalabilità automatica.

throughput
  • integer

Valore della velocità effettiva Cosmos DB risorse o scalabilità automaticaImpostazioni. Usare la risorsa ThroughputSetting durante il recupero dei dettagli dell'offerta.

PartitionKind

Indica il tipo di algoritmo usato per il partizionamento. Per MultiHash, sono supportate più chiavi di partizione (fino a tre al massimo) per la creazione di contenitori

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

Resource

Name Type Description
_etag
  • string

Proprietà generata dal sistema che rappresenta l'etag della risorsa necessario per il controllo della concorrenza ottimistica.

_rid
  • string

Proprietà generata dal sistema. Identificatore univoco.

_ts
  • number

Proprietà generata dal sistema che indica l'ultimo timestamp aggiornato della risorsa.

conflictResolutionPolicy

Criteri di risoluzione dei conflitti per il grafo.

defaultTtl
  • integer

Tempo di vita predefinito

id
  • string

Nome del grafo Cosmos DB Gremlin

indexingPolicy

Configurazione dei criteri di indicizzazione. Per impostazione predefinita, l'indicizzazione è automatica per tutti i percorsi dei documenti all'interno del grafico

partitionKey

Configurazione della chiave di partizione da usare per il partizionamento dei dati in più partizioni

uniqueKeyPolicy

Configurazione dei criteri di chiave univoca per specificare vincoli di univocità per i documenti nella raccolta nel Azure Cosmos DB servizio.

ResourceIdentityType

Tipo di identità usato per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'None' rimuoverà le identità dal servizio.

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

SpatialSpec

Name Type Description
path
  • string

Percorso a cui si applica il comportamento di indicizzazione. I percorsi di indice iniziano in genere con radice e terminano con caratteri jolly (/path/*)

types
  • string[]

Elenco del tipo spaziale del percorso

UniqueKey

Chiave univoca su che applica il vincolo di univocità ai documenti nella raccolta nel Azure Cosmos DB servizio.

Name Type Description
paths
  • string[]

L'elenco dei percorsi deve essere univoco per ogni documento nel servizio Azure Cosmos DB

UniqueKeyPolicy

Configurazione dei criteri di chiave univoca per specificare vincoli di univocità per i documenti nella raccolta nel Azure Cosmos DB servizio.

Name Type Description
uniqueKeys

Elenco di chiavi univoche in cui viene applicato il vincolo di univocità nei documenti nella raccolta nel Azure Cosmos DB servizio.

UserAssignedIdentities

Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario di identità utente saranno ID risorsa ARM nel formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name Type Description