Base de dados Microsoft.DocumentDBContas/apis/bases de dados/contentores 2015-04-08

  • Artigo

Definição de recurso do Bicep

O tipo de recurso databaseAccounts/apis/databases/containers pode ser implementado com operações que visam:

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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@2015-04-08' = {
  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/containers

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados no Bicep.		 cadeia (obrigatório)
principal No Bicep, pode especificar o recurso principal de um recurso subordinado. Só tem de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal.

Para obter mais informações, veja Recurso subordinado fora do recurso principal.		 Nome simbólico para recurso do tipo: bases de dados
propriedades Propriedades para criar e atualizar o contentor do Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerProp... (obrigatório)

SqlContainerCreateUpdatePropertiesOrSqlContainerProp...

Nome Descrição Valor
opções Um par de opções chave-valor a aplicar ao pedido. Isto corresponde aos cabeçalhos enviados com o pedido. CreateUpdateOptions (obrigatório)
recurso O formato JSON padrão de um contentor SqlContainerResource (obrigatório)

CreateUpdateOptions

Nome Descrição Valor
{customized property} string

SqlContainerResource

Nome Descrição Valor
conflictResolutionPolicy A política de resolução de conflitos para o contentor. ConflictResolutionPolicy
defaultTtl Tempo de vida predefinido int
ID Nome do contentor SQL do Cosmos DB cadeia (obrigatório)
indexingPolicy A configuração da política de indexação. Por predefinição, a indexação é automática para todos os caminhos do documento no contentor IndexingPolicy
partitionKey A configuração da chave de partição a ser utilizada para a criação de partições de 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

ConflictResolutionPolicy

Nome 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
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 excluir da indexação ExcludedPath[]
includedPaths Lista de caminhos a incluir na indexação IncludedPath[]
indexingMode Indica o modo de indexação. "Consistente"
'Preguiçoso'
"Nenhum"

ExcludedPath

Nome Descrição Valor
caminho O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e fim com caráter universal (/path/*) string

IncludedPath

Nome Descrição Valor
índices Lista de índices para este caminho Índices[]
caminho O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e fim com caráter universal (/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'
tipo Indica o tipo de índice. 'Hash'
"Intervalo"
"Espacial"
precisão A precisão do índice. -1 é a precisão máxima. int

ContainerPartitionKey

Nome Descrição Valor
tipo Indica o tipo de algoritmo utilizado para a criação de partições 'Hash'
"Intervalo"
caminhos Lista de caminhos que utilizam os dados no contentor que podem ser particionados cadeia[]

UniqueKeyPolicy

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

UniqueKey

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

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Criar o Azure Cosmos com a API SQL e vários contentores

Implementar no Azure		 O modelo cria um contentor do Cosmos com uma API SQL e permite adicionar contentores mulitple.

Definição de recurso de modelo do ARM

O tipo de recurso databaseAccounts/apis/databases/containers pode ser implementado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo 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": "2015-04-08",
  "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/containers

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

Veja como definir nomes e tipos para recursos subordinados em modelos do ARM JSON.		 cadeia (obrigatório)
propriedades Propriedades para criar e atualizar o contentor do Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerProp... (obrigatório)

SqlContainerCreateUpdatePropertiesOrSqlContainerProp...

Nome Descrição Valor
opções Um par de opções chave-valor a aplicar para o pedido. Isto corresponde aos cabeçalhos enviados com o pedido. CreateUpdateOptions (obrigatório)
recurso O formato JSON padrão de um contentor SqlContainerResource (obrigatório)

CreateUpdateOptions

Nome Descrição Valor
{customized property} string

SqlContainerResource

Nome Descrição Valor
conflictResolutionPolicy A política de resolução de conflitos para o contentor. ConflictResolutionPolicy
defaultTtl Tempo de vida predefinido int
ID Nome do contentor SQL do Cosmos DB cadeia (obrigatório)
indexingPolicy A configuração da política de indexação. Por predefinição, a indexação é automática para todos os caminhos de documentos no contentor IndexingPolicy
partitionKey A configuração da chave de partição a utilizar para a criação de partições de dados em múltiplas 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

ConflictResolutionPolicy

Nome 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
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 excluir da indexação ExcludedPath[]
includedPaths Lista de caminhos a incluir na indexação IncludedPath[]
indexingMode Indica o modo de indexação. "Consistente"
'Preguiçoso'
"Nenhum"

ExcludedPath

Nome Descrição Valor
caminho O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e fim com caráter universal (/path/*) string

IncludedPath

Nome Descrição Valor
índices Lista de índices para este caminho Índices[]
caminho O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e fim com caráter universal (/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'
tipo Indica o tipo de índice. 'Hash'
"Intervalo"
"Espacial"
precisão A precisão do índice. -1 é a precisão máxima. int

ContainerPartitionKey

Nome Descrição Valor
tipo Indica o tipo de algoritmo utilizado para a criação de partições 'Hash'
"Intervalo"
caminhos Lista de caminhos que utilizam os dados no contentor que podem ser particionados cadeia[]

UniqueKeyPolicy

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

UniqueKey

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

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Criar o Azure Cosmos com a API SQL e vários contentores

Implementar no Azure		 O modelo cria um contentor do Cosmos com uma API SQL e permite adicionar contentores mulitple.

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

O tipo de recurso databaseAccounts/apis/databases/containers pode ser implementado com operações que visam:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo 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@2015-04-08"
  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/containers

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-04-08"
name O nome do recurso cadeia (obrigatório)
parent_id O ID do recurso que é o principal para este recurso. ID para recurso do tipo: bases de dados
propriedades Propriedades para criar e atualizar o contentor do Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerProp... (obrigatório)

SqlContainerCreateUpdatePropertiesOrSqlContainerProp...

Nome Descrição Valor
opções Um par de opções chave-valor a aplicar para o pedido. Isto corresponde aos cabeçalhos enviados com o pedido. CreateUpdateOptions (obrigatório)
recurso O formato JSON padrão de um contentor SqlContainerResource (obrigatório)

CreateUpdateOptions

Nome Descrição Valor
{customized property} string

SqlContainerResource

Nome Descrição Valor
conflictResolutionPolicy A política de resolução de conflitos para o contentor. ConflictResolutionPolicy
defaultTtl Tempo de vida predefinido int
ID Nome do contentor SQL do Cosmos DB cadeia (obrigatório)
indexingPolicy A configuração da política de indexação. Por predefinição, a indexação é automática para todos os caminhos do documento no contentor IndexingPolicy
partitionKey A configuração da chave de partição a ser utilizada para a criação de partições de 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

ConflictResolutionPolicy

Nome 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
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 excluir da indexação ExcludedPath[]
includedPaths Lista de caminhos a incluir na indexação IncludedPath[]
indexingMode Indica o modo de indexação. "Consistente"
"Preguiçoso"
"Nenhum"

ExcludedPath

Nome Descrição Valor
caminho O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e terminam com caráter universal (/path/*) string

IncludedPath

Nome Descrição Valor
índices Lista de índices para este caminho Índices[]
caminho O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e terminam com caráter universal (/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"
tipo Indica o tipo de índice. "Hash"
"Intervalo"
"Espacial"
precisão A precisão do índice. -1 é a precisão máxima. int

ContainerPartitionKey

Nome Descrição Valor
tipo Indica o tipo de algoritmo utilizado para a criação de partições "Hash"
"Intervalo"
caminhos Lista de caminhos com os quais os dados no contentor podem ser particionados string[]

UniqueKeyPolicy

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

UniqueKey

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