Partilhar via


Banco de dados Microsoft.DocumentDBContas/apis/bancos de dados/contêineres 2016-03-31

Definição de recursos do bíceps

O tipo de recurso databaseAccounts/apis/databases/containers 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/apis/databases/containers, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-31' = {
  parent: resourceSymbolicName
  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

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[]

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

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

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

Designação Descrição Valor
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/apis/databases
propriedades Propriedades para criar e atualizar o contêiner do Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (obrigatório)

SqlContainerCreateUpdatePropertiesOrSqlContainerProperties

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 contêiner SqlContainerResource (obrigatório)

SqlContainerResource

Designação Descrição Valor
resolução de conflitosPolítica A política de resolução de conflitos para o contêiner. ConflictResolutionPolicy
padrãoTtl Tempo de vida padrão Int
ID Nome do contêiner SQL do Cosmos DB 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 contêiner 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

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 []

Definição de recurso de modelo ARM

O tipo de recurso databaseAccounts/apis/databases/containers 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/apis/databases/containers, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers",
  "apiVersion": "2016-03-31",
  "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

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[]

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

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

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

Designação Descrição Valor
apiVersion A versão api '2016-03-31'
Designação O nome do recurso string (obrigatório)
propriedades Propriedades para criar e atualizar o contêiner do Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (obrigatório)
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/apis/databases/containers'

SqlContainerCreateUpdatePropertiesOrSqlContainerProperties

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 contêiner SqlContainerResource (obrigatório)

SqlContainerResource

Designação Descrição Valor
resolução de conflitosPolítica A política de resolução de conflitos para o contêiner. ConflictResolutionPolicy
padrãoTtl Tempo de vida padrão Int
ID Nome do contêiner SQL do Cosmos DB 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 contêiner 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

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 o Azure Cosmos com a API SQL e vários contêineres

Implantar no Azure
O modelo cria um contêiner Cosmos com uma API SQL e permite adicionar vários contêineres.

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso databaseAccounts/apis/databases/containers 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/apis/databases/containers, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-31"
  name = "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

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[]

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

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

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

Designação Descrição Valor
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/apis/databases
propriedades Propriedades para criar e atualizar o contêiner do Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (obrigatório)
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-31"

SqlContainerCreateUpdatePropertiesOrSqlContainerProperties

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 contêiner SqlContainerResource (obrigatório)

SqlContainerResource

Designação Descrição Valor
resolução de conflitosPolítica A política de resolução de conflitos para o contêiner. ConflictResolutionPolicy
padrãoTtl Tempo de vida padrão Int
ID Nome do contêiner SQL do Cosmos DB 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 contêiner 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

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 []