Banco de dados Microsoft.DocumentDBAccounts/sqlDatabases/containers
- Mais recente
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 15-01-2021
- 2020-09-01
- Versão prévia-01-06-2020
- 01-04-2020
- 2020-03-01
- 2019-12-12
- 01-08-2019
Definição de recurso do Bicep
O tipo de recurso databaseAccounts/sqlDatabases/containers pode ser implantado com operações direcionadas:
- Grupos de recursos – Consulte comandos de implantação do grupo 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 seguinte Bicep ao modelo.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-02-15-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
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
databaseAccounts/sqlDatabases/containers
| Nome | 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). 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. Confira 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 |
| identidade | Identidade do recurso. | ManagedServiceIdentity |
| properties | Propriedades para criar e atualizar o contêiner do Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (obrigatório) |
ManagedServiceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned': o tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá todas as identidades do serviço. |
|
| userAssignedIdentities | A lista de identidades de usuário associadas ao recurso. As referências de chave de dicionário de identidade do usuário serão IDs de recurso do ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
| Nome | 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...
| 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. | Dimensionamento automáticoConfigurações |
| throughput | Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. | INT |
Dimensionamento automáticoConfigurações
| Nome | Descrição | Valor |
|---|---|---|
| maxThroughput | Representa a taxa de transferência máxima, o recurso pode escalar verticalmente. | INT |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| 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' 'PointInTimeRestore' 'Restore' |
| 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 |
| materializedViewDefinition | A configuração para definir Exibições Materializadas. Isso deve ser especificado apenas para criar um contêiner de Exibição Materializada. | 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 do Azure Cosmos DB. | UniqueKeyPolicy |
ClientEncryptionPolicy
| Nome | 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
| Nome | 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) |
ComputedProperty
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome de uma propriedade computada, por exemplo , "cp_lowerName" | string |
| Consulta | A consulta que avalia o valor da propriedade computada, por exemplo , "SELECT VALUE LOWER(c.name) FROM c" | string |
Conflictresolutionpolicy
| Nome | Descrição | Valor |
|---|---|---|
| conflictResolutionPath | O caminho de resolução de conflitos no caso do modo LastWriterWins. | string |
| conflictResolutionProcedure | O procedimento para resolve conflitos no caso do modo personalizado. | string |
| mode | Indica o modo de resolução de conflitos. | 'Custom' 'LastWriterWins' |
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 especificações espaciais | SpatialSpec[] |
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/*) | string |
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/*) | string |
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/*) | string |
Índices
| Nome | 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
| 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/*) | string |
| tipos | Lista do tipo espacial do caminho | Matriz de cadeia de caracteres que contém qualquer um dos: 'LineString' 'MultiPolygon' 'Point' 'Polígono' |
MaterializedViewDefinition
| Nome | Descrição | Valor |
|---|---|---|
| definição | A definição deve ser uma consulta SQL que seria usada para buscar dados do contêiner de origem a serem preenchidos no contêiner exibição materializada. | cadeia de caracteres (obrigatório) |
| sourceCollectionId | O nome do contêiner de origem no qual a Exibição Materializada será criada. | cadeia de caracteres (obrigatório) |
ContainerPartitionKey
| Nome | 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 |
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} | string |
| restoreTimestampInUtc | Tempo para o qual a conta precisa ser restaurada (formato ISO-8601). | string |
| restoreWithTtlDisabled | Especifica se a conta restaurada terá a Vida Útil desabilitada após a restauração bem-sucedida. | bool |
UniqueKeyPolicy
| Nome | 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
| Nome | 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 |
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) |
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 |
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 |
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) |
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 Azure Data Explorer DB com a conexão do Cosmos DB |
Implante o Azure Data Explorer DB 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:
- Grupos de recursos – Consulte comandos de implantação do grupo 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 JSON a seguir ao modelo.
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
"apiVersion": "2024-02-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"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
databaseAccounts/sqlDatabases/containers
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers' |
| apiVersion | A versão da API do recurso | '2024-02-15-preview' |
| 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). 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. Confira Marcas em modelos |
| identidade | Identidade do recurso. | ManagedServiceIdentity |
| properties | Propriedades para criar e atualizar o contêiner do Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (obrigatório) |
ManagedServiceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned': o tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá todas as identidades do serviço. |
|
| userAssignedIdentities | A lista de identidades de usuário associadas ao recurso. As referências de chave de dicionário de identidade do usuário serão IDs de recurso do ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
| Nome | 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...
| Nome | Descrição | Valor |
|---|---|---|
| autoscaleSettings | Especifica as configurações de Dimensionamento automático. Observação: a taxa de transferência ou autoscaleSettings é necessária, mas não ambas. | AutoscaleSettings |
| throughput | Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. | INT |
AutoscaleSettings
| Nome | Descrição | Valor |
|---|---|---|
| maxThroughput | Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente. | INT |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| 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' 'PointInTimeRestore' 'Restore' |
| 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 |
| materializedViewDefinition | A configuração para definir Exibições Materializadas. Isso deve ser especificado apenas para criar um contêiner de Exibição Materializada. | 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 do Azure Cosmos DB. | UniqueKeyPolicy |
ClientEncryptionPolicy
| Nome | 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
| Nome | 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) |
ComputedProperty
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome de uma propriedade computada, por exemplo- "cp_lowerName" | string |
| Consulta | A consulta que avalia o valor da propriedade computada, por exemplo , "SELECT VALUE LOWER(c.name) FROM c" | string |
Conflictresolutionpolicy
| Nome | Descrição | Valor |
|---|---|---|
| conflictResolutionPath | O caminho de resolução de conflitos no caso do modo LastWriterWins. | string |
| conflictResolutionProcedure | O procedimento para resolve conflitos no caso do modo personalizado. | string |
| mode | Indica o modo de resolução de conflitos. | 'Personalizado' 'LastWriterWins' |
IndexingPolicy
| Nome | Descrição | Valor |
|---|---|---|
| automático | Indica se a política de indexação é automática | bool |
| 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
| 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/*) | string |
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/*) | string |
IncludedPath
| Nome | 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
| Nome | 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
| 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/*) | string |
| tipos | Lista do tipo espacial do caminho | Matriz de cadeia de caracteres que contém qualquer um dos: 'LineString' 'MultiPolygon' 'Point' 'Polígono' |
MaterializedViewDefinition
| Nome | Descrição | Valor |
|---|---|---|
| definição | A definição deve ser uma consulta SQL que seria usada para buscar dados do contêiner de origem a serem preenchidos no contêiner exibição materializada. | cadeia de caracteres (obrigatório) |
| sourceCollectionId | O nome do contêiner de origem no qual a Exibição Materializada será criada. | cadeia de caracteres (obrigatório) |
ContainerPartitionKey
| Nome | 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 |
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} | string |
| restoreTimestampInUtc | Hora em que a conta precisa ser restaurada (formato ISO-8601). | string |
| restoreWithTtlDisabled | Especifica se a conta restaurada terá a Vida Útil desabilitada após a restauração bem-sucedida. | bool |
UniqueKeyPolicy
| Nome | 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
| Nome | 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 |
Este modelo cria uma conta de camada gratuita do Azure Cosmos DB 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) |
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 |
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 |
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) |
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 Azure Data Explorer DB com a conexão do Cosmos DB |
Implante o Azure Data Explorer DB 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@2024-02-15-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
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
databaseAccounts/sqlDatabases/containers
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-02-15-preview" |
| 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. |
| identidade | Identidade do recurso. | ManagedServiceIdentity |
| properties | Propriedades para criar e atualizar o contêiner do Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (obrigatório) |
ManagedServiceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned": 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. |
|
| identity_ids | A lista de identidades de usuário associadas ao recurso. As referências de chave de dicionário de identidade do usuário serão IDs de recurso do ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | Matriz de IDs de identidade do usuário. |
ManagedServiceIdentityUserAssignedIdentities
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
| Nome | 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...
| Nome | Descrição | Valor |
|---|---|---|
| autoscaleSettings | Especifica as configurações de Dimensionamento automático. Observação: a taxa de transferência ou autoscaleSettings é necessária, mas não ambas. | AutoscaleSettings |
| throughput | Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. | INT |
AutoscaleSettings
| Nome | Descrição | Valor |
|---|---|---|
| maxThroughput | Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente. | INT |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| 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 | Enumeração para indicar o modo de criação de recursos. | "Padrão" "PointInTimeRestore" "Restaurar" |
| 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 |
| materializedViewDefinition | A configuração para definir exibições materializadas. Isso deve ser especificado apenas para criar um contêiner de Exibição Materializada. | 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 do Azure Cosmos DB. | UniqueKeyPolicy |
ClientEncryptionPolicy
| Nome | 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
| Nome | 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) |
ComputedProperty
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome de uma propriedade computada, por exemplo , "cp_lowerName" | string |
| Consulta | A consulta que avalia o valor da propriedade computada, por exemplo , "SELECT VALUE LOWER(c.name) FROM c" | string |
Conflictresolutionpolicy
| Nome | Descrição | Valor |
|---|---|---|
| conflictResolutionPath | O caminho de resolução de conflitos no caso do modo LastWriterWins. | string |
| conflictResolutionProcedure | O procedimento para resolve conflitos no caso do modo personalizado. | string |
| mode | Indica o modo de resolução de conflitos. | “Personalizado” "LastWriterWins" |
IndexingPolicy
| Nome | Descrição | Valor |
|---|---|---|
| automático | Indica se a política de indexação é automática | bool |
| 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
| 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/*) | string |
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/*) | string |
IncludedPath
| Nome | 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
| Nome | Descrição | Valor |
|---|---|---|
| dataType | O tipo de dados ao qual o comportamento de indexação é aplicado. | "LineString" "MultiPolygon" "Número" "Ponto" "Polígono" "Cadeia 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
| 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/*) | string |
| tipos | Lista do tipo espacial do caminho | Matriz de cadeia de caracteres que contém qualquer um dos: "LineString" "MultiPolygon" "Ponto" "Polígono" |
MaterializedViewDefinition
| Nome | Descrição | Valor |
|---|---|---|
| definição | A definição deve ser uma consulta SQL que seria usada para buscar dados do contêiner de origem a serem preenchidos no contêiner exibição materializada. | cadeia de caracteres (obrigatório) |
| sourceCollectionId | O nome do contêiner de origem no qual a Exibição Materializada será criada. | cadeia de caracteres (obrigatório) |
ContainerPartitionKey
| Nome | 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" "Intervalo" |
| 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 |
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} | string |
| restoreTimestampInUtc | Tempo para o qual a conta precisa ser restaurada (formato ISO-8601). | string |
| restoreWithTtlDisabled | Especifica se a conta restaurada terá a Vida Útil desabilitada após a restauração bem-sucedida. | bool |
UniqueKeyPolicy
| Nome | 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
| Nome | Descrição | Valor |
|---|---|---|
| caminhos | A lista de caminhos deve ser exclusiva para cada documento no serviço do Azure Cosmos DB | string[] |
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de