Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers 2023-09-15-preview
- última
- 2024-12-01-preview
- 2024-11-15
- 2024-09-01-preview
- 2024-08-15
- 2024-05-15
- 2024-05-15-preview
- 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
- 2021-01-15
- 2020-09-01
- 2020-06-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 implantado com operações de destino:
- Grupos de recursos - Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers, adicione o Bicep a seguir ao seu modelo.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-09-15-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
}
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'
}
uniqueKeyPolicy: {
uniqueKeys: [
{
paths: [
'string'
]
}
]
}
}
}
tags: {
{customized property}: 'string'
}
}
Valores de propriedade
AutoscaleSettings
Nome | Descrição | Valor |
---|---|---|
maxThroughput | Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente. | int |
ClientEncryptionIncludedPath
Nome | Descrição | Valor |
---|---|---|
clientEncryptionKeyId | O identificador da Chave de Criptografia do Cliente a ser usado para criptografar o caminho. | cadeia de caracteres (obrigatório) |
encryptionAlgorithm | O algoritmo de criptografia que será usado. Por exemplo, AEAD_AES_256_CBC_HMAC_SHA256. | cadeia de caracteres (obrigatório) |
encryptionType | O tipo de criptografia a ser executada. Por exemplo, determinística, aleatória. | cadeia de caracteres (obrigatório) |
caminho | Caminho que precisa ser criptografado. | cadeia de caracteres (obrigatório) |
ClientEncryptionPolicy
Nome | Descrição | Valor |
---|---|---|
includedPaths | Caminhos do item que precisam de criptografia junto com as configurações específicas do caminho. | ClientEncryptionIncludedPath[] (obrigatório) |
policyFormatVersion | Versão da definição da política de criptografia do cliente. As versões com suporte são 1 e 2. A versão 2 dá suporte à criptografia de caminho de chave de id e partição. | int Restrições: Valor mínimo = 1 Valor máximo = 2 (obrigatório) |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
Nome | Descrição | Valor |
---|
CompositePath
Nome | Descrição | Valor |
---|---|---|
ordem | Ordem de classificação para caminhos compostos. | 'crescente' 'decrescente' |
caminho | O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) | corda |
ConflictResolutionPolicy
Nome | Descrição | Valor |
---|---|---|
conflictResolutionPath | O caminho de resolução de conflitos no caso do modo LastWriterWins. | corda |
conflictResolutionProcedure | O procedimento para resolver conflitos no caso do modo personalizado. | corda |
modo | Indica o modo de resolução de conflitos. | 'Personalizado' 'LastWriterWins' |
ContainerPartitionKey
Nome | Descrição | Valor |
---|---|---|
tipo | Indica o tipo de algoritmo usado para particionamento. Para MultiHash, há suporte para várias chaves de partição (até três no máximo) para criação de contêiner | 'Hash' 'MultiHash' 'Range' |
Caminhos | Lista de caminhos usando quais dados dentro do contêiner podem ser particionados | string[] |
Versão | Indica a versão da definição da chave de partição | int Restrições: Valor mínimo = 1 Valor máximo = 2 |
CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
ExcludedPath
Nome | Descrição | Valor |
---|---|---|
caminho | O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) | corda |
IncludedPath
Índices
Nome | Descrição | Valor |
---|---|---|
Datatype | O tipo de dados ao qual o comportamento de indexação é aplicado. | 'LineString' 'MultiPolygon' 'Número' 'Point' 'Polígono' 'String' |
tipo | Indica o tipo de índice. | 'Hash' 'Range' 'Espacial' |
precisão | A precisão do índice. -1 é precisão máxima. | int |
IndexingPolicy
ManagedServiceIdentity
Nome | 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 'None' removerá as identidades do serviço. | 'None' '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 do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
Nome | Descrição | Valor |
---|
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 para preencher no contêiner de 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) |
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers
Nome | Descrição | Valor |
---|---|---|
identidade | Identidade do recurso. | ManagedServiceIdentity |
localização | O local do grupo de recursos ao qual o recurso pertence. | corda |
nome | O nome do recurso | cadeia de caracteres (obrigatório) |
pai | No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai. Para obter mais informações, consulte recurso filho fora do recurso pai. |
Nome simbólico para o recurso do tipo: databaseAccounts/sqlDatabases |
Propriedades | Propriedades para criar e atualizar o contêiner do Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (obrigatório) |
Tags | Marcas de recurso | Dicionário de nomes e valores de marca. Consulte Marcas em modelos |
ResourceRestoreParameters
Nome | Descrição | Valor |
---|---|---|
restoreSource | A ID da conta de banco de dados restaurável da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | corda |
restoreTimestampInUtc | Tempo para o qual a conta precisa ser restaurada (formato ISO-8601). | corda |
SpatialSpec
Nome | Descrição | Valor |
---|---|---|
caminho | O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) | corda |
Tipos | Lista do tipo espacial do caminho | Matriz de cadeia de caracteres que contém qualquer um dos: 'LineString' 'MultiPolygon' 'Point' 'Polígono' |
SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties
Nome | Descrição | Valor |
---|---|---|
Opções | Um par de opções chave-valor a ser aplicado à solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. | CreateUpdateOptionsOrSqlContainerGetPropertiesOptions |
recurso | O formato JSON padrão de um contêiner | sqlContainerResourceOrSqlContainerGetPropertiesResource (obrigatório) |
SqlContainerResourceOrSqlContainerGetPropertiesResource
Nome | Descrição | Valor |
---|---|---|
analyticalStorageTtl | TTL analítico. | int |
clientEncryptionPolicy | A política de criptografia do cliente para o contêiner. | ClientEncryptionPolicy |
conflictResolutionPolicy | A política de resolução de conflitos para o contêiner. | |
createMode | Enumerar 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 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 a criação de 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 | |
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 |
Tags
Nome | Descrição | Valor |
---|
UniqueKey
Nome | Descrição | Valor |
---|---|---|
Caminhos | A lista de caminhos deve ser exclusiva para cada documento no serviço do Azure Cosmos DB | string[] |
UniqueKeyPolicy
Nome | Descrição | Valor |
---|---|---|
uniqueKeys | Lista de chaves exclusivas que impõem restrição de exclusividade em documentos na coleção no serviço do Azure Cosmos DB. | UniqueKey [] |
Exemplos de início rápido
Os exemplos de início rápido a seguir implantam esse tipo de recurso.
Arquivo Bicep | Descrição |
---|---|
API do SQL da conta do Azure Cosmos DB com o repositório analítico | Esse modelo cria uma conta do Azure Cosmos para a API do Core (SQL) com um banco de dados e um contêiner configurados com o repositório analítico. |
Criar uma conta do Azure Cosmos DB de camada gratuita | Esse modelo cria uma conta do Azure Cosmos DB de camada livre para a API do SQL com um banco de dados com taxa de transferência e contêiner compartilhados. |
Criar uma conta do Azure Cosmos DB para a API do Core (SQL) | Esse modelo cria uma conta do Azure Cosmos para a API do Core (SQL) com um banco de dados e um contêiner com taxa de transferência com várias outras opções. |
Criar uma API SQL de conta do Azure Cosmos DB com de dimensionamento automático | Esse modelo cria uma conta do Azure Cosmos para a API do Core (SQL) com um banco de dados e um contêiner com taxa de transferência de dimensionamento automático com várias outras opções. |
Criar procedimentos armazenados da API do SQL (Azure Cosmos DB Core) | Esse modelo cria uma conta do Azure Cosmos DB para a API do Core (SQL) e um contêiner com um procedimento armazenado, gatilho e função definida pelo usuário. |
cria um aplicativo de microsserviços da Dapr usando aplicativos de contêiner | Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner. |
Cria um aplicativo dapr pub-sub servicebus usando aplicativos de contêiner | Crie um aplicativo dapr pub-sub servicebus usando Aplicativos de Contêiner. |
implantar o BD do Azure Data Explorer com a conexão do Cosmos DB | Implantar o BD do Azure Data Explorer com a conexão do Cosmos DB. |
Definição de recurso de modelo do ARM
O tipo de recurso databaseAccounts/sqlDatabases/containers pode ser implantado com operações de destino:
- Grupos de recursos - Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers, adicione o JSON a seguir ao modelo.
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
"apiVersion": "2023-09-15-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"
},
"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"
},
"uniqueKeyPolicy": {
"uniqueKeys": [
{
"paths": [ "string" ]
}
]
}
}
},
"tags": {
"{customized property}": "string"
}
}
Valores de propriedade
AutoscaleSettings
Nome | Descrição | Valor |
---|---|---|
maxThroughput | Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente. | int |
ClientEncryptionIncludedPath
Nome | Descrição | Valor |
---|---|---|
clientEncryptionKeyId | O identificador da Chave de Criptografia do Cliente a ser usado para criptografar o caminho. | cadeia de caracteres (obrigatório) |
encryptionAlgorithm | O algoritmo de criptografia que será usado. Por exemplo, AEAD_AES_256_CBC_HMAC_SHA256. | cadeia de caracteres (obrigatório) |
encryptionType | O tipo de criptografia a ser executada. Por exemplo, determinística, aleatória. | cadeia de caracteres (obrigatório) |
caminho | Caminho que precisa ser criptografado. | cadeia de caracteres (obrigatório) |
ClientEncryptionPolicy
Nome | Descrição | Valor |
---|---|---|
includedPaths | Caminhos do item que precisam de criptografia junto com as configurações específicas do caminho. | ClientEncryptionIncludedPath[] (obrigatório) |
policyFormatVersion | Versão da definição da política de criptografia do cliente. As versões com suporte são 1 e 2. A versão 2 dá suporte à criptografia de caminho de chave de id e partição. | int Restrições: Valor mínimo = 1 Valor máximo = 2 (obrigatório) |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
Nome | Descrição | Valor |
---|
CompositePath
Nome | Descrição | Valor |
---|---|---|
ordem | Ordem de classificação para caminhos compostos. | 'crescente' 'decrescente' |
caminho | O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) | corda |
ConflictResolutionPolicy
Nome | Descrição | Valor |
---|---|---|
conflictResolutionPath | O caminho de resolução de conflitos no caso do modo LastWriterWins. | corda |
conflictResolutionProcedure | O procedimento para resolver conflitos no caso do modo personalizado. | corda |
modo | Indica o modo de resolução de conflitos. | 'Personalizado' 'LastWriterWins' |
ContainerPartitionKey
Nome | Descrição | Valor |
---|---|---|
tipo | Indica o tipo de algoritmo usado para particionamento. Para MultiHash, há suporte para várias chaves de partição (até três no máximo) para criação de contêiner | 'Hash' 'MultiHash' 'Range' |
Caminhos | Lista de caminhos usando quais dados dentro do contêiner podem ser particionados | string[] |
Versão | Indica a versão da definição da chave de partição | int Restrições: Valor mínimo = 1 Valor máximo = 2 |
CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
ExcludedPath
Nome | Descrição | Valor |
---|---|---|
caminho | O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) | corda |
IncludedPath
Índices
Nome | Descrição | Valor |
---|---|---|
Datatype | O tipo de dados ao qual o comportamento de indexação é aplicado. | 'LineString' 'MultiPolygon' 'Número' 'Point' 'Polígono' 'String' |
tipo | Indica o tipo de índice. | 'Hash' 'Range' 'Espacial' |
precisão | A precisão do índice. -1 é precisão máxima. | int |
IndexingPolicy
ManagedServiceIdentity
Nome | 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 'None' removerá as identidades do serviço. | 'None' '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 do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
Nome | Descrição | Valor |
---|
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 para preencher no contêiner de 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) |
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers
Nome | Descrição | Valor |
---|---|---|
apiVersion | A versão da API | '2023-09-15-preview' |
identidade | Identidade do recurso. | ManagedServiceIdentity |
localização | O local do grupo de recursos ao qual o recurso pertence. | corda |
nome | O nome do recurso | cadeia de caracteres (obrigatório) |
Propriedades | Propriedades para criar e atualizar o contêiner do Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (obrigatório) |
Tags | Marcas de recurso | Dicionário de nomes e valores de marca. Consulte Marcas em modelos |
tipo | O tipo de recurso | 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers' |
ResourceRestoreParameters
Nome | Descrição | Valor |
---|---|---|
restoreSource | A ID da conta de banco de dados restaurável da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | corda |
restoreTimestampInUtc | Tempo para o qual a conta precisa ser restaurada (formato ISO-8601). | corda |
SpatialSpec
Nome | Descrição | Valor |
---|---|---|
caminho | O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) | corda |
Tipos | Lista do tipo espacial do caminho | Matriz de cadeia de caracteres que contém qualquer um dos: 'LineString' 'MultiPolygon' 'Point' 'Polígono' |
SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties
Nome | Descrição | Valor |
---|---|---|
Opções | Um par de opções chave-valor a ser aplicado à solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. | CreateUpdateOptionsOrSqlContainerGetPropertiesOptions |
recurso | O formato JSON padrão de um contêiner | sqlContainerResourceOrSqlContainerGetPropertiesResource (obrigatório) |
SqlContainerResourceOrSqlContainerGetPropertiesResource
Nome | Descrição | Valor |
---|---|---|
analyticalStorageTtl | TTL analítico. | int |
clientEncryptionPolicy | A política de criptografia do cliente para o contêiner. | ClientEncryptionPolicy |
conflictResolutionPolicy | A política de resolução de conflitos para o contêiner. | |
createMode | Enumerar 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 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 a criação de 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 | |
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 |
Tags
Nome | Descrição | Valor |
---|
UniqueKey
Nome | Descrição | Valor |
---|---|---|
Caminhos | A lista de caminhos deve ser exclusiva para cada documento no serviço do Azure Cosmos DB | string[] |
UniqueKeyPolicy
Nome | Descrição | Valor |
---|---|---|
uniqueKeys | Lista de chaves exclusivas que impõem restrição de exclusividade em documentos na coleção no serviço do Azure Cosmos DB. | UniqueKey [] |
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
Modelo | Descrição |
---|---|
API do SQL da conta do Azure Cosmos DB com o repositório analítico |
Esse modelo cria uma conta do Azure Cosmos para a API do Core (SQL) com um banco de dados e um contêiner configurados com o repositório analítico. |
Criar uma conta do Azure Cosmos DB de camada gratuita |
Esse modelo cria uma conta do Azure Cosmos DB de camada livre para a API do SQL com um banco de dados com taxa de transferência e contêiner compartilhados. |
Criar uma conta do Azure Cosmos DB para a API do Core (SQL) |
Esse modelo cria uma conta do Azure Cosmos para a API do Core (SQL) com um banco de dados e um contêiner com taxa de transferência com várias outras opções. |
Criar uma API SQL de conta do Azure Cosmos DB com de dimensionamento automático |
Esse modelo cria uma conta do Azure Cosmos para a API do Core (SQL) com um banco de dados e um contêiner com taxa de transferência de dimensionamento automático com várias outras opções. |
Criar procedimentos armazenados da API do SQL (Azure Cosmos DB Core) |
Esse modelo cria uma conta do Azure Cosmos DB para a API do Core (SQL) e um contêiner com um procedimento armazenado, gatilho e função definida pelo usuário. |
cria um aplicativo de microsserviços da Dapr usando aplicativos de contêiner |
Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner. |
Cria um aplicativo dapr pub-sub servicebus usando aplicativos de contêiner |
Crie um aplicativo dapr pub-sub servicebus usando Aplicativos de Contêiner. |
implantar o BD do Azure Data Explorer com a conexão do Cosmos DB |
Implantar o BD do Azure Data Explorer com a conexão do Cosmos DB. |
Definição de recurso do Terraform (provedor de AzAPI)
O tipo de recurso databaseAccounts/sqlDatabases/containers pode ser implantado com operações de destino:
- grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers, adicione o Terraform a seguir ao modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-09-15-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
}
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"
}
uniqueKeyPolicy = {
uniqueKeys = [
{
paths = [
"string"
]
}
]
}
}
}
})
}
Valores de propriedade
AutoscaleSettings
Nome | Descrição | Valor |
---|---|---|
maxThroughput | Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente. | int |
ClientEncryptionIncludedPath
Nome | Descrição | Valor |
---|---|---|
clientEncryptionKeyId | O identificador da Chave de Criptografia do Cliente a ser usado para criptografar o caminho. | cadeia de caracteres (obrigatório) |
encryptionAlgorithm | O algoritmo de criptografia que será usado. Por exemplo, AEAD_AES_256_CBC_HMAC_SHA256. | cadeia de caracteres (obrigatório) |
encryptionType | O tipo de criptografia a ser executada. Por exemplo, determinística, aleatória. | cadeia de caracteres (obrigatório) |
caminho | Caminho que precisa ser criptografado. | cadeia de caracteres (obrigatório) |
ClientEncryptionPolicy
Nome | Descrição | Valor |
---|---|---|
includedPaths | Caminhos do item que precisam de criptografia junto com as configurações específicas do caminho. | ClientEncryptionIncludedPath[] (obrigatório) |
policyFormatVersion | Versão da definição da política de criptografia do cliente. As versões com suporte são 1 e 2. A versão 2 dá suporte à criptografia de caminho de chave de id e partição. | int Restrições: Valor mínimo = 1 Valor máximo = 2 (obrigatório) |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
Nome | Descrição | Valor |
---|
CompositePath
Nome | Descrição | Valor |
---|---|---|
ordem | Ordem de classificação para caminhos compostos. | 'crescente' 'decrescente' |
caminho | O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) | corda |
ConflictResolutionPolicy
Nome | Descrição | Valor |
---|---|---|
conflictResolutionPath | O caminho de resolução de conflitos no caso do modo LastWriterWins. | corda |
conflictResolutionProcedure | O procedimento para resolver conflitos no caso do modo personalizado. | corda |
modo | Indica o modo de resolução de conflitos. | 'Personalizado' 'LastWriterWins' |
ContainerPartitionKey
Nome | Descrição | Valor |
---|---|---|
tipo | Indica o tipo de algoritmo usado para particionamento. Para MultiHash, há suporte para várias chaves de partição (até três no máximo) para criação de contêiner | 'Hash' 'MultiHash' 'Range' |
Caminhos | Lista de caminhos usando quais dados dentro do contêiner podem ser particionados | string[] |
Versão | Indica a versão da definição da chave de partição | int Restrições: Valor mínimo = 1 Valor máximo = 2 |
CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
ExcludedPath
Nome | Descrição | Valor |
---|---|---|
caminho | O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) | corda |
IncludedPath
Índices
Nome | Descrição | Valor |
---|---|---|
Datatype | O tipo de dados ao qual o comportamento de indexação é aplicado. | 'LineString' 'MultiPolygon' 'Número' 'Point' 'Polígono' 'String' |
tipo | Indica o tipo de índice. | 'Hash' 'Range' 'Espacial' |
precisão | A precisão do índice. -1 é precisão máxima. | int |
IndexingPolicy
ManagedServiceIdentity
Nome | 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 'None' removerá as identidades do serviço. | 'None' '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 do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
Nome | Descrição | Valor |
---|
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 para preencher no contêiner de 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) |
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers
Nome | Descrição | Valor |
---|---|---|
identidade | Identidade do recurso. | ManagedServiceIdentity |
localização | O local do grupo de recursos ao qual o recurso pertence. | corda |
nome | O nome do recurso | cadeia de caracteres (obrigatório) |
parent_id | A ID do recurso que é o pai desse recurso. | ID do recurso do tipo: databaseAccounts/sqlDatabases |
Propriedades | Propriedades para criar e atualizar o contêiner do Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (obrigatório) |
Tags | Marcas de recurso | Dicionário de nomes e valores de marca. |
tipo | O tipo de recurso | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-09-15-preview" |
ResourceRestoreParameters
Nome | Descrição | Valor |
---|---|---|
restoreSource | A ID da conta de banco de dados restaurável da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | corda |
restoreTimestampInUtc | Tempo para o qual a conta precisa ser restaurada (formato ISO-8601). | corda |
SpatialSpec
Nome | Descrição | Valor |
---|---|---|
caminho | O caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice normalmente começam com raiz e terminam com curinga (/path/*) | corda |
Tipos | Lista do tipo espacial do caminho | Matriz de cadeia de caracteres que contém qualquer um dos: 'LineString' 'MultiPolygon' 'Point' 'Polígono' |
SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties
Nome | Descrição | Valor |
---|---|---|
Opções | Um par de opções chave-valor a ser aplicado à solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. | CreateUpdateOptionsOrSqlContainerGetPropertiesOptions |
recurso | O formato JSON padrão de um contêiner | sqlContainerResourceOrSqlContainerGetPropertiesResource (obrigatório) |
SqlContainerResourceOrSqlContainerGetPropertiesResource
Nome | Descrição | Valor |
---|---|---|
analyticalStorageTtl | TTL analítico. | int |
clientEncryptionPolicy | A política de criptografia do cliente para o contêiner. | ClientEncryptionPolicy |
conflictResolutionPolicy | A política de resolução de conflitos para o contêiner. | |
createMode | Enumerar 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 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 a criação de 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 | |
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 |
Tags
Nome | Descrição | Valor |
---|
UniqueKey
Nome | Descrição | Valor |
---|---|---|
Caminhos | A lista de caminhos deve ser exclusiva para cada documento no serviço do Azure Cosmos DB | string[] |
UniqueKeyPolicy
Nome | Descrição | Valor |
---|---|---|
uniqueKeys | Lista de chaves exclusivas que impõem restrição de exclusividade em documentos na coleção no serviço do Azure Cosmos DB. | UniqueKey [] |