Compartilhar via

Banco de dados Microsoft.DocumentDBAccounts/sqlDatabases/containers 2023-04-15

  • Artigo

Definição de recurso do Bicep

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

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

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers, adicione o seguinte Bicep ao modelo.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-04-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      clientEncryptionPolicy: {
        includedPaths: [
          {
            clientEncryptionKeyId: 'string'
            encryptionAlgorithm: 'string'
            encryptionType: 'string'
            path: 'string'
          }
        ]
        policyFormatVersion: int
      }
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: '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'
            ]
          }
        ]
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
}

Valores de propriedade

databaseAccounts/sqlDatabases/containers

Name Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos filho no Bicep.		 cadeia de caracteres (obrigatório)
local O local do grupo de recursos ao qual o recurso pertence. string
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). No máximo 15 marcas podem ser fornecidas para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas. Consulte Marcas em modelos
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: sqlDatabases
properties Propriedades para criar e atualizar o contêiner do Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (obrigatório)

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Name Descrição Valor
opções Um par chave-valor de opções a ser aplicado para a solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
recurso O formato JSON padrão de um contêiner SqlContainerResourceOrSqlContainerGetPropertiesResou... (obrigatório)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Name Descrição Valor
autoscaleSettings Especifica as configurações de dimensionamento automático. Dimensionamento automáticoConfigurações
throughput Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. INT

Dimensionamento automáticoConfigurações

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

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Name Descrição Valor
analyticalStorageTtl TTL analítico. INT
clientEncryptionPolicy A política de criptografia do cliente para o contêiner. ClientEncryptionPolicy
Conflictresolutionpolicy A política de resolução de conflitos para o contêiner. Conflictresolutionpolicy
defaultTtl Tempo de vida padrão INT
id Nome do contêiner de 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
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

ClientEncryptionPolicy

Name Descrição Valor
includedPaths Caminhos do item que precisam de criptografia junto com 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 partição e ID. int (obrigatório)

Restrições:
Valor mínimo = 1
Valor máximo = 2

ClientEncryptionIncludedPath

Name Descrição Valor
clientEncryptionKeyId O identificador da Chave de Criptografia do Cliente a ser usada 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ístico, Randomizado. cadeia de caracteres (obrigatório)
caminho Caminho que precisa ser criptografado. cadeia de caracteres (obrigatório)

Conflictresolutionpolicy

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

IndexingPolicy

Name 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 especificações espaciais SpatialSpec[]

CompositePath

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

ExcludedPath

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

IncludedPath

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

Índices

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

SpatialSpec

Name Descrição Valor
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) string
tipos Lista do tipo espacial do caminho Matriz de cadeia de caracteres que contém qualquer um dos:
'LineString'
'MultiPolygon'
'Point'
'Polígono'

ContainerPartitionKey

Name Descrição Valor
kind 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 que usam quais dados dentro do contêiner podem ser particionados string[]
version Indica a versão da definição da chave de partição INT

Restrições:
Valor mínimo = 1
Valor máximo = 2

UniqueKeyPolicy

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

UniqueKey

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

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Criar uma conta de camada gratuita do Azure Cosmos DB

Implantar no Azure		 Este 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 compartilhada e contêiner.
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.
API do SQL da conta do Azure Cosmos DB com 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 API de SQL de conta do Azure Cosmos DB com dimensionamento automático

Implantar no Azure		 Este modelo cria uma API de conta do Azure Cosmos para 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		 Este 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.
Implantar o BD do Azure Data Explorer com a conexão do Cosmos DB

Implantar no Azure		 Implante 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 direcionadas:

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

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
  "apiVersion": "2023-04-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "clientEncryptionPolicy": {
        "includedPaths": [
          {
            "clientEncryptionKeyId": "string",
            "encryptionAlgorithm": "string",
            "encryptionType": "string",
            "path": "string"
          }
        ],
        "policyFormatVersion": "int"
      },
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "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" ]
          }
        ]
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  }
}

Valores de propriedade

databaseAccounts/sqlDatabases/containers

Name Descrição Valor
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers'
apiVersion A versão da API de recursos '2023-04-15'
name O nome do recurso

Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.		 cadeia de caracteres (obrigatório)
local O local do grupo de recursos ao qual o recurso pertence. string
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). No máximo 15 marcas podem ser fornecidas para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas. Consulte Marcas em modelos
properties Propriedades para criar e atualizar o contêiner do Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (obrigatório)

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Name Descrição Valor
opções Um par chave-valor de opções a ser aplicado para a solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
recurso O formato JSON padrão de um contêiner SqlContainerResourceOrSqlContainerGetPropertiesResou... (obrigatório)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Name Descrição Valor
autoscaleSettings Especifica as configurações de dimensionamento automático. Dimensionamento automáticoConfigurações
throughput Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. INT

Dimensionamento automáticoConfigurações

Name Descrição Valor
maxThroughput Representa a taxa de transferência máxima, o recurso pode escalar verticalmente. INT

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Name Descrição Valor
analyticalStorageTtl TTL analítico. INT
clientEncryptionPolicy A política de criptografia do cliente para o contêiner. ClientEncryptionPolicy
Conflictresolutionpolicy A política de resolução de conflitos para o contêiner. Conflictresolutionpolicy
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
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

ClientEncryptionPolicy

Name Descrição Valor
includedPaths Caminhos do item que precisam de criptografia junto com 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 (obrigatório)

Restrições:
Valor mínimo = 1
Valor máximo = 2

ClientEncryptionIncludedPath

Name Descrição Valor
clientEncryptionKeyId O identificador da Chave de Criptografia do Cliente a ser usada 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ístico, Randomizado. cadeia de caracteres (obrigatório)
caminho Caminho que precisa ser criptografado. cadeia de caracteres (obrigatório)

Conflictresolutionpolicy

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

IndexingPolicy

Name 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 especificações espaciais SpatialSpec[]

CompositePath

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

ExcludedPath

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

IncludedPath

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

Índices

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

SpatialSpec

Name Descrição Valor
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) string
tipos Lista do tipo espacial do caminho Matriz de cadeia de caracteres que contém qualquer um dos:
'LineString'
'MultiPolygon'
'Point'
'Polígono'

ContainerPartitionKey

Name Descrição Valor
kind Indica o tipo de algoritmo usado para particionamento. Para MultiHash, há suporte para várias chaves de partição (até três máximos) para criação de contêiner 'Hash'
'MultiHash'
'Range'
caminhos Lista de caminhos usando quais dados dentro do contêiner podem ser particionados string[]
version Indica a versão da definição da chave de partição INT

Restrições:
Valor mínimo = 1
Valor máximo = 2

UniqueKeyPolicy

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

UniqueKey

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

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Criar uma conta de camada gratuita do Azure Cosmos DB

Implantar no Azure		 Este 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 compartilhada e contêiner.
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.
API do SQL da conta do Azure Cosmos DB com 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 API de SQL da conta do Azure Cosmos DB com dimensionamento automático

Implantar no Azure		 Esse modelo cria uma conta do Azure Cosmos para a API 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 Azure Cosmos DB Core (SQL)

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, um gatilho e uma função definida pelo usuário.
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 direcionadas:

  • Grupos de recursos

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

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers, adicione o Terraform a seguir ao modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-04-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        clientEncryptionPolicy = {
          includedPaths = [
            {
              clientEncryptionKeyId = "string"
              encryptionAlgorithm = "string"
              encryptionType = "string"
              path = "string"
            }
          ]
          policyFormatVersion = int
        }
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "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"
              ]
            }
          ]
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

Valores de propriedade

databaseAccounts/sqlDatabases/containers

Name Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-04-15"
name O nome do recurso cadeia de caracteres (obrigatório)
local O local do grupo de recursos ao qual o recurso pertence. string
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: sqlDatabases
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas.
properties Propriedades para criar e atualizar o contêiner do Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (obrigatório)

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Name Descrição Valor
opções Um par chave-valor de opções a serem aplicadas à solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
recurso O formato JSON padrão de um contêiner SqlContainerResourceOrSqlContainerGetPropertiesResou... (obrigatório)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Name Descrição Valor
autoscaleSettings Especifica as configurações de Dimensionamento automático. AutoscaleSettings
throughput Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. INT

AutoscaleSettings

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

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Name Descrição Valor
analyticalStorageTtl TTL analítico. INT
clientEncryptionPolicy A política de criptografia do cliente para o contêiner. ClientEncryptionPolicy
Conflictresolutionpolicy A política de resolução de conflitos para o contêiner. Conflictresolutionpolicy
defaultTtl Tempo de vida padrão INT
id Nome do contêiner de 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
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

ClientEncryptionPolicy

Name Descrição Valor
includedPaths Caminhos do item que precisam de criptografia junto com 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 partição e ID. int (obrigatório)

Restrições:
Valor mínimo = 1
Valor máximo = 2

ClientEncryptionIncludedPath

Name Descrição Valor
clientEncryptionKeyId O identificador da Chave de Criptografia do Cliente a ser usada 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ístico, Randomizado. cadeia de caracteres (obrigatório)
caminho Caminho que precisa ser criptografado. cadeia de caracteres (obrigatório)

Conflictresolutionpolicy

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

IndexingPolicy

Name 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 especificações espaciais SpatialSpec[]

CompositePath

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

ExcludedPath

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

IncludedPath

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

Índices

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

SpatialSpec

Name Descrição Valor
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) string
tipos Lista do tipo espacial do caminho Matriz de cadeia de caracteres que contém qualquer um dos:
"LineString"
"MultiPolygon"
"Ponto"
"Polígono"

ContainerPartitionKey

Name Descrição Valor
kind 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"
"Intervalo"
caminhos Lista de caminhos que usam quais dados dentro do contêiner podem ser particionados string[]
version Indica a versão da definição da chave de partição INT

Restrições:
Valor mínimo = 1
Valor máximo = 2

UniqueKeyPolicy

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

UniqueKey

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