Share via


Banco de dados Microsoft.DocumentDBAccounts/apis/databases/graphs 2015-04-01

Definição de recurso do Bicep

O tipo de recurso databaseAccounts/apis/databases/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 de recurso

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2015-04-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    options: {
      {customized property}: 'string'
    }
    resource: {
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: 'string'
      }
      defaultTtl: int
      id: 'string'
      indexingPolicy: {
        automatic: bool
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
}

Valores de propriedade

databaseAccounts/apis/databases/graphs

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos filho no Bicep.
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 o recurso do tipo: bancos de dados
properties Propriedades para criar e atualizar o grafo gremlin do Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp... (obrigatório)

GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp...

Nome Descrição Valor
opções Um par chave-valor de opções 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 grafo do Gremlin GremlinGraphResource (obrigatório)

CreateUpdateOptions

Nome Descrição Valor
{propriedade personalizada} string

GremlinGraphResource

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 do 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

Conflictresolutionpolicy

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

IndexingPolicy

Nome Descrição Valor
automático Indica se a política de indexação é automática bool
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'

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/*) string

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/*) string

Índices

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

ContainerPartitionKey

Nome Descrição Valor
kind Indica o tipo de algoritmo usado para particionamento 'Hash'
'Range'
caminhos Lista de caminhos que usam quais dados dentro do contêiner podem ser particionados string[]

UniqueKeyPolicy

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

UniqueKey

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

Definição de recurso de modelo do ARM

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

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

Formato de recurso

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs",
  "apiVersion": "2015-04-01",
  "name": "string",
  "properties": {
    "options": {
      "{customized property}": "string"
    },
    "resource": {
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "string"
      },
      "defaultTtl": "int",
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string"
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ]
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  }
}

Valores de propriedade

databaseAccounts/apis/databases/graphs

Nome Descrição Valor
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs'
apiVersion A versão da API do recurso '2015-04-01'
name O nome do recurso

Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.
cadeia de caracteres (obrigatório)
properties Propriedades para criar e atualizar o grafo gremlin do Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp... (obrigatório)

GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp...

Nome Descrição Valor
opções Um par chave-valor de opções a serem aplicadas à solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. CreateUpdateOptions (obrigatório)
recurso O formato JSON padrão de um grafo gremlin GremlinGraphResource (obrigatório)

CreateUpdateOptions

Nome Descrição Valor
{propriedade personalizada} string

GremlinGraphResource

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 do 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 dentro do 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

Conflictresolutionpolicy

Nome Descrição Valor
conflictResolutionPath O caminho de resolução de conflitos no caso do modo LastWriterWins. string
conflictResolutionProcedure O procedimento para resolve conflitos no caso do modo personalizado. string
mode Indica o modo de resolução de conflitos. 'Custom'
'LastWriterWins'

IndexingPolicy

Nome Descrição Valor
automático Indica se a política de indexação é automática bool
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'

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/*) string

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/*) string

Índices

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

ContainerPartitionKey

Nome Descrição Valor
kind Indica o tipo de algoritmo usado para particionamento 'Hash'
'Range'
caminhos Lista de caminhos usando quais dados dentro do contêiner podem ser particionados string[]

UniqueKeyPolicy

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

UniqueKey

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

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

O tipo de recurso databaseAccounts/apis/databases/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 de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2015-04-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      options = {
        {customized property} = "string"
      }
      resource = {
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "string"
        }
        defaultTtl = int
        id = "string"
        indexingPolicy = {
          automatic = bool
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

Valores de propriedade

databaseAccounts/apis/databases/graphs

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2015-04-01"
name 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: bancos de dados
properties Propriedades para criar e atualizar o grafo gremlin do Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp... (obrigatório)

GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp...

Nome Descrição Valor
opções Um par chave-valor de opções 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 grafo do Gremlin GremlinGraphResource (obrigatório)

CreateUpdateOptions

Nome Descrição Valor
{propriedade personalizada} string

GremlinGraphResource

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 do 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

Conflictresolutionpolicy

Nome Descrição Valor
conflictResolutionPath O caminho de resolução de conflitos no caso do modo LastWriterWins. string
conflictResolutionProcedure O procedimento para resolve conflitos no caso do modo personalizado. string
mode Indica o modo de resolução de conflitos. “Personalizado”
"LastWriterWins"

IndexingPolicy

Nome Descrição Valor
automático Indica se a política de indexação é automática bool
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"
"Lento"
"None"

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/*) string

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/*) string

Índices

Nome Descrição Valor
dataType O tipo de dados ao qual o comportamento de indexação é aplicado. "LineString"
"MultiPolygon"
"Número"
"Ponto"
"Polígono"
"Cadeia de caracteres"
kind Indica o tipo de índice. "Hash"
"Intervalo"
"Espacial"
precisão A precisão do índice. -1 é precisão máxima. INT

ContainerPartitionKey

Nome Descrição Valor
kind Indica o tipo de algoritmo usado para particionamento "Hash"
"Intervalo"
caminhos Lista de caminhos que usam quais dados dentro do contêiner podem ser particionados string[]

UniqueKeyPolicy

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

UniqueKey

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