Partilhar via

Microsoft.DocumentDB databaseAccounts/gremlinDatabases/graphs 2019-08-01

  • Artigo

Definição de recursos do bíceps

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 log de alterações.

Formato do recurso

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2019-08-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      {customized property}: 'string'
    }
    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

CompositePath

Designação Descrição Valor
Encomenda Ordem de classificação para caminhos compostos. 'Ascendente'
'Descendente'
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/*) string

Resolução de ConflitosPolítica

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

ContainerPartitionKey

Designação Descrição Valor
tipo Indica o tipo de algoritmo usado para particionamento 'Hash'
'Gama'
Caminhos Lista de caminhos usando quais dados dentro do contêiner podem ser particionados string[]
Versão Indica a versão da definição de chave de partição Int

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

CreateUpdateOptions

Designação Descrição Valor

Caminho Excluído

Designação 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/*) string

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

Designação Descrição Valor
Opções Um par de opções chave-valor a ser aplicado para a solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. CreateUpdateOptions (obrigatório)
recurso O formato JSON padrão de um gráfico Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResource (obrigatório)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Designação Descrição Valor
resolução de conflitosPolítica A política de resolução de conflitos para o gráfico. ConflictResolutionPolicy
padrãoTtl Tempo de vida padrão Int
ID Nome do gráfico Cosmos DB Gremlin string (obrigatório)
indexaçãoPolítica A configuração da política de indexação. Por padrão, a indexação é automática para todos os caminhos de documentos dentro do gráfico IndexaçãoPolítica
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 Azure Cosmos DB. UniqueKeyPolicy

IncludedPath

Designação 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/*) string

Índices

Designação Descrição Valor
Tipo de dados O tipo de dados ao qual o comportamento de indexação é aplicado. 'LineString'
'Multipolígono'
'Número'
'Ponto'
'Polígono'
'String'
tipo Indica o tipo de índice. 'Hash'
'Gama'
'Espacial'
precisão A precisão do índice. -1 é a precisão máxima. Int

Política de indexação

Designação Descrição Valor
Automático Indica se a política de indexação é automática Bool
compositeIndexes Lista de caminhos compostos CompositePath [][]
excludedCaminhos Lista de caminhos a excluir da indexação ExcludedPath[]
incluídosCaminhos Lista de caminhos a incluir na indexação IncludedPath[]
indexaçãoModo de indexação Indica o modo de indexação. 'Consistente'
'Preguiçoso'
'Nenhuma'
spatialIndexes Lista de especificidades espaciais SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Designação Descrição Valor
Localização O local do grupo de recursos ao qual o recurso pertence. string
Designação O nome do recurso string (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 gráfico Gremlin do Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

SpatialSpec

Designação 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/*) string
tipos Lista do tipo espacial do caminho Matriz de cadeia de caracteres contendo qualquer uma das:
'LineString'
'Multipolígono'
'Ponto'
'Polígono'

Etiquetas

Designação Descrição Valor

Chave Única

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

UniqueKeyPolicy

Designação Descrição Valor
uniqueKeys Lista de chaves exclusivas que impõe restrição de exclusividade em documentos na coleção no serviço 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 Gremlin Este modelo cria uma conta do Azure Cosmos DB para a API Gremlin em duas regiões com um banco de dados e um gráfico usando taxa de transferência dedicada.
Criar uma conta do Azure Cosmos DB para o de dimensionamento automático da API Gremlin Este modelo cria uma conta do Azure Cosmos DB para a API Gremlin em duas regiões com um banco de dados e um gráfico usando a taxa de transferência de escala automática.

Definição de recurso de modelo 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 log de alterações.

Formato do recurso

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
  "apiVersion": "2019-08-01",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "{customized property}": "string"
    },
    "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

CompositePath

Designação Descrição Valor
Encomenda Ordem de classificação para caminhos compostos. 'Ascendente'
'Descendente'
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/*) string

Resolução de ConflitosPolítica

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

ContainerPartitionKey

Designação Descrição Valor
tipo Indica o tipo de algoritmo usado para particionamento 'Hash'
'Gama'
Caminhos Lista de caminhos usando quais dados dentro do contêiner podem ser particionados string[]
Versão Indica a versão da definição de chave de partição Int

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

CreateUpdateOptions

Designação Descrição Valor

Caminho Excluído

Designação 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/*) string

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

Designação Descrição Valor
Opções Um par de opções chave-valor a ser aplicado para a solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. CreateUpdateOptions (obrigatório)
recurso O formato JSON padrão de um gráfico Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResource (obrigatório)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Designação Descrição Valor
resolução de conflitosPolítica A política de resolução de conflitos para o gráfico. ConflictResolutionPolicy
padrãoTtl Tempo de vida padrão Int
ID Nome do gráfico Cosmos DB Gremlin string (obrigatório)
indexaçãoPolítica A configuração da política de indexação. Por padrão, a indexação é automática para todos os caminhos de documentos dentro do gráfico IndexaçãoPolítica
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 Azure Cosmos DB. UniqueKeyPolicy

IncludedPath

Designação 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/*) string

Índices

Designação Descrição Valor
Tipo de dados O tipo de dados ao qual o comportamento de indexação é aplicado. 'LineString'
'Multipolígono'
'Número'
'Ponto'
'Polígono'
'String'
tipo Indica o tipo de índice. 'Hash'
'Gama'
'Espacial'
precisão A precisão do índice. -1 é a precisão máxima. Int

Política de indexação

Designação Descrição Valor
Automático Indica se a política de indexação é automática Bool
compositeIndexes Lista de caminhos compostos CompositePath [][]
excludedCaminhos Lista de caminhos a excluir da indexação ExcludedPath[]
incluídosCaminhos Lista de caminhos a incluir na indexação IncludedPath[]
indexaçãoModo de indexação Indica o modo de indexação. 'Consistente'
'Preguiçoso'
'Nenhuma'
spatialIndexes Lista de especificidades espaciais SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Designação Descrição Valor
apiVersion A versão api '2019-08-01'
Localização O local do grupo de recursos ao qual o recurso pertence. string
Designação O nome do recurso string (obrigatório)
propriedades Propriedades para criar e atualizar o gráfico Gremlin do Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs'

SpatialSpec

Designação 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/*) string
tipos Lista do tipo espacial do caminho Matriz de cadeia de caracteres contendo qualquer uma das:
'LineString'
'Multipolígono'
'Ponto'
'Polígono'

Etiquetas

Designação Descrição Valor

Chave Única

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

UniqueKeyPolicy

Designação Descrição Valor
uniqueKeys Lista de chaves exclusivas que impõe restrição de exclusividade em documentos na coleção no serviço 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 Gremlin

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

Implantar no Azure 		Este modelo cria uma conta do Azure Cosmos DB para a API Gremlin em duas regiões com um banco de dados e um gráfico usando a taxa de transferência de escala automática.

Definição de recursos Terraform (provedor 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 log de alterações.

Formato do recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2019-08-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        {customized property} = "string"
      }
      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

CompositePath

Designação Descrição Valor
Encomenda Ordem de classificação para caminhos compostos. 'Ascendente'
'Descendente'
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/*) string

Resolução de ConflitosPolítica

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

ContainerPartitionKey

Designação Descrição Valor
tipo Indica o tipo de algoritmo usado para particionamento 'Hash'
'Gama'
Caminhos Lista de caminhos usando quais dados dentro do contêiner podem ser particionados string[]
Versão Indica a versão da definição de chave de partição Int

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

CreateUpdateOptions

Designação Descrição Valor

Caminho Excluído

Designação 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/*) string

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

Designação Descrição Valor
Opções Um par de opções chave-valor a ser aplicado para a solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. CreateUpdateOptions (obrigatório)
recurso O formato JSON padrão de um gráfico Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResource (obrigatório)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Designação Descrição Valor
resolução de conflitosPolítica A política de resolução de conflitos para o gráfico. ConflictResolutionPolicy
padrãoTtl Tempo de vida padrão Int
ID Nome do gráfico Cosmos DB Gremlin string (obrigatório)
indexaçãoPolítica A configuração da política de indexação. Por padrão, a indexação é automática para todos os caminhos de documentos dentro do gráfico IndexaçãoPolítica
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 Azure Cosmos DB. UniqueKeyPolicy

IncludedPath

Designação 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/*) string

Índices

Designação Descrição Valor
Tipo de dados O tipo de dados ao qual o comportamento de indexação é aplicado. 'LineString'
'Multipolígono'
'Número'
'Ponto'
'Polígono'
'String'
tipo Indica o tipo de índice. 'Hash'
'Gama'
'Espacial'
precisão A precisão do índice. -1 é a precisão máxima. Int

Política de indexação

Designação Descrição Valor
Automático Indica se a política de indexação é automática Bool
compositeIndexes Lista de caminhos compostos CompositePath [][]
excludedCaminhos Lista de caminhos a excluir da indexação ExcludedPath[]
incluídosCaminhos Lista de caminhos a incluir na indexação IncludedPath[]
indexaçãoModo de indexação Indica o modo de indexação. 'Consistente'
'Preguiçoso'
'Nenhuma'
spatialIndexes Lista de especificidades espaciais SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Designação Descrição Valor
Localização O local do grupo de recursos ao qual o recurso pertence. string
Designação O nome do recurso string (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID para recurso do tipo: databaseAccounts/gremlinDatabases
propriedades Propriedades para criar e atualizar o gráfico Gremlin do Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2019-08-01"

SpatialSpec

Designação 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/*) string
tipos Lista do tipo espacial do caminho Matriz de cadeia de caracteres contendo qualquer uma das:
'LineString'
'Multipolígono'
'Ponto'
'Polígono'

Etiquetas

Designação Descrição Valor

Chave Única

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

UniqueKeyPolicy

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