Compartilhar via

Banco de dados Microsoft.DocumentDBAccounts/sqlDatabases/containers

Definição de recurso do Bicep

O tipo de recurso databaseAccounts/sqlDatabases/containers pode ser implantado com operações de destino:

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/sqlDatabases/containers, adicione o Bicep a seguir ao seu modelo.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2025-11-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      clientEncryptionPolicy: {
        includedPaths: [
          {
            clientEncryptionKeyId: 'string'
            encryptionAlgorithm: 'string'
            encryptionType: 'string'
            path: 'string'
          }
        ]
        policyFormatVersion: int
      }
      computedProperties: [
        {
          name: 'string'
          query: 'string'
        }
      ]
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: 'string'
      }
      createMode: 'string'
      dataMaskingPolicy: {
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            length: int
            path: 'string'
            startPosition: int
            strategy: 'string'
          }
        ]
        isPolicyEnabled: bool
      }
      defaultTtl: int
      fullTextPolicy: {
        defaultLanguage: 'string'
        fullTextPaths: [
          {
            language: 'string'
            path: 'string'
          }
        ]
      }
      id: 'string'
      indexingPolicy: {
        automatic: bool
        compositeIndexes: [
          [
            {
              order: 'string'
              path: 'string'
            }
          ]
        ]
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        fullTextIndexes: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
        spatialIndexes: [
          {
            path: 'string'
            types: [
              'string'
            ]
          }
        ]
        vectorIndexes: [
          {
            indexingSearchListSize: int
            path: 'string'
            quantizationByteSize: int
            type: 'string'
            vectorIndexShardKey: [
              'string'
            ]
          }
        ]
      }
      materializedViewDefinition: {
        definition: 'string'
        sourceCollectionId: 'string'
        throughputBucketForBuild: int
      }
      materializedViews: [
        {
          id: 'string'
          _rid: 'string'
        }
      ]
      materializedViewsProperties: {
        throughputBucketForBuild: int
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
      vectorEmbeddingPolicy: {
        vectorEmbeddings: [
          {
            dataType: 'string'
            dimensions: int
            distanceFunction: 'string'
            path: 'string'
          }
        ]
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores da propriedade

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Nome Descrição Valor
identidade Identidade do recurso. ManagedServiceIdentity
local O local do grupo de recursos ao qual o recurso pertence. cadeia
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 o recurso do tipo: databaseAccounts/sqlDatabases
Propriedades Propriedades para criar e atualizar o contêiner do Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

Configurações de dimensionamento automático

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

ClientEncryptionIncludedPath

Nome Descrição Valor
clientEncryptionKeyId O identificador da Chave de Criptografia do Cliente a ser usado para criptografar o caminho. cadeia de caracteres (obrigatório)
algoritmo de criptografia O algoritmo de criptografia que será usado. Por exemplo, AEAD_AES_256_CBC_HMAC_SHA256. cadeia de caracteres (obrigatório)
tipo de criptografia O tipo de criptografia a ser executada. Por exemplo, determinística, aleatória. cadeia de caracteres (obrigatório)
caminho Caminho que precisa ser criptografado. cadeia de caracteres (obrigatório)

ClientEncryptionPolicy

Nome Descrição Valor
caminhos incluídos Caminhos do item que precisam de criptografia junto com as configurações específicas do caminho. ClientEncryptionIncludedPath[] (obrigatório)
policyFormatVersion Versão da definição da política de criptografia do cliente. As versões com suporte são 1 e 2. A versão 2 dá suporte à criptografia de caminho de chave de id e partição. int

Restrições:
Valor mínimo = 1
Valor máximo = 2 (obrigatório)

Componentes1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nome Descrição Valor

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

Propriedade computada

Nome Descrição Valor
nome O nome de uma propriedade computada, por exemplo: "cp_lowerName" cadeia
consulta A consulta que avalia o valor da propriedade computada, por exemplo : "SELECT VALUE LOWER(c.name) FROM c" cadeia

Política de Resolução de Conflitos

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

Chave de partição de contêiner

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 'Haxixe'
'MultiHash'
'Alcance'
Caminhos Lista de caminhos usando quais dados dentro do contêiner podem ser particionados cadeia de caracteres[]
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

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Nome Descrição Valor
configurações de dimensionamento automático Especifica as configurações de Dimensionamento Automático. Observação: a taxa de transferência ou o dimensionamento automáticoSettings são necessários, mas não ambos. autoscaleSettings
taxa de transferência Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. int

Política de Mascaramento de Dados

Nome Descrição Valor
Caminhos excluídos Lista de caminhos JSON a serem excluídos do mascaramento. DataMaskingPolicyExcludedPathsItem[]
caminhos incluídos Lista de caminhos JSON a serem incluídos na política de mascaramento. DataMaskingPolicyIncludedPathsItem[]
isPolicyEnabled Sinalizador que indica se a política de mascaramento de dados está habilitada. Bool

DataMaskingPolicyExcludedPathsItem

Nome Descrição Valor
caminho O caminho JSON a ser excluído do mascaramento (por exemplo, "/id"). cadeia de caracteres (obrigatório)

DataMaskingPolicyIncludedPathsItem

Nome Descrição Valor
length Comprimento da subcadeia de caracteres a ser mascarada (quando aplicável). int
caminho O caminho JSON para aplicar o mascaramento (por exemplo, "/contact/phones"). cadeia de caracteres (obrigatório)
posição inicial Posição inicial para mascaramento de substring (quando aplicável). int
strategy Estratégia de mascaramento a ser aplicada (por exemplo, "MaskSubstring"). cadeia

Caminho Excluído

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

FullTextIndexPath

Nome Descrição Valor
caminho O caminho para o campo de texto completo no documento. cadeia de caracteres (obrigatório)

Caminho de texto completo

Nome Descrição Valor
linguagem O idioma do campo de texto completo no documento. cadeia
caminho O caminho para o campo de texto completo no documento. cadeia de caracteres (obrigatório)

Política de Texto Completo

Nome Descrição Valor
defaultLanguage O idioma padrão para caminhos de texto completos. cadeia
Caminhos de texto completos Lista de caminhos fullText Caminho de texto completo

Caminho Incluído

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

Í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'
'Corda'
tipo Indica o tipo de índice. 'Haxixe'
'Alcance'
'Espacial'
precisão A precisão do índice. -1 é precisão máxima. int

Política de Indexação

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 [][]
Caminhos excluídos Lista de caminhos a serem excluídos da indexação ExcludedPath []
fullTextIndexes Lista de caminhos a serem incluídos na indexação de texto completo FullTextIndexPath[]
caminhos incluídos Lista de caminhos a serem incluídos na indexação IncludedPath []
modo de indexação Indica o modo de indexação. 'consistente'
'preguiçoso'
'nenhum'
spatialIndexes Lista de especificidades espaciais SpatialSpec []
vectorIndexes Lista de caminhos a serem incluídos na indexação de vetor VectorIndex []

ManagedServiceIdentity

Nome Descrição Valor
tipo O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço. 'Nenhum'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
Identidades Atribuídas pelo Usuário A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nome Descrição Valor

MaterializedViewDefinition

Nome Descrição Valor
definição A definição deve ser uma consulta SQL que seria usada para buscar dados do contêiner de origem para preencher no contêiner de Exibição Materializada. cadeia de caracteres (obrigatório)
código-fonteCollectionId O nome do contêiner de origem no qual a Exibição Materializada será criada. cadeia de caracteres (obrigatório)
throughputBucketForBuild Bucket de taxa de transferência atribuído para as operações de exibição materializadas no contêiner de destino. int

MaterializedViewDetails

Nome Descrição Valor
id Campo de ID do contêiner Materializado. cadeia
_livrar _rid campo de contêiner materializado. cadeia

MaterializedViewsProperties

Nome Descrição Valor
throughputBucketForBuild Bucket de taxa de transferência atribuído para as operações de exibição materializadas no contêiner de origem. int

Parâmetros de restauração de recursos

Nome Descrição Valor
fonte de restauração A ID da conta de banco de dados restaurável da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} cadeia
restoreTimestampInUtc Tempo para o qual a conta precisa ser restaurada (formato ISO-8601). cadeia
restoreWithTtlDisabled Especifica se a conta restaurada terá o TempoTo-Live desabilitado após a restauração bem-sucedida. Bool

Especificação espacial

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/*) cadeia
Tipos Lista do tipo espacial do caminho Matriz de cadeia de caracteres que contém qualquer um dos:
'LineString'
'MultiPolygon'
'Ponto'
'Polígono'

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

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. CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
recurso O formato JSON padrão de um contêiner sqlContainerResourceOrSqlContainerGetPropertiesResource (obrigatório)

SqlContainerResourceOrSqlContainerGetPropertiesResource

Nome Descrição Valor
analyticalStorageTtl TTL analítico. int
clientEncryptionPolicy A política de criptografia do cliente para o contêiner. ClientEncryptionPolicy
Propriedades computadas Lista de propriedades computadas ComputedProperty []
conflictResolutionPolicy A política de resolução de conflitos para o contêiner. ConflictResolutionPolicy
Modo de criação Enumerar para indicar o modo de criação de recursos. 'Padrão'
'Restaurar'
política de mascaramento de dados A política de Mascaramento de Dados para o contêiner. Política de Mascaramento de Dados
defaultTtl Tempo de vida padrão int
Política de texto completo A política FullText para o contêiner. Política de Texto Completo
id Nome do contêiner do SQL do Cosmos DB cadeia de caracteres (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 documento dentro do contêiner indexingPolicy
materializedViewDefinição A configuração para definir exibições materializadas. Isso deve ser especificado apenas para a criação de um contêiner de Exibição Materializada. MaterializedViewDefinition
materializedViews Exibições materializadas definidas no contêiner. MaterializedViewDetails
materializedViewsProperties Exibições Materializadas Propriedades definidas para o contêiner de origem. MaterializedViewsProperties
partitionKey A configuração da chave de partição a ser usada para particionar dados em várias partições ContainerPartitionKey
restoreParameters Parâmetros para indicar as informações sobre a restauração ResourceRestoreParameters
Política de chave única 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
vectorEmbeddingPolicy A política de inserção de vetor para o contêiner. VectorEmbeddingPolicy

Etiquetas

Nome Descrição Valor

Chave Única

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

Política de chave única

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

Incorporação de vetores

Nome Descrição Valor
Datatype Indica o tipo de dados do vetor. 'flutuar 16'
'flutuar 32'
'int8'
'uint8' (obrigatório)
Dimensões O número de dimensões no vetor. int (obrigatório)
função distância A função de distância a ser usada para cálculo de distância entre vetores. 'cosseno'
'PontoProduto'
'euclidean' (obrigatório)
caminho O caminho para o campo de vetor no documento. cadeia de caracteres (obrigatório)

Política de incorporação de vetores

Nome Descrição Valor
vectorEmbeddings Lista de inserções de vetor VectorEmbedding []

Índice de vetores

Nome Descrição Valor
indexaçãoSearchListSize Esse é o tamanho da lista de candidatos de vizinhos aproximados armazenados durante a criação do índice DiskANN como parte dos processos de otimização. Valores grandes podem melhorar a lembrança em detrimento da latência. Isso só é aplicável ao tipo de índice de vetor diskANN. int

Restrições:
Valor mínimo = 25
Valor máximo = 500
caminho O caminho para o campo de vetor no documento. cadeia de caracteres (obrigatório)
quantizaçãoByteSize O número de bytes usados na quantização do produto dos vetores. Um valor maior pode resultar em melhor recuperação para pesquisas vetoriais em detrimento da latência. Isso só é aplicável para os tipos de índice de vetor quantizedFlat e diskANN. int

Restrições:
Valor mínimo = 4
tipo O tipo de índice do vetor. Atualmente, há suporte para flat, diskANN e quantizedFlat. 'diskANN'
'plano'
'quantizedFlat' (obrigatório)
vectorIndexShardKey Matriz de chaves de fragmento para o índice vetorial. Isso só é aplicável para os tipos de índice de vetor quantizedFlat e diskANN. cadeia de caracteres[]

Exemplos de uso

Exemplos de Início Rápido do Azure

Os modelos de Início Rápido do Azure a seguir contêm exemplos de Bicep para implantar esse tipo de recurso.

Arquivo Bicep Descrição
API do SQL da conta do Azure Cosmos DB com o repositório analítico Esse modelo cria uma conta do Azure Cosmos para a API do Core (SQL) com um banco de dados e um contêiner configurados com o repositório analítico.
Criar uma conta do Azure Cosmos DB de camada gratuita Esse modelo cria uma conta do Azure Cosmos DB de camada livre para a API do SQL com um banco de dados com taxa de transferência e contêiner compartilhados.
Criar uma conta do Azure Cosmos DB para a API do Core (SQL) Esse modelo cria uma conta do Azure Cosmos para a API do Core (SQL) com um banco de dados e um contêiner com taxa de transferência com várias outras opções.
Criar uma API SQL de conta do Azure Cosmos DB com de dimensionamento automático Esse modelo cria uma conta do Azure Cosmos para a API do Core (SQL) com um banco de dados e um contêiner com taxa de transferência de dimensionamento automático com várias outras opções.
Criar procedimentos armazenados da API do SQL (Azure Cosmos DB Core) Esse modelo cria uma conta do Azure Cosmos DB para a API do Core (SQL) e um contêiner com um procedimento armazenado, gatilho e função definida pelo usuário.
cria um aplicativo de microsserviços da Dapr usando aplicativos de contêiner Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner.
Cria um aplicativo dapr pub-sub servicebus usando aplicativos de contêiner Crie um aplicativo dapr pub-sub servicebus usando Aplicativos de Contêiner.
implantar o BD do Azure Data Explorer com a conexão do Cosmos DB Implantar o BD do Azure Data Explorer com a conexão do Cosmos DB.

Definição de recurso de modelo do ARM

O tipo de recurso databaseAccounts/sqlDatabases/containers pode ser implantado com operações de destino:

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/sqlDatabases/containers, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
  "apiVersion": "2025-11-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "clientEncryptionPolicy": {
        "includedPaths": [
          {
            "clientEncryptionKeyId": "string",
            "encryptionAlgorithm": "string",
            "encryptionType": "string",
            "path": "string"
          }
        ],
        "policyFormatVersion": "int"
      },
      "computedProperties": [
        {
          "name": "string",
          "query": "string"
        }
      ],
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "string"
      },
      "createMode": "string",
      "dataMaskingPolicy": {
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "length": "int",
            "path": "string",
            "startPosition": "int",
            "strategy": "string"
          }
        ],
        "isPolicyEnabled": "bool"
      },
      "defaultTtl": "int",
      "fullTextPolicy": {
        "defaultLanguage": "string",
        "fullTextPaths": [
          {
            "language": "string",
            "path": "string"
          }
        ]
      },
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "compositeIndexes": [
          [
            {
              "order": "string",
              "path": "string"
            }
          ]
        ],
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "fullTextIndexes": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string",
        "spatialIndexes": [
          {
            "path": "string",
            "types": [ "string" ]
          }
        ],
        "vectorIndexes": [
          {
            "indexingSearchListSize": "int",
            "path": "string",
            "quantizationByteSize": "int",
            "type": "string",
            "vectorIndexShardKey": [ "string" ]
          }
        ]
      },
      "materializedViewDefinition": {
        "definition": "string",
        "sourceCollectionId": "string",
        "throughputBucketForBuild": "int"
      },
      "materializedViews": [
        {
          "id": "string",
          "_rid": "string"
        }
      ],
      "materializedViewsProperties": {
        "throughputBucketForBuild": "int"
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      },
      "vectorEmbeddingPolicy": {
        "vectorEmbeddings": [
          {
            "dataType": "string",
            "dimensions": "int",
            "distanceFunction": "string",
            "path": "string"
          }
        ]
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores da propriedade

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Nome Descrição Valor
apiVersion A versão da API '2025-11-01-preview'
identidade Identidade do recurso. ManagedServiceIdentity
local O local do grupo de recursos ao qual o recurso pertence. cadeia
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades para criar e atualizar o contêiner do Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (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/sqlDatabases/containers'

Configurações de dimensionamento automático

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

ClientEncryptionIncludedPath

Nome Descrição Valor
clientEncryptionKeyId O identificador da Chave de Criptografia do Cliente a ser usado para criptografar o caminho. cadeia de caracteres (obrigatório)
algoritmo de criptografia O algoritmo de criptografia que será usado. Por exemplo, AEAD_AES_256_CBC_HMAC_SHA256. cadeia de caracteres (obrigatório)
tipo de criptografia O tipo de criptografia a ser executada. Por exemplo, determinística, aleatória. cadeia de caracteres (obrigatório)
caminho Caminho que precisa ser criptografado. cadeia de caracteres (obrigatório)

ClientEncryptionPolicy

Nome Descrição Valor
caminhos incluídos Caminhos do item que precisam de criptografia junto com as configurações específicas do caminho. ClientEncryptionIncludedPath[] (obrigatório)
policyFormatVersion Versão da definição da política de criptografia do cliente. As versões com suporte são 1 e 2. A versão 2 dá suporte à criptografia de caminho de chave de id e partição. int

Restrições:
Valor mínimo = 1
Valor máximo = 2 (obrigatório)

Componentes1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nome Descrição Valor

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

Propriedade computada

Nome Descrição Valor
nome O nome de uma propriedade computada, por exemplo: "cp_lowerName" cadeia
consulta A consulta que avalia o valor da propriedade computada, por exemplo : "SELECT VALUE LOWER(c.name) FROM c" cadeia

Política de Resolução de Conflitos

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

Chave de partição de contêiner

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 'Haxixe'
'MultiHash'
'Alcance'
Caminhos Lista de caminhos usando quais dados dentro do contêiner podem ser particionados cadeia de caracteres[]
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

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Nome Descrição Valor
configurações de dimensionamento automático Especifica as configurações de Dimensionamento Automático. Observação: a taxa de transferência ou o dimensionamento automáticoSettings são necessários, mas não ambos. autoscaleSettings
taxa de transferência Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. int

Política de Mascaramento de Dados

Nome Descrição Valor
Caminhos excluídos Lista de caminhos JSON a serem excluídos do mascaramento. DataMaskingPolicyExcludedPathsItem[]
caminhos incluídos Lista de caminhos JSON a serem incluídos na política de mascaramento. DataMaskingPolicyIncludedPathsItem[]
isPolicyEnabled Sinalizador que indica se a política de mascaramento de dados está habilitada. Bool

DataMaskingPolicyExcludedPathsItem

Nome Descrição Valor
caminho O caminho JSON a ser excluído do mascaramento (por exemplo, "/id"). cadeia de caracteres (obrigatório)

DataMaskingPolicyIncludedPathsItem

Nome Descrição Valor
length Comprimento da subcadeia de caracteres a ser mascarada (quando aplicável). int
caminho O caminho JSON para aplicar o mascaramento (por exemplo, "/contact/phones"). cadeia de caracteres (obrigatório)
posição inicial Posição inicial para mascaramento de substring (quando aplicável). int
strategy Estratégia de mascaramento a ser aplicada (por exemplo, "MaskSubstring"). cadeia

Caminho Excluído

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

FullTextIndexPath

Nome Descrição Valor
caminho O caminho para o campo de texto completo no documento. cadeia de caracteres (obrigatório)

Caminho de texto completo

Nome Descrição Valor
linguagem O idioma do campo de texto completo no documento. cadeia
caminho O caminho para o campo de texto completo no documento. cadeia de caracteres (obrigatório)

Política de Texto Completo

Nome Descrição Valor
defaultLanguage O idioma padrão para caminhos de texto completos. cadeia
Caminhos de texto completos Lista de caminhos fullText Caminho de texto completo

Caminho Incluído

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

Í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'
'Corda'
tipo Indica o tipo de índice. 'Haxixe'
'Alcance'
'Espacial'
precisão A precisão do índice. -1 é precisão máxima. int

Política de Indexação

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 [][]
Caminhos excluídos Lista de caminhos a serem excluídos da indexação ExcludedPath []
fullTextIndexes Lista de caminhos a serem incluídos na indexação de texto completo FullTextIndexPath[]
caminhos incluídos Lista de caminhos a serem incluídos na indexação IncludedPath []
modo de indexação Indica o modo de indexação. 'consistente'
'preguiçoso'
'nenhum'
spatialIndexes Lista de especificidades espaciais SpatialSpec []
vectorIndexes Lista de caminhos a serem incluídos na indexação de vetor VectorIndex []

ManagedServiceIdentity

Nome Descrição Valor
tipo O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço. 'Nenhum'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
Identidades Atribuídas pelo Usuário A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nome Descrição Valor

MaterializedViewDefinition

Nome Descrição Valor
definição A definição deve ser uma consulta SQL que seria usada para buscar dados do contêiner de origem para preencher no contêiner de Exibição Materializada. cadeia de caracteres (obrigatório)
código-fonteCollectionId O nome do contêiner de origem no qual a Exibição Materializada será criada. cadeia de caracteres (obrigatório)
throughputBucketForBuild Bucket de taxa de transferência atribuído para as operações de exibição materializadas no contêiner de destino. int

MaterializedViewDetails

Nome Descrição Valor
id Campo de ID do contêiner Materializado. cadeia
_livrar _rid campo de contêiner materializado. cadeia

MaterializedViewsProperties

Nome Descrição Valor
throughputBucketForBuild Bucket de taxa de transferência atribuído para as operações de exibição materializadas no contêiner de origem. int

Parâmetros de restauração de recursos

Nome Descrição Valor
fonte de restauração A ID da conta de banco de dados restaurável da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} cadeia
restoreTimestampInUtc Tempo para o qual a conta precisa ser restaurada (formato ISO-8601). cadeia
restoreWithTtlDisabled Especifica se a conta restaurada terá o TempoTo-Live desabilitado após a restauração bem-sucedida. Bool

Especificação espacial

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/*) cadeia
Tipos Lista do tipo espacial do caminho Matriz de cadeia de caracteres que contém qualquer um dos:
'LineString'
'MultiPolygon'
'Ponto'
'Polígono'

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

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. CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
recurso O formato JSON padrão de um contêiner sqlContainerResourceOrSqlContainerGetPropertiesResource (obrigatório)

SqlContainerResourceOrSqlContainerGetPropertiesResource

Nome Descrição Valor
analyticalStorageTtl TTL analítico. int
clientEncryptionPolicy A política de criptografia do cliente para o contêiner. ClientEncryptionPolicy
Propriedades computadas Lista de propriedades computadas ComputedProperty []
conflictResolutionPolicy A política de resolução de conflitos para o contêiner. ConflictResolutionPolicy
Modo de criação Enumerar para indicar o modo de criação de recursos. 'Padrão'
'Restaurar'
política de mascaramento de dados A política de Mascaramento de Dados para o contêiner. Política de Mascaramento de Dados
defaultTtl Tempo de vida padrão int
Política de texto completo A política FullText para o contêiner. Política de Texto Completo
id Nome do contêiner do SQL do Cosmos DB cadeia de caracteres (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 documento dentro do contêiner indexingPolicy
materializedViewDefinição A configuração para definir exibições materializadas. Isso deve ser especificado apenas para a criação de um contêiner de Exibição Materializada. MaterializedViewDefinition
materializedViews Exibições materializadas definidas no contêiner. MaterializedViewDetails
materializedViewsProperties Exibições Materializadas Propriedades definidas para o contêiner de origem. MaterializedViewsProperties
partitionKey A configuração da chave de partição a ser usada para particionar dados em várias partições ContainerPartitionKey
restoreParameters Parâmetros para indicar as informações sobre a restauração ResourceRestoreParameters
Política de chave única 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
vectorEmbeddingPolicy A política de inserção de vetor para o contêiner. VectorEmbeddingPolicy

Etiquetas

Nome Descrição Valor

Chave Única

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

Política de chave única

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

Incorporação de vetores

Nome Descrição Valor
Datatype Indica o tipo de dados do vetor. 'flutuar 16'
'flutuar 32'
'int8'
'uint8' (obrigatório)
Dimensões O número de dimensões no vetor. int (obrigatório)
função distância A função de distância a ser usada para cálculo de distância entre vetores. 'cosseno'
'PontoProduto'
'euclidean' (obrigatório)
caminho O caminho para o campo de vetor no documento. cadeia de caracteres (obrigatório)

Política de incorporação de vetores

Nome Descrição Valor
vectorEmbeddings Lista de inserções de vetor VectorEmbedding []

Índice de vetores

Nome Descrição Valor
indexaçãoSearchListSize Esse é o tamanho da lista de candidatos de vizinhos aproximados armazenados durante a criação do índice DiskANN como parte dos processos de otimização. Valores grandes podem melhorar a lembrança em detrimento da latência. Isso só é aplicável ao tipo de índice de vetor diskANN. int

Restrições:
Valor mínimo = 25
Valor máximo = 500
caminho O caminho para o campo de vetor no documento. cadeia de caracteres (obrigatório)
quantizaçãoByteSize O número de bytes usados na quantização do produto dos vetores. Um valor maior pode resultar em melhor recuperação para pesquisas vetoriais em detrimento da latência. Isso só é aplicável para os tipos de índice de vetor quantizedFlat e diskANN. int

Restrições:
Valor mínimo = 4
tipo O tipo de índice do vetor. Atualmente, há suporte para flat, diskANN e quantizedFlat. 'diskANN'
'plano'
'quantizedFlat' (obrigatório)
vectorIndexShardKey Matriz de chaves de fragmento para o índice vetorial. Isso só é aplicável para os tipos de índice de vetor quantizedFlat e diskANN. cadeia de caracteres[]

Exemplos de uso

Modelos de início rápido do Azure

Os modelos de Início Rápido do Azure a seguir implantar esse tipo de recurso.

Modelo Descrição
API do SQL da conta do Azure Cosmos DB com o repositório analítico

Implantar no Azure 		Esse modelo cria uma conta do Azure Cosmos para a API do Core (SQL) com um banco de dados e um contêiner configurados com o repositório analítico.
Criar uma conta do Azure Cosmos DB de camada gratuita

Implantar no Azure 		Esse modelo cria uma conta do Azure Cosmos DB de camada livre para a API do SQL com um banco de dados com taxa de transferência e contêiner compartilhados.
Criar uma conta do Azure Cosmos DB para a API do Core (SQL)

Implantar no Azure 		Esse modelo cria uma conta do Azure Cosmos para a API do Core (SQL) com um banco de dados e um contêiner com taxa de transferência com várias outras opções.
Criar uma API SQL de conta do Azure Cosmos DB com de dimensionamento automático

Implantar no Azure 		Esse modelo cria uma conta do Azure Cosmos para a API do Core (SQL) com um banco de dados e um contêiner com taxa de transferência de dimensionamento automático com várias outras opções.
Criar procedimentos armazenados da API do SQL (Azure Cosmos DB Core)

Implantar no Azure 		Esse modelo cria uma conta do Azure Cosmos DB para a API do Core (SQL) e um contêiner com um procedimento armazenado, gatilho e função definida pelo usuário.
cria um aplicativo de microsserviços da Dapr usando aplicativos de contêiner

Implantar no Azure 		Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner.
Cria um aplicativo dapr pub-sub servicebus usando aplicativos de contêiner

Implantar no Azure 		Crie um aplicativo dapr pub-sub servicebus usando Aplicativos de Contêiner.
implantar o BD do Azure Data Explorer com a conexão do Cosmos DB

Implantar no Azure 		Implantar o BD do Azure Data Explorer com a conexão do Cosmos DB.

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

O tipo de recurso databaseAccounts/sqlDatabases/containers pode ser implantado com operações de destino:

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/sqlDatabases/containers, adicione o Terraform a seguir ao modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2025-11-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        clientEncryptionPolicy = {
          includedPaths = [
            {
              clientEncryptionKeyId = "string"
              encryptionAlgorithm = "string"
              encryptionType = "string"
              path = "string"
            }
          ]
          policyFormatVersion = int
        }
        computedProperties = [
          {
            name = "string"
            query = "string"
          }
        ]
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "string"
        }
        createMode = "string"
        dataMaskingPolicy = {
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              length = int
              path = "string"
              startPosition = int
              strategy = "string"
            }
          ]
          isPolicyEnabled = bool
        }
        defaultTtl = int
        fullTextPolicy = {
          defaultLanguage = "string"
          fullTextPaths = [
            {
              language = "string"
              path = "string"
            }
          ]
        }
        id = "string"
        indexingPolicy = {
          automatic = bool
          compositeIndexes = [
            [
              {
                order = "string"
                path = "string"
              }
            ]
          ]
          excludedPaths = [
            {
              path = "string"
            }
          ]
          fullTextIndexes = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
          spatialIndexes = [
            {
              path = "string"
              types = [
                "string"
              ]
            }
          ]
          vectorIndexes = [
            {
              indexingSearchListSize = int
              path = "string"
              quantizationByteSize = int
              type = "string"
              vectorIndexShardKey = [
                "string"
              ]
            }
          ]
        }
        materializedViewDefinition = {
          definition = "string"
          sourceCollectionId = "string"
          throughputBucketForBuild = int
        }
        materializedViews = [
          {
            id = "string"
            _rid = "string"
          }
        ]
        materializedViewsProperties = {
          throughputBucketForBuild = int
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
        vectorEmbeddingPolicy = {
          vectorEmbeddings = [
            {
              dataType = "string"
              dimensions = int
              distanceFunction = "string"
              path = "string"
            }
          ]
        }
      }
    }
  }
}

Valores da propriedade

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Nome Descrição Valor
identidade Identidade do recurso. ManagedServiceIdentity
local O local do grupo de recursos ao qual o recurso pertence. cadeia
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/sqlDatabases
Propriedades Propriedades para criar e atualizar o contêiner do Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2025-11-01-preview"

Configurações de dimensionamento automático

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

ClientEncryptionIncludedPath

Nome Descrição Valor
clientEncryptionKeyId O identificador da Chave de Criptografia do Cliente a ser usado para criptografar o caminho. cadeia de caracteres (obrigatório)
algoritmo de criptografia O algoritmo de criptografia que será usado. Por exemplo, AEAD_AES_256_CBC_HMAC_SHA256. cadeia de caracteres (obrigatório)
tipo de criptografia O tipo de criptografia a ser executada. Por exemplo, determinística, aleatória. cadeia de caracteres (obrigatório)
caminho Caminho que precisa ser criptografado. cadeia de caracteres (obrigatório)

ClientEncryptionPolicy

Nome Descrição Valor
caminhos incluídos Caminhos do item que precisam de criptografia junto com as configurações específicas do caminho. ClientEncryptionIncludedPath[] (obrigatório)
policyFormatVersion Versão da definição da política de criptografia do cliente. As versões com suporte são 1 e 2. A versão 2 dá suporte à criptografia de caminho de chave de id e partição. int

Restrições:
Valor mínimo = 1
Valor máximo = 2 (obrigatório)

Componentes1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nome Descrição Valor

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

Propriedade computada

Nome Descrição Valor
nome O nome de uma propriedade computada, por exemplo: "cp_lowerName" cadeia
consulta A consulta que avalia o valor da propriedade computada, por exemplo : "SELECT VALUE LOWER(c.name) FROM c" cadeia

Política de Resolução de Conflitos

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

Chave de partição de contêiner

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 'Haxixe'
'MultiHash'
'Alcance'
Caminhos Lista de caminhos usando quais dados dentro do contêiner podem ser particionados cadeia de caracteres[]
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

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Nome Descrição Valor
configurações de dimensionamento automático Especifica as configurações de Dimensionamento Automático. Observação: a taxa de transferência ou o dimensionamento automáticoSettings são necessários, mas não ambos. autoscaleSettings
taxa de transferência Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. int

Política de Mascaramento de Dados

Nome Descrição Valor
Caminhos excluídos Lista de caminhos JSON a serem excluídos do mascaramento. DataMaskingPolicyExcludedPathsItem[]
caminhos incluídos Lista de caminhos JSON a serem incluídos na política de mascaramento. DataMaskingPolicyIncludedPathsItem[]
isPolicyEnabled Sinalizador que indica se a política de mascaramento de dados está habilitada. Bool

DataMaskingPolicyExcludedPathsItem

Nome Descrição Valor
caminho O caminho JSON a ser excluído do mascaramento (por exemplo, "/id"). cadeia de caracteres (obrigatório)

DataMaskingPolicyIncludedPathsItem

Nome Descrição Valor
length Comprimento da subcadeia de caracteres a ser mascarada (quando aplicável). int
caminho O caminho JSON para aplicar o mascaramento (por exemplo, "/contact/phones"). cadeia de caracteres (obrigatório)
posição inicial Posição inicial para mascaramento de substring (quando aplicável). int
strategy Estratégia de mascaramento a ser aplicada (por exemplo, "MaskSubstring"). cadeia

Caminho Excluído

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

FullTextIndexPath

Nome Descrição Valor
caminho O caminho para o campo de texto completo no documento. cadeia de caracteres (obrigatório)

Caminho de texto completo

Nome Descrição Valor
linguagem O idioma do campo de texto completo no documento. cadeia
caminho O caminho para o campo de texto completo no documento. cadeia de caracteres (obrigatório)

Política de Texto Completo

Nome Descrição Valor
defaultLanguage O idioma padrão para caminhos de texto completos. cadeia
Caminhos de texto completos Lista de caminhos fullText Caminho de texto completo

Caminho Incluído

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

Í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'
'Corda'
tipo Indica o tipo de índice. 'Haxixe'
'Alcance'
'Espacial'
precisão A precisão do índice. -1 é precisão máxima. int

Política de Indexação

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 [][]
Caminhos excluídos Lista de caminhos a serem excluídos da indexação ExcludedPath []
fullTextIndexes Lista de caminhos a serem incluídos na indexação de texto completo FullTextIndexPath[]
caminhos incluídos Lista de caminhos a serem incluídos na indexação IncludedPath []
modo de indexação Indica o modo de indexação. 'consistente'
'preguiçoso'
'nenhum'
spatialIndexes Lista de especificidades espaciais SpatialSpec []
vectorIndexes Lista de caminhos a serem incluídos na indexação de vetor VectorIndex []

ManagedServiceIdentity

Nome Descrição Valor
tipo O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço. 'Nenhum'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
Identidades Atribuídas pelo Usuário A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nome Descrição Valor

MaterializedViewDefinition

Nome Descrição Valor
definição A definição deve ser uma consulta SQL que seria usada para buscar dados do contêiner de origem para preencher no contêiner de Exibição Materializada. cadeia de caracteres (obrigatório)
código-fonteCollectionId O nome do contêiner de origem no qual a Exibição Materializada será criada. cadeia de caracteres (obrigatório)
throughputBucketForBuild Bucket de taxa de transferência atribuído para as operações de exibição materializadas no contêiner de destino. int

MaterializedViewDetails

Nome Descrição Valor
id Campo de ID do contêiner Materializado. cadeia
_livrar _rid campo de contêiner materializado. cadeia

MaterializedViewsProperties

Nome Descrição Valor
throughputBucketForBuild Bucket de taxa de transferência atribuído para as operações de exibição materializadas no contêiner de origem. int

Parâmetros de restauração de recursos

Nome Descrição Valor
fonte de restauração A ID da conta de banco de dados restaurável da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} cadeia
restoreTimestampInUtc Tempo para o qual a conta precisa ser restaurada (formato ISO-8601). cadeia
restoreWithTtlDisabled Especifica se a conta restaurada terá o TempoTo-Live desabilitado após a restauração bem-sucedida. Bool

Especificação espacial

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/*) cadeia
Tipos Lista do tipo espacial do caminho Matriz de cadeia de caracteres que contém qualquer um dos:
'LineString'
'MultiPolygon'
'Ponto'
'Polígono'

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

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. CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
recurso O formato JSON padrão de um contêiner sqlContainerResourceOrSqlContainerGetPropertiesResource (obrigatório)

SqlContainerResourceOrSqlContainerGetPropertiesResource

Nome Descrição Valor
analyticalStorageTtl TTL analítico. int
clientEncryptionPolicy A política de criptografia do cliente para o contêiner. ClientEncryptionPolicy
Propriedades computadas Lista de propriedades computadas ComputedProperty []
conflictResolutionPolicy A política de resolução de conflitos para o contêiner. ConflictResolutionPolicy
Modo de criação Enumerar para indicar o modo de criação de recursos. 'Padrão'
'Restaurar'
política de mascaramento de dados A política de Mascaramento de Dados para o contêiner. Política de Mascaramento de Dados
defaultTtl Tempo de vida padrão int
Política de texto completo A política FullText para o contêiner. Política de Texto Completo
id Nome do contêiner do SQL do Cosmos DB cadeia de caracteres (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 documento dentro do contêiner indexingPolicy
materializedViewDefinição A configuração para definir exibições materializadas. Isso deve ser especificado apenas para a criação de um contêiner de Exibição Materializada. MaterializedViewDefinition
materializedViews Exibições materializadas definidas no contêiner. MaterializedViewDetails
materializedViewsProperties Exibições Materializadas Propriedades definidas para o contêiner de origem. MaterializedViewsProperties
partitionKey A configuração da chave de partição a ser usada para particionar dados em várias partições ContainerPartitionKey
restoreParameters Parâmetros para indicar as informações sobre a restauração ResourceRestoreParameters
Política de chave única 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
vectorEmbeddingPolicy A política de inserção de vetor para o contêiner. VectorEmbeddingPolicy

Etiquetas

Nome Descrição Valor

Chave Única

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

Política de chave única

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

Incorporação de vetores

Nome Descrição Valor
Datatype Indica o tipo de dados do vetor. 'flutuar 16'
'flutuar 32'
'int8'
'uint8' (obrigatório)
Dimensões O número de dimensões no vetor. int (obrigatório)
função distância A função de distância a ser usada para cálculo de distância entre vetores. 'cosseno'
'PontoProduto'
'euclidean' (obrigatório)
caminho O caminho para o campo de vetor no documento. cadeia de caracteres (obrigatório)

Política de incorporação de vetores

Nome Descrição Valor
vectorEmbeddings Lista de inserções de vetor VectorEmbedding []

Índice de vetores

Nome Descrição Valor
indexaçãoSearchListSize Esse é o tamanho da lista de candidatos de vizinhos aproximados armazenados durante a criação do índice DiskANN como parte dos processos de otimização. Valores grandes podem melhorar a lembrança em detrimento da latência. Isso só é aplicável ao tipo de índice de vetor diskANN. int

Restrições:
Valor mínimo = 25
Valor máximo = 500
caminho O caminho para o campo de vetor no documento. cadeia de caracteres (obrigatório)
quantizaçãoByteSize O número de bytes usados na quantização do produto dos vetores. Um valor maior pode resultar em melhor recuperação para pesquisas vetoriais em detrimento da latência. Isso só é aplicável para os tipos de índice de vetor quantizedFlat e diskANN. int

Restrições:
Valor mínimo = 4
tipo O tipo de índice do vetor. Atualmente, há suporte para flat, diskANN e quantizedFlat. 'diskANN'
'plano'
'quantizedFlat' (obrigatório)
vectorIndexShardKey Matriz de chaves de fragmento para o índice vetorial. Isso só é aplicável para os tipos de índice de vetor quantizedFlat e diskANN. cadeia de caracteres[]

Exemplos de uso

Exemplos do Terraform

Um exemplo básico de implantação do Contêiner SQL em uma conta do Cosmos DB.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "databaseAccount" {
  type      = "Microsoft.DocumentDB/databaseAccounts@2021-10-15"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "GlobalDocumentDB"
    properties = {
      capabilities = [
      ]
      consistencyPolicy = {
        defaultConsistencyLevel = "BoundedStaleness"
        maxIntervalInSeconds    = 10
        maxStalenessPrefix      = 200
      }
      databaseAccountOfferType           = "Standard"
      defaultIdentity                    = "FirstPartyIdentity"
      disableKeyBasedMetadataWriteAccess = false
      disableLocalAuth                   = false
      enableAnalyticalStorage            = false
      enableAutomaticFailover            = false
      enableFreeTier                     = false
      enableMultipleWriteLocations       = false
      ipRules = [
      ]
      isVirtualNetworkFilterEnabled = false
      locations = [
        {
          failoverPriority = 0
          isZoneRedundant  = false
          locationName     = "West Europe"
        },
      ]
      networkAclBypass = "None"
      networkAclBypassResourceIds = [
      ]
      publicNetworkAccess = "Enabled"
      virtualNetworkRules = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "sqlDatabase" {
  type      = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-10-15"
  parent_id = azapi_resource.databaseAccount.id
  name      = var.resource_name
  body = {
    properties = {
      options = {
        throughput = 400
      }
      resource = {
        id = var.resource_name
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "container" {
  type      = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-04-15"
  parent_id = azapi_resource.sqlDatabase.id
  name      = var.resource_name
  body = {
    properties = {
      options = {
      }
      resource = {
        id = "test-containerWest Europe"
        partitionKey = {
          kind = "Hash"
          paths = [
            "/definition",
          ]
        }
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on