Gremlin Resources - List Gremlin Graphs

Lista o grafo do Gremlin em uma conta de banco de dados do Azure Cosmos BD existente.

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

Parâmetros de URI

Name In Required Type Description
accountName
path True
  • string

Cosmos nome da conta de banco de dados do BD.

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

databaseName
path True
  • string

Cosmos nome do banco de dados do BD.

resourceGroupName
path True
  • string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

subscriptionId
path True
  • string

A ID da assinatura de destino.

api-version
query True
  • string

A versão da API a ser usada para essa operação.

Respostas

Name Type Description
200 OK

As propriedades do grafo Gremlin foram recuperadas com êxito.

Segurança

azure_auth

Flow Azure Active Directory OAuth2

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

Scopes

Name Description
user_impersonation Representar sua conta de usuário

Exemplos

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

Definições

AutoscaleSettings
ConflictResolutionMode

Indica o modo de resolução de conflitos.

ConflictResolutionPolicy

A política de resolução de conflitos para o contêiner.

ContainerPartitionKey

A configuração da chave de partição a ser usada para particionar dados em várias partições

DataType

O tipo de dados ao qual o comportamento de indexação é aplicado.

ExcludedPath
GremlinGraphGetResults

Um grafo do Gremlin Cosmos banco de dados do Azure.

GremlinGraphListResult

A resposta da operação Lista, que contém os grafos e suas propriedades.

IncludedPath

Os caminhos incluídos na indexação

Indexes

Os índices do caminho.

IndexingMode

Indica o modo de indexação.

IndexingPolicy

Cosmos política de indexação do BD

IndexKind

Indica o tipo de índice.

ManagedServiceIdentity

Identidade do recurso.

Options
PartitionKind

Indica o tipo de algoritmo usado para particionamento. Para MultiHash, há suporte para várias chaves de partição (até três no máximo) para criação de contêiner

Resource
ResourceIdentityType

O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá as identidades do serviço.

SpatialSpec
UniqueKey

A chave exclusiva sobre isso impõe a restrição de exclusividade em documentos na coleção no serviço de BD Cosmos do Azure.

UniqueKeyPolicy

A configuração de política de chave exclusiva para especificar restrições de exclusividade em documentos na coleção no serviço do Azure Cosmos DB.

UserAssignedIdentities

A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

AutoscaleSettings

Name Type Description
maxThroughput
  • integer

Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente.

ConflictResolutionMode

Indica o modo de resolução de conflitos.

Name Type Description
Custom
  • string
LastWriterWins
  • string

ConflictResolutionPolicy

A política de resolução de conflitos para o contêiner.

Name Type Default Value Description
conflictResolutionPath
  • string

O caminho de resolução de conflitos no caso do modo LastWriterWins.

conflictResolutionProcedure
  • string

O procedimento para resolver conflitos no caso do modo personalizado.

mode LastWriterWins

Indica o modo de resolução de conflitos.

ContainerPartitionKey

A configuração da chave de partição a ser usada para particionar dados em várias partições

Name Type Default Value Description
kind Hash

Indica o tipo de algoritmo usado para particionamento. Para MultiHash, há suporte para várias chaves de partição (até três no máximo) para criação de contêiner

paths
  • string[]

Lista de caminhos usando quais dados dentro do contêiner podem ser particionados

systemKey
  • boolean

Indica se o contêiner está usando uma chave de partição gerada pelo sistema

version
  • integer

Indica a versão da definição da chave de partição

DataType

O tipo de dados ao qual o comportamento de indexação é aplicado.

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

ExcludedPath

Name Type Description
path
  • string

O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice geralmente começam com raiz e término com curinga (/path/*)

GremlinGraphGetResults

Um grafo do Gremlin Cosmos banco de dados do Azure.

Name Type Description
id
  • string

O identificador de recurso exclusivo do recurso do ARM.

identity

Identidade do recurso.

location
  • string

O local do grupo de recursos ao qual o recurso pertence.

name
  • string

O nome do recurso arm.

properties.options
properties.resource
tags
  • object

As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB".

type
  • string

O tipo de recurso do Azure.

GremlinGraphListResult

A resposta da operação Lista, que contém os grafos e suas propriedades.

Name Type Description
value

Lista de grafos e suas propriedades.

IncludedPath

Os caminhos incluídos na indexação

Name Type Description
indexes

Lista de índices para este caminho

path
  • string

O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice geralmente começam com raiz e término com curinga (/path/*)

Indexes

Os índices do caminho.

Name Type Default Value Description
dataType String

O tipo de dados ao qual o comportamento de indexação é aplicado.

kind Hash

Indica o tipo de índice.

precision
  • integer

A precisão do índice. -1 é a precisão máxima.

IndexingMode

Indica o modo de indexação.

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

IndexingPolicy

Cosmos política de indexação do BD

Name Type Default Value Description
automatic
  • boolean

Indica se a política de indexação é automática

compositeIndexes
  • array[]

Lista de lista de caminhos compostos

excludedPaths

Lista de caminhos a serem excluídos da indexação

includedPaths

Lista de caminhos a serem incluídos na indexação

indexingMode consistent

Indica o modo de indexação.

spatialIndexes

Lista de detalhes espaciais

IndexKind

Indica o tipo de índice.

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

ManagedServiceIdentity

Identidade do recurso.

Name Type Description
principalId
  • string

A ID principal da identidade atribuída pelo sistema. Essa propriedade só será fornecida para uma identidade atribuída pelo sistema.

tenantId
  • string

A ID do locatário da identidade atribuída pelo sistema. Essa propriedade só será fornecida para uma identidade atribuída pelo sistema.

type

O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá as identidades do serviço.

userAssignedIdentities

A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Options

Name Type Description
autoscaleSettings

Especifica as configurações de Dimensionamento Automático.

throughput
  • integer

Valor da taxa de transferência de recurso do banco de Cosmos ou dimensionamento automático. Use o recurso ThroughputSetting ao recuperar detalhes da oferta.

PartitionKind

Indica o tipo de algoritmo usado para particionamento. Para MultiHash, há suporte para várias chaves de partição (até três no máximo) para criação de contêiner

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

Resource

Name Type Description
_etag
  • string

Uma propriedade gerada pelo sistema que representa a etag de recurso necessária para o controle de simultaneidade otimista.

_rid
  • string

Uma propriedade gerada pelo sistema. Um identificador exclusivo.

_ts
  • number

Uma propriedade gerada pelo sistema que denota o último carimbo de data/hora atualizado do recurso.

conflictResolutionPolicy

A política de resolução de conflitos para o grafo.

defaultTtl
  • integer

Tempo de vida padrão

id
  • string

Nome do grafo gremlin do banco de dados Cosmos

indexingPolicy

A configuração da política de indexação. Por padrão, a indexação é automática para todos os caminhos de documento no grafo

partitionKey

A configuração da chave de partição a ser usada para particionar dados em várias partições

uniqueKeyPolicy

A configuração de política de chave exclusiva para especificar restrições de exclusividade em documentos na coleção no serviço do Azure Cosmos DB.

ResourceIdentityType

O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá as identidades do serviço.

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

SpatialSpec

Name Type Description
path
  • string

O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice geralmente começam com raiz e término com curinga (/path/*)

types
  • string[]

Lista do tipo espacial do caminho

UniqueKey

A chave exclusiva sobre isso impõe a restrição de exclusividade em documentos na coleção no serviço de BD Cosmos do Azure.

Name Type Description
paths
  • string[]

A lista de caminhos deve ser exclusiva para cada documento no serviço do Azure Cosmos DB

UniqueKeyPolicy

A configuração de política de chave exclusiva para especificar restrições de exclusividade em documentos na coleção no serviço do Azure Cosmos DB.

Name Type Description
uniqueKeys

Lista de chaves exclusivas que impõem restrição de exclusividade em documentos na coleção no serviço do Azure Cosmos DB.

UserAssignedIdentities

A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name Type Description