Compartilhar via

Banco de dados Microsoft.DocumentDBAccounts/gremlinDatabases/graphs 2021-03-15

  • Artigo

Definição de recurso do Bicep

O tipo de recurso databaseAccounts/gremlinDatabases/graphs pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs, adicione o seguinte Bicep ao modelo.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-03-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: 'string'
      }
      defaultTtl: int
      id: 'string'
      indexingPolicy: {
        automatic: bool
        compositeIndexes: [
          [
            {
              order: 'string'
              path: 'string'
            }
          ]
        ]
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
        spatialIndexes: [
          {
            path: 'string'
            types: [
              'string'
            ]
          }
        ]
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

AutoscaleSettings

Nome Descrição Valor
maxThroughput Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente. int

CompositePath

Nome Descrição Valor
ordem Ordem de classificação para caminhos compostos. 'crescente'
'decrescente'
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) corda

ConflictResolutionPolicy

Nome Descrição Valor
conflictResolutionPath O caminho de resolução de conflitos no caso do modo LastWriterWins. corda
conflictResolutionProcedure O procedimento para resolver conflitos no caso do modo personalizado. corda
modo Indica o modo de resolução de conflitos. 'Personalizado'
'LastWriterWins'

ContainerPartitionKey

Nome Descrição Valor
tipo 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 'Hash'
'MultiHash'
'Range'
Caminhos Lista de caminhos usando quais dados dentro do contêiner podem ser particionados string[]
Versão Indica a versão da definição da chave de partição int

Restrições:
Valor mínimo = 1
Valor máximo = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

Nome Descrição Valor
autoscaleSettings Especifica as configurações de Dimensionamento Automático. autoscaleSettings
throughput Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. int

ExcludedPath

Nome Descrição Valor
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) corda

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

Nome Descrição Valor
Opções Um par de opções chave-valor a ser aplicado à solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions
recurso O formato JSON padrão de um grafo do Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResource (obrigatório)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Nome Descrição Valor
conflictResolutionPolicy A política de resolução de conflitos para o grafo. ConflictResolutionPolicy
defaultTtl Tempo de vida padrão int
id Nome do grafo Gremlin do Cosmos DB cadeia de caracteres (obrigatório)
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 indexingPolicy
partitionKey A configuração da chave de partição a ser usada para particionar dados em várias partições ContainerPartitionKey
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. UniqueKeyPolicy

IncludedPath

Nome Descrição Valor
Índices Lista de índices para este caminho índices []
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) corda

Índices

Nome Descrição Valor
Datatype O tipo de dados ao qual o comportamento de indexação é aplicado. 'LineString'
'MultiPolygon'
'Número'
'Point'
'Polígono'
'String'
tipo Indica o tipo de índice. 'Hash'
'Range'
'Espacial'
precisão A precisão do índice. -1 é precisão máxima. int

IndexingPolicy

Nome Descrição Valor
Automático Indica se a política de indexação é automática Bool
compositeIndexes Lista de lista de caminhos compostos CompositePath [][]
excludedPaths Lista de caminhos a serem excluídos da indexação ExcludedPath []
includedPaths Lista de caminhos a serem incluídos na indexação IncludedPath []
indexingMode Indica o modo de indexação. 'consistente'
'preguiçoso'
'none'
spatialIndexes Lista de especificidades espaciais SpatialSpec []

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Nome Descrição Valor
localização O local do grupo de recursos ao qual o recurso pertence. corda
nome O nome do recurso cadeia de caracteres (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.		 Nome simbólico para recurso do tipo: databaseAccounts/gremlinDatabases
Propriedades Propriedades para criar e atualizar o grafo gremlin do Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

SpatialSpec

Nome Descrição Valor
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) corda
Tipos Lista do tipo espacial do caminho Matriz de cadeia de caracteres que contém qualquer um dos:
'LineString'
'MultiPolygon'
'Point'
'Polígono'

Tags

Nome Descrição Valor

UniqueKey

Nome Descrição Valor
Caminhos A lista de caminhos deve ser exclusiva para cada documento no serviço do Azure Cosmos DB string[]

UniqueKeyPolicy

Nome Descrição Valor
uniqueKeys Lista de chaves exclusivas que impõem restrição de exclusividade em documentos na coleção no serviço do Azure Cosmos DB. UniqueKey []

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep Descrição
Criar uma conta do Azure Cosmos DB para a API do Gremlin Esse modelo cria uma conta do Azure Cosmos DB para a API do Gremlin em duas regiões com um banco de dados e um grafo usando taxa de transferência dedicada.
Criar uma conta do Azure Cosmos DB para o dimensionamento automático da API do Gremlin Esse modelo cria uma conta do Azure Cosmos DB para a API do Gremlin em duas regiões com um banco de dados e um grafo usando a taxa de transferência de dimensionamento automático.

Definição de recurso de modelo do ARM

O tipo de recurso databaseAccounts/gremlinDatabases/graphs pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
  "apiVersion": "2021-03-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "string"
      },
      "defaultTtl": "int",
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "compositeIndexes": [
          [
            {
              "order": "string",
              "path": "string"
            }
          ]
        ],
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string",
        "spatialIndexes": [
          {
            "path": "string",
            "types": [ "string" ]
          }
        ]
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

AutoscaleSettings

Nome Descrição Valor
maxThroughput Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente. int

CompositePath

Nome Descrição Valor
ordem Ordem de classificação para caminhos compostos. 'crescente'
'decrescente'
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) corda

ConflictResolutionPolicy

Nome Descrição Valor
conflictResolutionPath O caminho de resolução de conflitos no caso do modo LastWriterWins. corda
conflictResolutionProcedure O procedimento para resolver conflitos no caso do modo personalizado. corda
modo Indica o modo de resolução de conflitos. 'Personalizado'
'LastWriterWins'

ContainerPartitionKey

Nome Descrição Valor
tipo 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 'Hash'
'MultiHash'
'Range'
Caminhos Lista de caminhos usando quais dados dentro do contêiner podem ser particionados string[]
Versão Indica a versão da definição da chave de partição int

Restrições:
Valor mínimo = 1
Valor máximo = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

Nome Descrição Valor
autoscaleSettings Especifica as configurações de Dimensionamento Automático. autoscaleSettings
throughput Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. int

ExcludedPath

Nome Descrição Valor
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) corda

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

Nome Descrição Valor
Opções Um par de opções chave-valor a ser aplicado à solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions
recurso O formato JSON padrão de um grafo do Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResource (obrigatório)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Nome Descrição Valor
conflictResolutionPolicy A política de resolução de conflitos para o grafo. ConflictResolutionPolicy
defaultTtl Tempo de vida padrão int
id Nome do grafo Gremlin do Cosmos DB cadeia de caracteres (obrigatório)
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 indexingPolicy
partitionKey A configuração da chave de partição a ser usada para particionar dados em várias partições ContainerPartitionKey
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. UniqueKeyPolicy

IncludedPath

Nome Descrição Valor
Índices Lista de índices para este caminho índices []
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) corda

Índices

Nome Descrição Valor
Datatype O tipo de dados ao qual o comportamento de indexação é aplicado. 'LineString'
'MultiPolygon'
'Número'
'Point'
'Polígono'
'String'
tipo Indica o tipo de índice. 'Hash'
'Range'
'Espacial'
precisão A precisão do índice. -1 é precisão máxima. int

IndexingPolicy

Nome Descrição Valor
Automático Indica se a política de indexação é automática Bool
compositeIndexes Lista de lista de caminhos compostos CompositePath [][]
excludedPaths Lista de caminhos a serem excluídos da indexação ExcludedPath []
includedPaths Lista de caminhos a serem incluídos na indexação IncludedPath []
indexingMode Indica o modo de indexação. 'consistente'
'preguiçoso'
'none'
spatialIndexes Lista de especificidades espaciais SpatialSpec []

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Nome Descrição Valor
apiVersion A versão da API '2021-03-15'
localização O local do grupo de recursos ao qual o recurso pertence. corda
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades para criar e atualizar o grafo gremlin do Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs'

SpatialSpec

Nome Descrição Valor
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) corda
Tipos Lista do tipo espacial do caminho Matriz de cadeia de caracteres que contém qualquer um dos:
'LineString'
'MultiPolygon'
'Point'
'Polígono'

Tags

Nome Descrição Valor

UniqueKey

Nome Descrição Valor
Caminhos A lista de caminhos deve ser exclusiva para cada documento no serviço do Azure Cosmos DB string[]

UniqueKeyPolicy

Nome Descrição Valor
uniqueKeys Lista de chaves exclusivas que impõem restrição de exclusividade em documentos na coleção no serviço do Azure Cosmos DB. UniqueKey []

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Criar uma conta do Azure Cosmos DB para a API do Gremlin

Implantar no Azure 		Esse modelo cria uma conta do Azure Cosmos DB para a API do Gremlin em duas regiões com um banco de dados e um grafo usando taxa de transferência dedicada.
Criar uma conta do Azure Cosmos DB para o dimensionamento automático da API do Gremlin

Implantar no Azure 		Esse modelo cria uma conta do Azure Cosmos DB para a API do Gremlin em duas regiões com um banco de dados e um grafo usando a taxa de transferência de dimensionamento automático.

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso databaseAccounts/gremlinDatabases/graphs pode ser implantado com operações direcionadas:

  • grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-03-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "string"
        }
        defaultTtl = int
        id = "string"
        indexingPolicy = {
          automatic = bool
          compositeIndexes = [
            [
              {
                order = "string"
                path = "string"
              }
            ]
          ]
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
          spatialIndexes = [
            {
              path = "string"
              types = [
                "string"
              ]
            }
          ]
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

Valores de propriedade

AutoscaleSettings

Nome Descrição Valor
maxThroughput Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente. int

CompositePath

Nome Descrição Valor
ordem Ordem de classificação para caminhos compostos. 'crescente'
'decrescente'
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) corda

ConflictResolutionPolicy

Nome Descrição Valor
conflictResolutionPath O caminho de resolução de conflitos no caso do modo LastWriterWins. corda
conflictResolutionProcedure O procedimento para resolver conflitos no caso do modo personalizado. corda
modo Indica o modo de resolução de conflitos. 'Personalizado'
'LastWriterWins'

ContainerPartitionKey

Nome Descrição Valor
tipo 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 'Hash'
'MultiHash'
'Range'
Caminhos Lista de caminhos usando quais dados dentro do contêiner podem ser particionados string[]
Versão Indica a versão da definição da chave de partição int

Restrições:
Valor mínimo = 1
Valor máximo = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

Nome Descrição Valor
autoscaleSettings Especifica as configurações de Dimensionamento Automático. autoscaleSettings
throughput Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. int

ExcludedPath

Nome Descrição Valor
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) corda

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

Nome Descrição Valor
Opções Um par de opções chave-valor a ser aplicado à solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions
recurso O formato JSON padrão de um grafo do Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResource (obrigatório)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Nome Descrição Valor
conflictResolutionPolicy A política de resolução de conflitos para o grafo. ConflictResolutionPolicy
defaultTtl Tempo de vida padrão int
id Nome do grafo Gremlin do Cosmos DB cadeia de caracteres (obrigatório)
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 indexingPolicy
partitionKey A configuração da chave de partição a ser usada para particionar dados em várias partições ContainerPartitionKey
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. UniqueKeyPolicy

IncludedPath

Nome Descrição Valor
Índices Lista de índices para este caminho índices []
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) corda

Índices

Nome Descrição Valor
Datatype O tipo de dados ao qual o comportamento de indexação é aplicado. 'LineString'
'MultiPolygon'
'Número'
'Point'
'Polígono'
'String'
tipo Indica o tipo de índice. 'Hash'
'Range'
'Espacial'
precisão A precisão do índice. -1 é precisão máxima. int

IndexingPolicy

Nome Descrição Valor
Automático Indica se a política de indexação é automática Bool
compositeIndexes Lista de lista de caminhos compostos CompositePath [][]
excludedPaths Lista de caminhos a serem excluídos da indexação ExcludedPath []
includedPaths Lista de caminhos a serem incluídos na indexação IncludedPath []
indexingMode Indica o modo de indexação. 'consistente'
'preguiçoso'
'none'
spatialIndexes Lista de especificidades espaciais SpatialSpec []

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Nome Descrição Valor
localização O local do grupo de recursos ao qual o recurso pertence. corda
nome O nome do recurso cadeia de caracteres (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: databaseAccounts/gremlinDatabases
Propriedades Propriedades para criar e atualizar o grafo gremlin do Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-03-15"

SpatialSpec

Nome Descrição Valor
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) corda
Tipos Lista do tipo espacial do caminho Matriz de cadeia de caracteres que contém qualquer um dos:
'LineString'
'MultiPolygon'
'Point'
'Polígono'

Tags

Nome Descrição Valor

UniqueKey

Nome Descrição Valor
Caminhos A lista de caminhos deve ser exclusiva para cada documento no serviço do Azure Cosmos DB string[]

UniqueKeyPolicy

Nome Descrição Valor
uniqueKeys Lista de chaves exclusivas que impõem restrição de exclusividade em documentos na coleção no serviço do Azure Cosmos DB. UniqueKey []