Ler em inglês

Partilhar via

Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers 2024-09-01-preview

  • Artigo
Escolha um idioma de implantação

Definição de recursos do bíceps

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 do recurso

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-09-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'
      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'
            ]
          }
        ]
      }
      materializedViewDefinition: {
        definition: 'string'
        sourceCollectionId: 'string'
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

AutoscaleSettings

Designação Descrição Valor
maxTaxa de transferência Representa a taxa de transferência máxima, até a qual o recurso pode ser dimensionado. Int

ClientEncryptionIncludedPath

Designação Descrição Valor
clientEncryptionKeyId O identificador da chave de criptografia do cliente a ser usada para criptografar o caminho. string (obrigatório)
encryptionAlgoritmo O algoritmo de encriptação que será usado. Ex: - AEAD_AES_256_CBC_HMAC_SHA256. string (obrigatório)
encryptionType O tipo de criptografia a ser executada. Ex: - determinístico, randomizado. string (obrigatório)
caminho Caminho que precisa ser criptografado. string (obrigatório)

ClientEncryptionPolicy

Designação Descrição Valor
incluídosCaminhos Caminhos do item que precisam de criptografia junto com configurações específicas de caminho. ClientEncryptionIncludedPath[] (obrigatório)
policyFormatVersion Versão da definição da política de criptografia do cliente. As versões suportadas são 1 e 2. A versão 2 suporta encriptação de id e caminho de chave de partição. Int

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Designação Descrição Valor

CompositePath

Designação Descrição Valor
Encomenda Ordem de classificação para caminhos compostos. 'Ascendente'
'descendente'
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

ComputedProperty

Designação Descrição Valor
Designação O nome de uma propriedade calculada, por exemplo - "cp_lowerName" string
consulta A consulta que avalia o valor da propriedade calculada, por exemplo - "SELECT VALUE LOWER(c.name) FROM c" string

Resolução de ConflitosPolítica

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

ContainerPartitionKey

Designação Descrição Valor
tipo Indica o tipo de algoritmo usado para particionamento. Para MultiHash, várias chaves de partição (até três no máximo) são suportadas para criação de contêiner 'Hash'
'MultiHash'
'Gama'
Caminhos Lista de caminhos usando quais dados dentro do contêiner podem ser particionados string[]
Versão Indica a versão da definição de chave de partição Int

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

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Designação Descrição Valor
autoscaleConfigurações Especifica as configurações de dimensionamento automático. Nota: A taxa de transferência ou autoscaleSettings é necessária, mas não ambas. AutoscaleSettings
taxa de transferência Solicite unidades por segundo. Por exemplo, "taxa de transferência": 10000. Int

Caminho Excluído

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

IncludedPath

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

Índices

Designação Descrição Valor
Tipo de dados O tipo de dados ao qual o comportamento de indexação é aplicado. 'LineString'
'Multipolígono'
'Número'
'Ponto'
'Polígono'
'String'
tipo Indica o tipo de índice. 'Hash'
'Gama'
'Espacial'
precisão A precisão do índice. -1 é a precisão máxima. Int

Política de indexação

Designação Descrição Valor
Automático Indica se a política de indexação é automática Bool
compositeIndexes Lista de caminhos compostos CompositePath [][]
excludedCaminhos Lista de caminhos a excluir da indexação ExcludedPath[]
incluídosCaminhos Lista de caminhos a incluir na indexação IncludedPath[]
indexaçãoModo de indexação Indica o modo de indexação. 'Consistente'
'Preguiçoso'
'nenhuma'
spatialIndexes Lista de especificidades espaciais SpatialSpec[]

ManagedServiceIdentity

Designação 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 'Nenhum' removerá todas as identidades do serviço. 'Nenhuma'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities 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 ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Designação Descrição Valor

MaterializedViewDefinition

Designação 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 Materialized View. string (obrigatório)
sourceCollectionId O nome do contêiner de origem no qual a Exibição Materializada será criada. string (obrigatório)

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Designação Descrição Valor
identidade Identidade do recurso. ManagedServiceIdentity
Localização O local do grupo de recursos ao qual o recurso pertence. string
Designação O nome do recurso string (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.		 Nome simbólico para recurso do tipo: databaseAccounts/sqlDatabases
propriedades Propriedades para criar e atualizar o contêiner do Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

ResourceRestoreParameters

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

SpatialSpec

Designação Descrição Valor
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) string
tipos Lista do tipo espacial do caminho Matriz de cadeia de caracteres contendo qualquer uma das:
'LineString'
'Multipolígono'
'Ponto'
'Polígono'

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

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

SqlContainerResourceOrSqlContainerGetPropertiesResource

Designação Descrição Valor
analíticoStorageTtl TTL analítico. Int
clientEncryptionPolicy A política de criptografia do cliente para o contêiner. ClientEncryptionPolicy
computedProperties Lista de propriedades computadas ComputedProperty[]
resolução de conflitosPolítica A política de resolução de conflitos para o contêiner. ConflictResolutionPolicy
createMode Enum para indicar o modo de criação de recursos. 'Inadimplência'
'Restaurar'
padrãoTtl Tempo de vida padrão Int
ID Nome do contêiner SQL do Cosmos DB string (obrigatório)
indexaçãoPolítica A configuração da política de indexação. Por padrão, a indexação é automática para todos os caminhos de documentos dentro do contêiner IndexaçãoPolítica
materializedViewDefinition A configuração para definir Visualizações Materializadas. Isso deve ser especificado apenas para a criação de um contêiner de Modo de Exibição Materializado. MaterializedViewDefinition
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 Azure Cosmos DB. UniqueKeyPolicy

Etiquetas

Designação Descrição Valor

Chave Única

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

UniqueKeyPolicy

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

Exemplos de uso

Exemplos de início rápido do Azure

Os seguintes modelos início rápido do Azure contêm exemplos de Bicep para implantar esse tipo de recurso.

Arquivo Bicep Descrição
API SQL da conta do Azure Cosmos DB com de armazenamento analítico Este modelo cria uma conta do Azure Cosmos para API Core (SQL) com um banco de dados e contêiner configurado com repositório analítico.
Criar uma conta gratuita do Azure Cosmos DB Este modelo cria uma conta de camada gratuita do Azure Cosmos DB para API 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 Core (SQL) Este modelo cria uma conta do Azure Cosmos para API Core (SQL) com um banco de dados e 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 Este modelo cria uma conta do Azure Cosmos para API Core (SQL) com um banco de dados e 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) Este modelo cria uma conta do Azure Cosmos DB para a API Core (SQL) e um contêiner com um procedimento armazenado, gatilho e função definida pelo usuário.
Cria um aplicativo de microsserviços Dapr usando o Container Apps Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner.
Cria um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner Crie um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner.
Implantar o Banco de Dados do Azure Data Explorer com o de conexão do Cosmos DB Implante o Banco de Dados do Azure Data Explorer com conexão do Cosmos DB.

Definição de recurso de modelo 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 do recurso

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
  "apiVersion": "2024-09-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",
      "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" ]
          }
        ]
      },
      "materializedViewDefinition": {
        "definition": "string",
        "sourceCollectionId": "string"
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

AutoscaleSettings

Designação Descrição Valor
maxTaxa de transferência Representa a taxa de transferência máxima, até a qual o recurso pode ser dimensionado. Int

ClientEncryptionIncludedPath

Designação Descrição Valor
clientEncryptionKeyId O identificador da chave de criptografia do cliente a ser usada para criptografar o caminho. string (obrigatório)
encryptionAlgoritmo O algoritmo de encriptação que será usado. Ex: - AEAD_AES_256_CBC_HMAC_SHA256. string (obrigatório)
encryptionType O tipo de criptografia a ser executada. Ex: - determinístico, randomizado. string (obrigatório)
caminho Caminho que precisa ser criptografado. string (obrigatório)

ClientEncryptionPolicy

Designação Descrição Valor
incluídosCaminhos Caminhos do item que precisam de criptografia junto com configurações específicas de caminho. ClientEncryptionIncludedPath[] (obrigatório)
policyFormatVersion Versão da definição da política de criptografia do cliente. As versões suportadas são 1 e 2. A versão 2 suporta encriptação de id e caminho de chave de partição. Int

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Designação Descrição Valor

CompositePath

Designação Descrição Valor
Encomenda Ordem de classificação para caminhos compostos. 'Ascendente'
'descendente'
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

ComputedProperty

Designação Descrição Valor
Designação O nome de uma propriedade calculada, por exemplo - "cp_lowerName" string
consulta A consulta que avalia o valor da propriedade calculada, por exemplo - "SELECT VALUE LOWER(c.name) FROM c" string

Resolução de ConflitosPolítica

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

ContainerPartitionKey

Designação Descrição Valor
tipo Indica o tipo de algoritmo usado para particionamento. Para MultiHash, várias chaves de partição (até três no máximo) são suportadas para criação de contêiner 'Hash'
'MultiHash'
'Gama'
Caminhos Lista de caminhos usando quais dados dentro do contêiner podem ser particionados string[]
Versão Indica a versão da definição de chave de partição Int

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

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Designação Descrição Valor
autoscaleConfigurações Especifica as configurações de dimensionamento automático. Nota: A taxa de transferência ou autoscaleSettings é necessária, mas não ambas. AutoscaleSettings
taxa de transferência Solicite unidades por segundo. Por exemplo, "taxa de transferência": 10000. Int

Caminho Excluído

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

IncludedPath

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

Índices

Designação Descrição Valor
Tipo de dados O tipo de dados ao qual o comportamento de indexação é aplicado. 'LineString'
'Multipolígono'
'Número'
'Ponto'
'Polígono'
'String'
tipo Indica o tipo de índice. 'Hash'
'Gama'
'Espacial'
precisão A precisão do índice. -1 é a precisão máxima. Int

Política de indexação

Designação Descrição Valor
Automático Indica se a política de indexação é automática Bool
compositeIndexes Lista de caminhos compostos CompositePath [][]
excludedCaminhos Lista de caminhos a excluir da indexação ExcludedPath[]
incluídosCaminhos Lista de caminhos a incluir na indexação IncludedPath[]
indexaçãoModo de indexação Indica o modo de indexação. 'Consistente'
'Preguiçoso'
'nenhuma'
spatialIndexes Lista de especificidades espaciais SpatialSpec[]

ManagedServiceIdentity

Designação 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 'Nenhum' removerá todas as identidades do serviço. 'Nenhuma'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities 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 ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Designação Descrição Valor

MaterializedViewDefinition

Designação 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 Materialized View. string (obrigatório)
sourceCollectionId O nome do contêiner de origem no qual a Exibição Materializada será criada. string (obrigatório)

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Designação Descrição Valor
apiVersion A versão api '2024-09-01-pré-visualização'
identidade Identidade do recurso. ManagedServiceIdentity
Localização O local do grupo de recursos ao qual o recurso pertence. string
Designação O nome do recurso string (obrigatório)
propriedades Propriedades para criar e atualizar o contêiner do Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers'

ResourceRestoreParameters

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

SpatialSpec

Designação Descrição Valor
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) string
tipos Lista do tipo espacial do caminho Matriz de cadeia de caracteres contendo qualquer uma das:
'LineString'
'Multipolígono'
'Ponto'
'Polígono'

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

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

SqlContainerResourceOrSqlContainerGetPropertiesResource

Designação Descrição Valor
analíticoStorageTtl TTL analítico. Int
clientEncryptionPolicy A política de criptografia do cliente para o contêiner. ClientEncryptionPolicy
computedProperties Lista de propriedades computadas ComputedProperty[]
resolução de conflitosPolítica A política de resolução de conflitos para o contêiner. ConflictResolutionPolicy
createMode Enum para indicar o modo de criação de recursos. 'Inadimplência'
'Restaurar'
padrãoTtl Tempo de vida padrão Int
ID Nome do contêiner SQL do Cosmos DB string (obrigatório)
indexaçãoPolítica A configuração da política de indexação. Por padrão, a indexação é automática para todos os caminhos de documentos dentro do contêiner IndexaçãoPolítica
materializedViewDefinition A configuração para definir Visualizações Materializadas. Isso deve ser especificado apenas para a criação de um contêiner de Modo de Exibição Materializado. MaterializedViewDefinition
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 Azure Cosmos DB. UniqueKeyPolicy

Etiquetas

Designação Descrição Valor

Chave Única

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

UniqueKeyPolicy

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

Exemplos de uso

Modelos de início rápido do Azure

Os seguintes modelos de início rápido do Azure implantar esse tipo de recurso.

Modelo Descrição
API SQL da conta do Azure Cosmos DB com de armazenamento analítico

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

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

Implantar no Azure 		Este modelo cria uma conta do Azure Cosmos para API Core (SQL) com um banco de dados e 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 		Este modelo cria uma conta do Azure Cosmos para API Core (SQL) com um banco de dados e 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 		Este modelo cria uma conta do Azure Cosmos DB para a API Core (SQL) e um contêiner com um procedimento armazenado, gatilho e função definida pelo usuário.
Cria um aplicativo de microsserviços Dapr usando o Container Apps

Implantar no Azure 		Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner.
Cria um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner

Implantar no Azure 		Crie um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner.
Implantar o Banco de Dados do Azure Data Explorer com o de conexão do Cosmos DB

Implantar no Azure 		Implante o Banco de Dados do Azure Data Explorer com conexão do Cosmos DB.

Definição de recursos Terraform (provedor AzAPI)

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

  • Grupos de recursos

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

Formato do recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-09-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  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"
              ]
            }
          ]
        }
        materializedViewDefinition = {
          definition = "string"
          sourceCollectionId = "string"
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

Valores de propriedade

AutoscaleSettings

Designação Descrição Valor
maxTaxa de transferência Representa a taxa de transferência máxima, até a qual o recurso pode ser dimensionado. Int

ClientEncryptionIncludedPath

Designação Descrição Valor
clientEncryptionKeyId O identificador da chave de criptografia do cliente a ser usada para criptografar o caminho. string (obrigatório)
encryptionAlgoritmo O algoritmo de encriptação que será usado. Ex: - AEAD_AES_256_CBC_HMAC_SHA256. string (obrigatório)
encryptionType O tipo de criptografia a ser executada. Ex: - determinístico, randomizado. string (obrigatório)
caminho Caminho que precisa ser criptografado. string (obrigatório)

ClientEncryptionPolicy

Designação Descrição Valor
incluídosCaminhos Caminhos do item que precisam de criptografia junto com configurações específicas de caminho. ClientEncryptionIncludedPath[] (obrigatório)
policyFormatVersion Versão da definição da política de criptografia do cliente. As versões suportadas são 1 e 2. A versão 2 suporta encriptação de id e caminho de chave de partição. Int

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Designação Descrição Valor

CompositePath

Designação Descrição Valor
Encomenda Ordem de classificação para caminhos compostos. 'Ascendente'
'descendente'
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

ComputedProperty

Designação Descrição Valor
Designação O nome de uma propriedade calculada, por exemplo - "cp_lowerName" string
consulta A consulta que avalia o valor da propriedade calculada, por exemplo - "SELECT VALUE LOWER(c.name) FROM c" string

Resolução de ConflitosPolítica

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

ContainerPartitionKey

Designação Descrição Valor
tipo Indica o tipo de algoritmo usado para particionamento. Para MultiHash, várias chaves de partição (até três no máximo) são suportadas para criação de contêiner 'Hash'
'MultiHash'
'Gama'
Caminhos Lista de caminhos usando quais dados dentro do contêiner podem ser particionados string[]
Versão Indica a versão da definição de chave de partição Int

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

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Designação Descrição Valor
autoscaleConfigurações Especifica as configurações de dimensionamento automático. Nota: A taxa de transferência ou autoscaleSettings é necessária, mas não ambas. AutoscaleSettings
taxa de transferência Solicite unidades por segundo. Por exemplo, "taxa de transferência": 10000. Int

Caminho Excluído

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

IncludedPath

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

Índices

Designação Descrição Valor
Tipo de dados O tipo de dados ao qual o comportamento de indexação é aplicado. 'LineString'
'Multipolígono'
'Número'
'Ponto'
'Polígono'
'String'
tipo Indica o tipo de índice. 'Hash'
'Gama'
'Espacial'
precisão A precisão do índice. -1 é a precisão máxima. Int

Política de indexação

Designação Descrição Valor
Automático Indica se a política de indexação é automática Bool
compositeIndexes Lista de caminhos compostos CompositePath [][]
excludedCaminhos Lista de caminhos a excluir da indexação ExcludedPath[]
incluídosCaminhos Lista de caminhos a incluir na indexação IncludedPath[]
indexaçãoModo de indexação Indica o modo de indexação. 'Consistente'
'Preguiçoso'
'nenhuma'
spatialIndexes Lista de especificidades espaciais SpatialSpec[]

ManagedServiceIdentity

Designação 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 'Nenhum' removerá todas as identidades do serviço. 'Nenhuma'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities 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 ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Designação Descrição Valor

MaterializedViewDefinition

Designação 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 Materialized View. string (obrigatório)
sourceCollectionId O nome do contêiner de origem no qual a Exibição Materializada será criada. string (obrigatório)

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Designação Descrição Valor
identidade Identidade do recurso. ManagedServiceIdentity
Localização O local do grupo de recursos ao qual o recurso pertence. string
Designação O nome do recurso string (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID para recurso do tipo: databaseAccounts/sqlDatabases
propriedades Propriedades para criar e atualizar o contêiner do Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-09-01-preview"

ResourceRestoreParameters

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

SpatialSpec

Designação Descrição Valor
caminho O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) string
tipos Lista do tipo espacial do caminho Matriz de cadeia de caracteres contendo qualquer uma das:
'LineString'
'Multipolígono'
'Ponto'
'Polígono'

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

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

SqlContainerResourceOrSqlContainerGetPropertiesResource

Designação Descrição Valor
analíticoStorageTtl TTL analítico. Int
clientEncryptionPolicy A política de criptografia do cliente para o contêiner. ClientEncryptionPolicy
computedProperties Lista de propriedades computadas ComputedProperty[]
resolução de conflitosPolítica A política de resolução de conflitos para o contêiner. ConflictResolutionPolicy
createMode Enum para indicar o modo de criação de recursos. 'Inadimplência'
'Restaurar'
padrãoTtl Tempo de vida padrão Int
ID Nome do contêiner SQL do Cosmos DB string (obrigatório)
indexaçãoPolítica A configuração da política de indexação. Por padrão, a indexação é automática para todos os caminhos de documentos dentro do contêiner IndexaçãoPolítica
materializedViewDefinition A configuração para definir Visualizações Materializadas. Isso deve ser especificado apenas para a criação de um contêiner de Modo de Exibição Materializado. MaterializedViewDefinition
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 Azure Cosmos DB. UniqueKeyPolicy

Etiquetas

Designação Descrição Valor

Chave Única

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

UniqueKeyPolicy

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