Gremlin Resources - List Gremlin Graphs

Referenz

Service:: Cosmos DB Resource Provider

API Version:: 2021-04-01-preview

Listet das Gremlin-Diagramm unter einem vorhandenen Azure Cosmos DB-Datenbankkonto auf.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string	Name des Cosmos DB-Datenbankkontos. Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
databaseName	path	True	string	Cosmos DB-Datenbankname.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	GremlinGraphListResult	Die Eigenschaften des Gremlin-Diagramms wurden erfolgreich abgerufen.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

CosmosDBGremlinGraphList

Sample Request

HTTP

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

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

Definitionen

Name	Beschreibung
AutoscaleSettings
CompositePath
CompositePathSortOrder	Sortierreihenfolge für zusammengesetzte Pfade.
ConflictResolutionMode	Gibt den Konfliktlösungsmodus an.
ConflictResolutionPolicy	Die Konfliktlösungsrichtlinie für den Container.
ContainerPartitionKey	Die Konfiguration des Partitionsschlüssels, der zum Partitionieren von Daten in mehrere Partitionen verwendet werden soll
DataType	Der Datentyp, auf den das Indizierungsverhalten angewendet wird.
ExcludedPath
GremlinGraphGetResults	Ein Azure Cosmos DB-Gremlin-Diagramm.
GremlinGraphListResult	Die List-Vorgangsantwort, die die Diagramme und ihre Eigenschaften enthält.
IncludedPath	Die Pfade, die in der Indizierung enthalten sind
Indexes	Die Indizes für den Pfad.
IndexingMode	Gibt den Indizierungsmodus an.
IndexingPolicy	Cosmos DB-Indizierungsrichtlinie
IndexKind	Gibt den Indextyp an.
ManagedServiceIdentity	Identität für die Ressource.
Options
PartitionKind	Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. Für MultiHash werden mehrere Partitionsschlüssel (bis zu drei maximal) für die Containererstellung unterstützt.
Resource
ResourceIdentityType	Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.
SpatialSpec
SpatialType	Gibt den räumlichen Typ des Indexes an.
UniqueKey	Der eindeutige Schlüssel für, der die Eindeutigkeitseinschränkung für Dokumente in der Sammlung im Azure Cosmos DB-Dienst erzwingt.
UniqueKeyPolicy	Die Richtlinienkonfiguration für eindeutige Schlüssel zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst.
UserAssignedIdentities	Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

AutoscaleSettings

Name	Typ	Beschreibung
maxThroughput	integer	Stellt den maximalen Durchsatz dar, auf den die Ressource hochskaliert werden kann.

CompositePath

Name	Typ	Beschreibung
order	CompositePathSortOrder	Sortierreihenfolge für zusammengesetzte Pfade.
path	string	Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Platzhalter (/path/*)

CompositePathSortOrder

Sortierreihenfolge für zusammengesetzte Pfade.

Name	Typ	Beschreibung
ascending	string
descending	string

ConflictResolutionMode

Gibt den Konfliktlösungsmodus an.

Name	Typ	Beschreibung
Custom	string
LastWriterWins	string

ConflictResolutionPolicy

Die Konfliktlösungsrichtlinie für den Container.

Name	Typ	Standardwert	Beschreibung
conflictResolutionPath	string		Der Konfliktlösungspfad im Fall des LastWriterWins-Modus.
conflictResolutionProcedure	string		Das Verfahren zum Auflösen von Konflikten im Fall des benutzerdefinierten Modus.
mode	ConflictResolutionMode	LastWriterWins	Gibt den Konfliktlösungsmodus an.

ContainerPartitionKey

Die Konfiguration des Partitionsschlüssels, der zum Partitionieren von Daten in mehrere Partitionen verwendet werden soll

Name	Typ	Standardwert	Beschreibung
kind	PartitionKind	Hash	Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. Für MultiHash werden mehrere Partitionsschlüssel (bis zu drei maximal) für die Containererstellung unterstützt.
paths	string[]		Liste der Pfade, mit denen Daten innerhalb des Containers partitioniert werden können
systemKey	boolean		Gibt an, ob der Container einen vom System generierten Partitionsschlüssel verwendet.
version	integer		Gibt die Version der Partitionsschlüsseldefinition an.

DataType

Der Datentyp, auf den das Indizierungsverhalten angewendet wird.

Name	Typ	Beschreibung
LineString	string
MultiPolygon	string
Number	string
Point	string
Polygon	string
String	string

ExcludedPath

Name	Typ	Beschreibung
path	string	Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Platzhalter (/path/*)

GremlinGraphGetResults

Ein Azure Cosmos DB-Gremlin-Diagramm.

Name	Typ	Beschreibung
id	string	Der eindeutige Ressourcenbezeichner der ARM-Ressource.
identity	ManagedServiceIdentity	Identität für die Ressource.
location	string	Der Speicherort der Ressourcengruppe, zu der die Ressource gehört.
name	string	Der Name der ARM-Ressource.
properties.options	Options
properties.resource	Resource
tags	object	Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB".
type	string	Der Typ der Azure-Ressource.

GremlinGraphListResult

Die List-Vorgangsantwort, die die Diagramme und ihre Eigenschaften enthält.

Name	Typ	Beschreibung
value	GremlinGraphGetResults[]	Liste der Diagramme und deren Eigenschaften.

IncludedPath

Die Pfade, die in der Indizierung enthalten sind

Name	Typ	Beschreibung
indexes	Indexes[]	Liste der Indizes für diesen Pfad
path	string	Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Platzhalter (/path/*)

Indexes

Die Indizes für den Pfad.

Name	Typ	Standardwert	Beschreibung
dataType	DataType	String	Der Datentyp, auf den das Indizierungsverhalten angewendet wird.
kind	IndexKind	Hash	Gibt den Indextyp an.
precision	integer		Die Genauigkeit des Indexes. -1 ist maximale Genauigkeit.

IndexingMode

Gibt den Indizierungsmodus an.

Name	Typ	Beschreibung
consistent	string
lazy	string
none	string

IndexingPolicy

Cosmos DB-Indizierungsrichtlinie

Name	Typ	Standardwert	Beschreibung
automatic	boolean		Gibt an, ob die Indizierungsrichtlinie automatisch ist.
compositeIndexes	CompositePath[]		Liste der zusammengesetzten Pfadliste
excludedPaths	ExcludedPath[]		Liste der Pfade, die von der Indizierung ausgeschlossen werden sollen
includedPaths	IncludedPath[]		Liste der Pfade, die in die Indizierung einbezogen werden sollen
indexingMode	IndexingMode	consistent	Gibt den Indizierungsmodus an.
spatialIndexes	SpatialSpec[]		Liste der räumlichen Besonderheiten

IndexKind

Gibt den Indextyp an.

Name	Typ	Beschreibung
Hash	string
Range	string
Spatial	string

ManagedServiceIdentity

Identität für die Ressource.

Name	Typ	Beschreibung
principalId	string	Die Prinzipal-ID der systemseitig zugewiesenen Identität. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.
tenantId	string	Die Mandanten-ID der systemseitig zugewiesenen Identität. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.
type	ResourceIdentityType	Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.
userAssignedIdentities	UserAssignedIdentities	Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Options

Name	Typ	Beschreibung
autoscaleSettings	AutoscaleSettings	Gibt die Einstellungen für die automatische Skalierung an.
throughput	integer	Wert des Cosmos DB-Ressourcendurchsatzes oder autoscaleSettings. Verwenden Sie die Ressource ThroughputSetting beim Abrufen von Angebotsdetails.

PartitionKind

Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. Für MultiHash werden mehrere Partitionsschlüssel (bis zu drei maximal) für die Containererstellung unterstützt.

Name	Typ	Beschreibung
Hash	string
MultiHash	string
Range	string

Resource

Name	Typ	Beschreibung
_etag	string	Eine vom System generierte Eigenschaft, die das Ressourcen-Etag darstellt, das für die Steuerung der optimistischen Parallelität erforderlich ist.
_rid	string	Eine vom System generierte Eigenschaft. Einen eindeutigen Bezeichner.
_ts	number	Eine vom System generierte Eigenschaft, die den zuletzt aktualisierten Zeitstempel der Ressource angibt.
conflictResolutionPolicy	ConflictResolutionPolicy	Die Konfliktlösungsrichtlinie für das Diagramm.
defaultTtl	integer	Standardzeit
id	string	Name des Cosmos DB Gremlin-Graphen
indexingPolicy	IndexingPolicy	Die Konfiguration der Indizierungsrichtlinie. Standardmäßig erfolgt die Indizierung für alle Dokumentpfade innerhalb des Diagramms automatisch.
partitionKey	ContainerPartitionKey	Die Konfiguration des Partitionsschlüssels, der zum Partitionieren von Daten in mehrere Partitionen verwendet werden soll
uniqueKeyPolicy	UniqueKeyPolicy	Die Richtlinienkonfiguration für eindeutige Schlüssel zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst.

ResourceIdentityType

Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.

Name	Typ	Beschreibung
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

SpatialSpec

Name	Typ	Beschreibung
path	string	Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Platzhalter (/path/*)
types	SpatialType[]	Liste des räumlichen Pfadtyps

SpatialType

Gibt den räumlichen Typ des Indexes an.

Name	Typ	Beschreibung
LineString	string
MultiPolygon	string
Point	string
Polygon	string

UniqueKey

Der eindeutige Schlüssel für, der die Eindeutigkeitseinschränkung für Dokumente in der Sammlung im Azure Cosmos DB-Dienst erzwingt.

Name	Typ	Beschreibung
paths	string[]	Die Liste der Pfade muss für jedes Dokument im Azure Cosmos DB-Dienst eindeutig sein.

UniqueKeyPolicy

Die Richtlinienkonfiguration für eindeutige Schlüssel zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst.

Name	Typ	Beschreibung
uniqueKeys	UniqueKey[]	Liste der eindeutigen Schlüssel für, die die Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst erzwingen.

UserAssignedIdentities

Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Name	Typ	Beschreibung