Base de dados Microsoft.DocumentDBAccounts/sqlDatabases/contentores
- 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
- 01-2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 01-2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 2021-01-15
- 2020-09-01
- 06-2020-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
Definição de recurso do Bicep
O tipo de recurso databaseAccounts/sqlDatabases/containers pode ser implementado com operações que visam:
- Grupos de recursos – veja os comandos de implementação do grupo de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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-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 subordinados no Bicep. |
cadeia (obrigatório) |
| localização | A localização do grupo de recursos ao qual o recurso pertence. | string |
| etiquetas | As etiquetas são uma lista de pares chave-valor que descrevem o recurso. Estas etiquetas podem ser utilizadas para ver e agrupar este recurso (entre grupos de recursos). Pode ser fornecido um máximo de 15 etiquetas para um recurso. Cada etiqueta tem de ter uma chave não superior a 128 carateres e um valor não superior a 256 carateres. Por exemplo, a experiência predefinida para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". | Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos |
| principal | No Bicep, pode especificar o recurso principal de um recurso subordinado. Só tem de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal. Para obter mais informações, veja Recurso subordinado fora do recurso principal. |
Nome simbólico para recurso do tipo: sqlDatabases |
| identidade | Identidade do recurso. | ManagedServiceIdentity |
| propriedades | Propriedades para criar e atualizar o contentor do Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (obrigatório) |
ManagedServiceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | "Nenhum" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned": o tipo de identidade utilizado para o recurso. O tipo "SystemAssigned,UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço. |
|
| userAssignedIdentities | A lista de identidades de utilizador associadas ao recurso. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nome | Descrição | Valor |
|---|---|---|
| {customized property} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
| Nome | Descrição | Valor |
|---|---|---|
| opções | Um par de opções chave-valor a aplicar para o pedido. Isto corresponde aos cabeçalhos enviados com o pedido. | CreateUpdateOptionsOrSqlContainerGetPropertiesOption... |
| recurso | O formato JSON padrão de um contentor | SqlContainerResourceOrSqlContainerGetPropertiesResou... (obrigatório) |
CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
| Nome | Descrição | Valor |
|---|---|---|
| dimensionamento automáticoDefinições | Especifica as definições de Dimensionamento Automático. Nota: é necessário débito ou dimensionamento automáticoDefinições, mas não ambas. | Dimensionamento AutomáticoDefinições |
| de transferência de dados | Unidades de Pedido por segundo. Por exemplo, "débito": 10000. | int |
Dimensionamento AutomáticoDefinições
| Nome | Descrição | Valor |
|---|---|---|
| maxThroughput | Representa o débito máximo, o recurso pode aumentar verticalmente. | int |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| Nome | Descrição | Valor |
|---|---|---|
| analyticalStorageTtl | TTL Analítico. | int |
| clientEncryptionPolicy | A política de encriptação de cliente para o contentor. | ClientEncryptionPolicy |
| computedProperties | Lista de propriedades calculadas | ComputedProperty[] |
| conflictResolutionPolicy | A política de resolução de conflitos para o contentor. | ConflictResolutionPolicy |
| createMode | Enum para indicar o modo de criação de recursos. | 'Predefinição' 'PointInTimeRestore' "Restaurar" |
| defaultTtl | Tempo de vida predefinido | int |
| ID | Nome do contentor SQL do Cosmos DB | cadeia (obrigatório) |
| indexingPolicy | A configuração da política de indexação. Por predefinição, a indexação é automática para todos os caminhos de documentos no contentor | IndexingPolicy |
| materializedViewDefinition | A configuração para definir Vistas Materializadas. Esta ação tem de ser especificada apenas para criar um contentor de Vista Materializada. | MaterializedViewDefinition |
| partitionKey | A configuração da chave de partição a utilizar para a criação de partições de dados em múltiplas partições | ContainerPartitionKey |
| restoreParameters | Parâmetros para indicar as informações sobre o restauro | 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 |
ClientEncryptionPolicy
| Nome | Descrição | Valor |
|---|---|---|
| includedPaths | Caminhos do item que precisam de encriptação juntamente com definições específicas do caminho. | ClientEncryptionIncludedPath[] (obrigatório) |
| policyFormatVersion | Versão da definição da política de encriptação de cliente. As versões suportadas são 1 e 2. A versão 2 suporta encriptação 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 Encriptação de Cliente a utilizar para encriptar o caminho. | cadeia (obrigatório) |
| encryptionAlgorithm | O algoritmo de encriptação que será utilizado. Por exemplo, AEAD_AES_256_CBC_HMAC_SHA256. | cadeia (obrigatório) |
| encryptionType | O tipo de encriptação a ser efetuada. Por exemplo- Determinista, Aleatório. | cadeia (obrigatório) |
| caminho | Caminho que precisa de ser encriptado. | cadeia (obrigatório) |
ComputedProperty
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome de uma propriedade calculada, por exemplo , "cp_lowerName" | string |
| query | A consulta que avalia o valor da propriedade calculada, 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 resolver 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 excluir da indexação | ExcludedPath[] |
| includedPaths | Lista de caminhos a incluir na indexação | IncludedPath[] |
| indexingMode | Indica o modo de indexação. | "consistente" 'preguiçoso' "nenhum" |
| spatialIndexes | Lista de especificações espaciais | SpatialSpec[] |
CompositePath
| Nome | Descrição | Valor |
|---|---|---|
| order | Sequência de ordenação para caminhos compostos. | 'ascendente' "descendente" |
| caminho | O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e terminam com caráter universal (/path/*) | string |
ExcludedPath
| Nome | Descrição | Valor |
|---|---|---|
| caminho | O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e terminam com caráter universal (/path/*) | string |
IncludedPath
| Nome | Descrição | Valor |
|---|---|---|
| índices | Lista de índices para este caminho | Índices[] |
| caminho | O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e terminam com caráter universal (/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" |
| tipo | Indica o tipo de índice. | 'Hash' "Intervalo" "Espacial" |
| precisão | A precisão do índice. -1 é a precisão máxima. | int |
SpatialSpec
| Nome | Descrição | Valor |
|---|---|---|
| caminho | O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e fim com caráter universal (/path/*) | string |
| tipos | Lista do tipo espacial do caminho | Matriz de cadeias que contém qualquer um dos seguintes: 'LineString' "MultiPolygon" "Ponto" 'Polígono' |
MaterializedViewDefinition
| Nome | Descrição | Valor |
|---|---|---|
| definição | A definição deve ser uma consulta SQL que seria utilizada para obter dados do contentor de origem para preencher no contentor Vista Materializada. | cadeia (obrigatório) |
| sourceCollectionId | O nome do contentor de origem no qual a Vista Materializada será criada. | cadeia (obrigatório) |
ContainerPartitionKey
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Indica o tipo de algoritmo utilizado para a criação de partições. Para MultiHash, são suportadas várias chaves de partição (até três no máximo) para a criação de contentores | 'Hash' "MultiHash" "Intervalo" |
| caminhos | Lista de caminhos que utilizam os dados no contentor que podem ser particionados | cadeia[] |
| versão | Indica a versão da definição da chave de partição | int Restrições: Valor mínimo = 1 Valor máximo = 2 |
ResourceRestoreParameters
| Nome | Descrição | Valor |
|---|---|---|
| restoreSource | O ID da conta de base de dados recuperável a partir da qual o restauro tem de ser iniciado. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | Hora para a qual a conta tem de ser restaurada (formato ISO-8601). | string |
| restoreWithTtlDisabled | Especifica se a conta restaurada terá o Time-To-Live desativado após o restauro bem-sucedido. | bool |
UniqueKeyPolicy
| Nome | Descrição | Valor |
|---|---|---|
| uniqueKeys | Lista de chaves exclusivas que impõem a restrição de exclusividade em documentos na coleção no serviço Azure Cosmos DB. | UniqueKey[] |
UniqueKey
| Nome | Descrição | Valor |
|---|---|---|
| caminhos | A lista de caminhos tem de ser exclusiva para cada documento no serviço Azure Cosmos DB | cadeia[] |
Modelos de início rápido
Os seguintes modelos de início rápido implementam este tipo de recurso.
| Modelo | Description |
|---|---|
Criar uma conta do Azure Cosmos DB de camada livre |
Este modelo cria uma conta do Azure Cosmos DB de escalão livre para a API SQL com uma base de dados com débito e contentor partilhados. |
| Criar uma conta do Azure Cosmos DB para a API Core (SQL) |
Este modelo cria uma API de conta do Azure Cosmos para Core (SQL) com uma base de dados e um contentor com débito com várias outras opções. |
| API SQL da conta do Azure Cosmos DB com arquivo analítico |
Este modelo cria uma API de conta do Azure Cosmos para Core (SQL) com uma base de dados e um contentor configurados com o arquivo analítico. |
| Criar uma API 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 uma base de dados e um contentor com débito 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 contentor com um procedimento armazenado, acionador e função definida pelo utilizador. |
| Implementar o Azure Data Explorer DB com a ligação do Cosmos DB |
Implementar o Azure Data Explorer DB com a ligação do Cosmos DB. |
Definição de recurso de modelo do ARM
O tipo de recurso databaseAccounts/sqlDatabases/containers pode ser implementado com operações que visam:
- Grupos de recursos – veja comandos de implementação de grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo 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-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 de recursos | "2024-02-15-preview" |
| name | O nome do recurso Veja como definir nomes e tipos para recursos subordinados em modelos do ARM JSON. |
cadeia (obrigatório) |
| localização | A localização do grupo de recursos ao qual o recurso pertence. | string |
| etiquetas | As etiquetas são uma lista de pares chave-valor que descrevem o recurso. Estas etiquetas podem ser utilizadas na visualização e agrupamento deste recurso (entre grupos de recursos). Pode ser fornecido um máximo de 15 etiquetas para um recurso. Cada etiqueta tem de ter uma chave não superior a 128 carateres e um valor não superior a 256 carateres. Por exemplo, a experiência predefinida para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais "defaultExperience" também incluem "Tabela", "Graph", "DocumentDB" e "MongoDB". | Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos |
| identidade | Identidade do recurso. | ManagedServiceIdentity |
| propriedades | Propriedades para criar e atualizar o contentor do Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (obrigatório) |
ManagedServiceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | "Nenhum" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned": o tipo de identidade utilizado para o recurso. O tipo "SystemAssigned,UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço. |
|
| userAssignedIdentities | A lista de identidades de utilizador associadas ao recurso. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nome | Descrição | Valor |
|---|---|---|
| {customized property} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
| Nome | Descrição | Valor |
|---|---|---|
| opções | Um par de opções chave-valor a aplicar para o pedido. Isto corresponde aos cabeçalhos enviados com o pedido. | CreateUpdateOptionsOrSqlContainerGetPropertiesOption... |
| recurso | O formato JSON padrão de um contentor | SqlContainerResourceOrSqlContainerGetPropertiesResou... (obrigatório) |
CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
| Nome | Descrição | Valor |
|---|---|---|
| dimensionamento automáticoDefinições | Especifica as definições de Dimensionamento Automático. Nota: é necessário débito ou dimensionamento automáticoDefinições, mas não ambas. | Dimensionamento AutomáticoDefinições |
| de transferência de dados | Unidades de Pedido por segundo. Por exemplo, "débito": 10000. | int |
Dimensionamento AutomáticoDefinições
| Nome | Descrição | Valor |
|---|---|---|
| maxThroughput | Representa o débito máximo, o recurso pode aumentar verticalmente. | int |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| Nome | Descrição | Valor |
|---|---|---|
| analyticalStorageTtl | TTL Analítico. | int |
| clientEncryptionPolicy | A política de encriptação de cliente para o contentor. | ClientEncryptionPolicy |
| computedProperties | Lista de propriedades calculadas | ComputedProperty[] |
| conflictResolutionPolicy | A política de resolução de conflitos para o contentor. | ConflictResolutionPolicy |
| createMode | Enum para indicar o modo de criação de recursos. | 'Predefinição' 'PointInTimeRestore' "Restaurar" |
| defaultTtl | Tempo de vida predefinido | int |
| ID | Nome do contentor SQL do Cosmos DB | cadeia (obrigatório) |
| indexingPolicy | A configuração da política de indexação. Por predefinição, a indexação é automática para todos os caminhos de documentos no contentor | IndexingPolicy |
| materializedViewDefinition | A configuração para definir Vistas Materializadas. Esta ação tem de ser especificada apenas para criar um contentor de Vista Materializada. | MaterializedViewDefinition |
| partitionKey | A configuração da chave de partição a utilizar para a criação de partições de dados em múltiplas partições | ContainerPartitionKey |
| restoreParameters | Parâmetros para indicar as informações sobre o restauro | 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 |
ClientEncryptionPolicy
| Nome | Descrição | Valor |
|---|---|---|
| includedPaths | Caminhos do item que precisam de encriptação juntamente com definições específicas do caminho. | ClientEncryptionIncludedPath[] (obrigatório) |
| policyFormatVersion | Versão da definição da política de encriptação de cliente. As versões suportadas são 1 e 2. A versão 2 suporta encriptação 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 Encriptação de Cliente a utilizar para encriptar o caminho. | cadeia (obrigatório) |
| encryptionAlgorithm | O algoritmo de encriptação que será utilizado. Por exemplo, AEAD_AES_256_CBC_HMAC_SHA256. | cadeia (obrigatório) |
| encryptionType | O tipo de encriptação a executar. Por exemplo, Determinista, Aleatório. | cadeia (obrigatório) |
| caminho | Caminho que tem de ser encriptado. | cadeia (obrigatório) |
ComputedProperty
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome de uma propriedade calculada, por exemplo - "cp_lowerName" | string |
| query | A consulta que avalia o valor da propriedade calculada, 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 resolver 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 excluir da indexação | ExcludedPath[] |
| includedPaths | Lista de caminhos a incluir na indexação | IncludedPath[] |
| indexingMode | Indica o modo de indexação. | "consistente" 'preguiçoso' "nenhum" |
| spatialIndexes | Lista de especificações espaciais | SpatialSpec[] |
CompositePath
| Nome | Descrição | Valor |
|---|---|---|
| order | Sequência de ordenação para caminhos compostos. | 'ascendente' "descendente" |
| caminho | O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e terminam com caráter universal (/path/*) | string |
ExcludedPath
| Nome | Descrição | Valor |
|---|---|---|
| caminho | O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e terminam com caráter universal (/path/*) | string |
IncludedPath
| Nome | Descrição | Valor |
|---|---|---|
| índices | Lista de índices para este caminho | Índices[] |
| caminho | O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e terminam com caráter universal (/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" |
| tipo | Indica o tipo de índice. | 'Hash' "Intervalo" 'Espacial' |
| precisão | A precisão do índice. -1 é a precisão máxima. | int |
SpatialSpec
| Nome | Descrição | Valor |
|---|---|---|
| caminho | O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e terminam com caráter universal (/path/*) | string |
| tipos | Lista do tipo espacial do caminho | Matriz de cadeia que contém qualquer um dos seguintes: 'LineString' "Multipolygon" "Ponto" 'Polígono' |
MaterializedViewDefinition
| Nome | Descrição | Valor |
|---|---|---|
| definição | A definição deve ser uma consulta SQL que seria utilizada para obter dados do contentor de origem para preencher no contentor da Vista Materializada. | cadeia (obrigatório) |
| sourceCollectionId | O nome do contentor de origem no qual a Vista Materializada será criada. | cadeia (obrigatório) |
ContainerPartitionKey
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Indica o tipo de algoritmo utilizado para a criação de partições. Para MultiHash, são suportadas várias chaves de partição (até três no máximo) para a criação de contentores | 'Hash' "MultiHash" "Intervalo" |
| caminhos | Lista de caminhos que utilizam os dados no contentor que podem ser particionados | cadeia[] |
| versão | Indica a versão da definição da chave de partição | int Restrições: Valor mínimo = 1 Valor máximo = 2 |
ResourceRestoreParameters
| Nome | Descrição | Valor |
|---|---|---|
| restoreSource | O ID da conta de base de dados recuperável a partir da qual o restauro tem de ser iniciado. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | Hora para a qual a conta tem de ser restaurada (formato ISO-8601). | string |
| restoreWithTtlDisabled | Especifica se a conta restaurada terá o Time-To-Live desativado após o restauro bem-sucedido. | bool |
UniqueKeyPolicy
| Nome | Descrição | Valor |
|---|---|---|
| uniqueKeys | Lista de chaves exclusivas que impõem a restrição de exclusividade em documentos na coleção no serviço Azure Cosmos DB. | UniqueKey[] |
UniqueKey
| Nome | Descrição | Valor |
|---|---|---|
| caminhos | A lista de caminhos tem de ser exclusiva para cada documento no serviço Azure Cosmos DB | cadeia[] |
Modelos de início rápido
Os seguintes modelos de início rápido implementam este tipo de recurso.
| Modelo | Description |
|---|---|
| Criar uma conta do Azure Cosmos DB de camada livre |
Este modelo cria uma conta do Azure Cosmos DB de escalão livre para a API SQL com uma base de dados com débito e contentor partilhados. |
| Criar uma conta do Azure Cosmos DB para a API Core (SQL) |
Este modelo cria uma API de conta do Azure Cosmos para Core (SQL) com uma base de dados e um contentor com débito com várias outras opções. |
| API SQL da conta do Azure Cosmos DB com arquivo analítico |
Este modelo cria uma API de conta do Azure Cosmos para Core (SQL) com uma base de dados e um contentor configurados com o arquivo analítico. |
| Criar uma API 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 uma base de dados e um contentor com débito 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 contentor com um procedimento armazenado, acionador e função definida pelo utilizador. |
| Implementar o Azure Data Explorer DB com a ligação do Cosmos DB |
Implementar o Azure Data Explorer DB com a ligação do Cosmos DB. |
Definição de recurso do Terraform (fornecedor AzAPI)
O tipo de recurso databaseAccounts/sqlDatabases/containers pode ser implementado com operações que visam:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo 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-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 (obrigatório) |
| localização | A localização do grupo de recursos ao qual o recurso pertence. | string |
| parent_id | O ID do recurso que é o principal para este recurso. | ID para recurso do tipo: sqlDatabases |
| etiquetas | As etiquetas são uma lista de pares chave-valor que descrevem o recurso. Estas etiquetas podem ser utilizadas na visualização e agrupamento deste recurso (entre grupos de recursos). Pode ser fornecido um máximo de 15 etiquetas para um recurso. Cada etiqueta tem de ter uma chave não superior a 128 carateres e um valor não superior a 256 carateres. Por exemplo, a experiência predefinida para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais "defaultExperience" também incluem "Tabela", "Graph", "DocumentDB" e "MongoDB". | Dicionário de nomes e valores de etiquetas. |
| identidade | Identidade do recurso. | ManagedServiceIdentity |
| propriedades | Propriedades para criar e atualizar o contentor do Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (obrigatório) |
ManagedServiceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned": o tipo de identidade utilizado para o recurso. O tipo "SystemAssigned,UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço. |
|
| identity_ids | A lista de identidades de utilizador associadas ao recurso. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | Matriz de IDs de identidade de utilizador. |
ManagedServiceIdentityUserAssignedIdentities
| Nome | Descrição | Valor |
|---|---|---|
| {customized property} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
| Nome | Descrição | Valor |
|---|---|---|
| opções | Um par de opções chave-valor a aplicar para o pedido. Isto corresponde aos cabeçalhos enviados com o pedido. | CreateUpdateOptionsOrSqlContainerGetPropertiesOption... |
| recurso | O formato JSON padrão de um contentor | SqlContainerResourceOrSqlContainerGetPropertiesResou... (obrigatório) |
CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
| Nome | Descrição | Valor |
|---|---|---|
| dimensionamento automáticoDefinições | Especifica as definições de Dimensionamento Automático. Nota: é necessário débito ou dimensionamento automáticoDefinições, mas não ambas. | Dimensionamento AutomáticoDefinições |
| de transferência de dados | Unidades de Pedido por segundo. Por exemplo, "débito": 10000. | int |
Dimensionamento AutomáticoDefinições
| Nome | Descrição | Valor |
|---|---|---|
| maxThroughput | Representa o débito máximo, o recurso pode aumentar verticalmente. | int |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| Nome | Descrição | Valor |
|---|---|---|
| analyticalStorageTtl | TTL Analítico. | int |
| clientEncryptionPolicy | A política de encriptação de cliente para o contentor. | ClientEncryptionPolicy |
| computedProperties | Lista de propriedades calculadas | ComputedProperty[] |
| conflictResolutionPolicy | A política de resolução de conflitos para o contentor. | ConflictResolutionPolicy |
| createMode | Enum para indicar o modo de criação de recursos. | "Predefinição" "PointInTimeRestore" "Restaurar" |
| defaultTtl | Tempo de vida predefinido | int |
| ID | Nome do contentor SQL do Cosmos DB | cadeia (obrigatório) |
| indexingPolicy | A configuração da política de indexação. Por predefinição, a indexação é automática para todos os caminhos de documentos no contentor | IndexingPolicy |
| materializedViewDefinition | A configuração para definir Vistas Materializadas. Esta ação tem de ser especificada apenas para criar um contentor de Vista Materializada. | MaterializedViewDefinition |
| partitionKey | A configuração da chave de partição a utilizar para a criação de partições de dados em múltiplas partições | ContainerPartitionKey |
| restoreParameters | Parâmetros para indicar as informações sobre o restauro | 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 |
ClientEncryptionPolicy
| Nome | Descrição | Valor |
|---|---|---|
| includedPaths | Caminhos do item que precisam de encriptação juntamente com definições específicas do caminho. | ClientEncryptionIncludedPath[] (obrigatório) |
| policyFormatVersion | Versão da definição da política de encriptação de cliente. As versões suportadas são 1 e 2. A versão 2 suporta encriptação de caminhos 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 Encriptação de Cliente a ser utilizada para encriptar o caminho. | cadeia (obrigatório) |
| encryptionAlgorithm | O algoritmo de encriptação que será utilizado. Por exemplo, AEAD_AES_256_CBC_HMAC_SHA256. | cadeia (obrigatório) |
| encryptionType | O tipo de encriptação a ser efetuada. Por exemplo- Determinista, Aleatório. | cadeia (obrigatório) |
| caminho | Caminho que precisa de ser encriptado. | cadeia (obrigatório) |
ComputedProperty
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome de uma propriedade calculada, por exemplo , "cp_lowerName" | string |
| query | A consulta que avalia o valor da propriedade calculada, 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 resolver 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 excluir da indexação | ExcludedPath[] |
| includedPaths | Lista de caminhos a incluir na indexação | IncludedPath[] |
| indexingMode | Indica o modo de indexação. | "consistente" "preguiçoso" "nenhum" |
| spatialIndexes | Lista de especificações espaciais | SpatialSpec[] |
CompositePath
| Nome | Descrição | Valor |
|---|---|---|
| order | Sequência de ordenação para caminhos compostos. | "ascendente" "descendente" |
| caminho | O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e terminam com caráter universal (/path/*) | string |
ExcludedPath
| Nome | Descrição | Valor |
|---|---|---|
| caminho | O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e terminam com caráter universal (/path/*) | string |
IncludedPath
| Nome | Descrição | Valor |
|---|---|---|
| índices | Lista de índices para este caminho | Índices[] |
| caminho | O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e terminam com caráter universal (/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" |
| tipo | Indica o tipo de índice. | "Hash" "Intervalo" "Espacial" |
| precisão | A precisão do índice. -1 é a precisão máxima. | int |
SpatialSpec
| Nome | Descrição | Valor |
|---|---|---|
| caminho | O caminho a que se aplica o comportamento de indexação. Normalmente, os caminhos de índice começam com raiz e terminam com caráter universal (/path/*) | string |
| tipos | Lista do tipo espacial do caminho | Matriz de cadeia que contém qualquer um dos seguintes: "LineString" "Multipolygon" "Ponto" "Polígono" |
MaterializedViewDefinition
| Nome | Descrição | Valor |
|---|---|---|
| definição | A definição deve ser uma consulta SQL que seria utilizada para obter dados do contentor de origem para preencher no contentor da Vista Materializada. | cadeia (obrigatório) |
| sourceCollectionId | O nome do contentor de origem no qual a Vista Materializada será criada. | cadeia (obrigatório) |
ContainerPartitionKey
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Indica o tipo de algoritmo utilizado para a criação de partições. Para MultiHash, são suportadas várias chaves de partição (até três no máximo) para a criação de contentores | "Hash" "MultiHash" "Intervalo" |
| caminhos | Lista de caminhos com os quais os dados no contentor podem ser particionados | string[] |
| versão | Indica a versão da definição da chave de partição | int Restrições: Valor mínimo = 1 Valor máximo = 2 |
ResourceRestoreParameters
| Nome | Descrição | Valor |
|---|---|---|
| restoreSource | O ID da conta de base de dados restabelecida a partir da qual o restauro tem de ser iniciado. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | Hora para a qual a conta tem de ser restaurada (formato ISO-8601). | string |
| restoreWithTtlDisabled | Especifica se a conta restaurada terá o Time-To-Live desativado após o restauro bem-sucedido. | bool |
UniqueKeyPolicy
| Nome | Descrição | Valor |
|---|---|---|
| uniqueKeys | Lista de chaves exclusivas que impõem a restrição de exclusividade em documentos na coleção no serviço Azure Cosmos DB. | UniqueKey[] |
UniqueKey
| Nome | Descrição | Valor |
|---|---|---|
| caminhos | A lista de caminhos tem de ser exclusiva para cada documento no serviço Azure Cosmos DB | string[] |
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários