Compartilhar via

Banco de dados Microsoft.DocumentDBAccounts/sqlDatabases/containers 2024-11-15

  • Artigo

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@2024-11-15' = {
  parent: resourceSymbolicName
  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'
      defaultTtl: int
      id: 'string'
      indexingPolicy: {
        automatic: bool
        compositeIndexes: [
          [
            {
              order: 'string'
              path: 'string'
            }
          ]
        ]
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
        spatialIndexes: [
          {
            path: 'string'
            types: [
              'string'
            ]
          }
        ]
        vectorIndexes: [
          {
            path: 'string'
            type: 'string'
          }
        ]
      }
      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 de propriedade

AutoscaleSettings

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)
encryptionAlgorithm O algoritmo de criptografia que será usado. Por exemplo, AEAD_AES_256_CBC_HMAC_SHA256. cadeia de caracteres (obrigatório)
encryptionType 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
includedPaths 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)

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

ComputedProperty

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

ConflictResolutionPolicy

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

ContainerPartitionKey

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 'Hash'
'MultiHash'
'Range'
Caminhos Lista de caminhos usando quais dados dentro do contêiner podem ser particionados string[]
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
autoscaleSettings 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
throughput Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. int

ExcludedPath

Nome Descrição Valor
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) corda

IncludedPath

Nome Descrição Valor
Índices Lista de índices para este caminho índices []
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) corda

Índices

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

IndexingPolicy

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

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Nome Descrição Valor
localização O local do grupo de recursos ao qual o recurso pertence. corda
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

ResourceRestoreParameters

Nome Descrição Valor
restoreSource 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} corda
restoreTimestampInUtc Tempo para o qual a conta precisa ser restaurada (formato ISO-8601). corda
restoreWithTtlDisabled Especifica se a conta restaurada terá o TempoTo-Live desabilitado após a restauração bem-sucedida. Bool

SpatialSpec

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/*) corda
Tipos Lista do tipo espacial do caminho Matriz de cadeia de caracteres que contém qualquer um dos:
'LineString'
'MultiPolygon'
'Point'
'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
computedProperties Lista de propriedades computadas ComputedProperty []
conflictResolutionPolicy A política de resolução de conflitos para o contêiner. ConflictResolutionPolicy
createMode Enumerar para indicar o modo de criação de recursos. 'Padrão'
'Restaurar'
defaultTtl Tempo de vida padrão int
id Nome do contêiner do SQL do Cosmos DB cadeia de caracteres (obrigatório)
indexingPolicy A configuração da política de indexação. Por padrão, a indexação é automática para todos os caminhos de documento dentro do contêiner indexingPolicy
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
uniqueKeyPolicy A configuração de política de chave exclusiva para especificar restrições de exclusividade em documentos na coleção no serviço do Azure Cosmos DB. UniqueKeyPolicy
vectorEmbeddingPolicy A política de inserção de vetor para o contêiner. VectorEmbeddingPolicy

Tags

Nome Descrição Valor

UniqueKey

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

UniqueKeyPolicy

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

VectorEmbedding

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

VectorEmbeddingPolicy

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

VectorIndex

Nome Descrição Valor
caminho O caminho para o campo de vetor no documento. cadeia de caracteres (obrigatório)
tipo O tipo de índice do vetor. Atualmente, há suporte para flat, diskANN e quantizedFlat. 'diskANN'
'flat'
'quantizedFlat' (obrigatório)

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam 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": "2024-11-15",
  "name": "string",
  "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",
      "defaultTtl": "int",
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "compositeIndexes": [
          [
            {
              "order": "string",
              "path": "string"
            }
          ]
        ],
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string",
        "spatialIndexes": [
          {
            "path": "string",
            "types": [ "string" ]
          }
        ],
        "vectorIndexes": [
          {
            "path": "string",
            "type": "string"
          }
        ]
      },
      "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 de propriedade

AutoscaleSettings

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)
encryptionAlgorithm O algoritmo de criptografia que será usado. Por exemplo, AEAD_AES_256_CBC_HMAC_SHA256. cadeia de caracteres (obrigatório)
encryptionType 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
includedPaths 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)

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

ComputedProperty

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

ConflictResolutionPolicy

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

ContainerPartitionKey

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 'Hash'
'MultiHash'
'Range'
Caminhos Lista de caminhos usando quais dados dentro do contêiner podem ser particionados string[]
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
autoscaleSettings 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
throughput Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. int

ExcludedPath

Nome Descrição Valor
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) corda

IncludedPath

Nome Descrição Valor
Índices Lista de índices para este caminho índices []
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) corda

Índices

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

IndexingPolicy

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

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Nome Descrição Valor
apiVersion A versão da API '2024-11-15'
localização O local do grupo de recursos ao qual o recurso pertence. corda
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'

ResourceRestoreParameters

Nome Descrição Valor
restoreSource 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} corda
restoreTimestampInUtc Tempo para o qual a conta precisa ser restaurada (formato ISO-8601). corda
restoreWithTtlDisabled Especifica se a conta restaurada terá o TempoTo-Live desabilitado após a restauração bem-sucedida. Bool

SpatialSpec

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/*) corda
Tipos Lista do tipo espacial do caminho Matriz de cadeia de caracteres que contém qualquer um dos:
'LineString'
'MultiPolygon'
'Point'
'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
computedProperties Lista de propriedades computadas ComputedProperty []
conflictResolutionPolicy A política de resolução de conflitos para o contêiner. ConflictResolutionPolicy
createMode Enumerar para indicar o modo de criação de recursos. 'Padrão'
'Restaurar'
defaultTtl Tempo de vida padrão int
id Nome do contêiner do SQL do Cosmos DB cadeia de caracteres (obrigatório)
indexingPolicy A configuração da política de indexação. Por padrão, a indexação é automática para todos os caminhos de documento dentro do contêiner indexingPolicy
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
uniqueKeyPolicy A configuração de política de chave exclusiva para especificar restrições de exclusividade em documentos na coleção no serviço do Azure Cosmos DB. UniqueKeyPolicy
vectorEmbeddingPolicy A política de inserção de vetor para o contêiner. VectorEmbeddingPolicy

Tags

Nome Descrição Valor

UniqueKey

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

UniqueKeyPolicy

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

VectorEmbedding

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

VectorEmbeddingPolicy

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

VectorIndex

Nome Descrição Valor
caminho O caminho para o campo de vetor no documento. cadeia de caracteres (obrigatório)
tipo O tipo de índice do vetor. Atualmente, há suporte para flat, diskANN e quantizedFlat. 'diskANN'
'flat'
'quantizedFlat' (obrigatório)

Modelos de início rápido

Os modelos de início rápido a seguir implantam 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:

  • grupos de recursos

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@2024-11-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    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"
        defaultTtl = int
        id = "string"
        indexingPolicy = {
          automatic = bool
          compositeIndexes = [
            [
              {
                order = "string"
                path = "string"
              }
            ]
          ]
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
          spatialIndexes = [
            {
              path = "string"
              types = [
                "string"
              ]
            }
          ]
          vectorIndexes = [
            {
              path = "string"
              type = "string"
            }
          ]
        }
        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 de propriedade

AutoscaleSettings

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)
encryptionAlgorithm O algoritmo de criptografia que será usado. Por exemplo, AEAD_AES_256_CBC_HMAC_SHA256. cadeia de caracteres (obrigatório)
encryptionType 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
includedPaths 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)

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

ComputedProperty

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

ConflictResolutionPolicy

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

ContainerPartitionKey

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 'Hash'
'MultiHash'
'Range'
Caminhos Lista de caminhos usando quais dados dentro do contêiner podem ser particionados string[]
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
autoscaleSettings 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
throughput Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. int

ExcludedPath

Nome Descrição Valor
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) corda

IncludedPath

Nome Descrição Valor
Índices Lista de índices para este caminho índices []
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) corda

Índices

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

IndexingPolicy

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

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Nome Descrição Valor
localização O local do grupo de recursos ao qual o recurso pertence. corda
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@2024-11-15"

ResourceRestoreParameters

Nome Descrição Valor
restoreSource 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} corda
restoreTimestampInUtc Tempo para o qual a conta precisa ser restaurada (formato ISO-8601). corda
restoreWithTtlDisabled Especifica se a conta restaurada terá o TempoTo-Live desabilitado após a restauração bem-sucedida. Bool

SpatialSpec

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/*) corda
Tipos Lista do tipo espacial do caminho Matriz de cadeia de caracteres que contém qualquer um dos:
'LineString'
'MultiPolygon'
'Point'
'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
computedProperties Lista de propriedades computadas ComputedProperty []
conflictResolutionPolicy A política de resolução de conflitos para o contêiner. ConflictResolutionPolicy
createMode Enumerar para indicar o modo de criação de recursos. 'Padrão'
'Restaurar'
defaultTtl Tempo de vida padrão int
id Nome do contêiner do SQL do Cosmos DB cadeia de caracteres (obrigatório)
indexingPolicy A configuração da política de indexação. Por padrão, a indexação é automática para todos os caminhos de documento dentro do contêiner indexingPolicy
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
uniqueKeyPolicy A configuração de política de chave exclusiva para especificar restrições de exclusividade em documentos na coleção no serviço do Azure Cosmos DB. UniqueKeyPolicy
vectorEmbeddingPolicy A política de inserção de vetor para o contêiner. VectorEmbeddingPolicy

Tags

Nome Descrição Valor

UniqueKey

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

UniqueKeyPolicy

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

VectorEmbedding

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

VectorEmbeddingPolicy

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

VectorIndex

Nome Descrição Valor
caminho O caminho para o campo de vetor no documento. cadeia de caracteres (obrigatório)
tipo O tipo de índice do vetor. Atualmente, há suporte para flat, diskANN e quantizedFlat. 'diskANN'
'flat'
'quantizedFlat' (obrigatório)