Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2021-06-15
Artigo 12/19/2024
2 contribuidores
Comentários
Neste artigo
Definição de recursos do bíceps
O tipo de recurso databaseAccounts/mongodbDatabases/collections pode ser implantado com operações que visam:
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações .
Para criar um recurso Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-06-15' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
analyticalStorageTtl: int
id: 'string'
indexes: [
{
key: {
keys: [
'string'
]
}
options: {
expireAfterSeconds: int
unique: bool
}
}
]
shardKey: {
{customized property}: 'string'
}
}
}
tags: {
{customized property}: 'string'
}
}
Valores de propriedade
AutoscaleSettings
Designação
Descrição
Valor
maxTaxa de transferência
Representa a taxa de transferência máxima, até a qual o recurso pode ser dimensionado.
Int
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
Designação
Descrição
Valor
autoscaleConfigurações
Especifica as configurações de dimensionamento automático.
AutoscaleSettings
taxa de transferência
Solicite unidades por segundo. Por exemplo, "taxa de transferência": 10000.
Int
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
Designação
Descrição
Valor
analíticoStorageTtl
TTL analítico.
Int
ID
Nome da coleção Cosmos DB MongoDB
string (obrigatório)
índices
Lista de chaves de índice
MongoIndex []
Chave de fragmento
Um par chave-valor de chaves de estilhaços a ser aplicado para a solicitação.
ShardKeys
MongoIndex
Designação
Descrição
Valor
chave
Chaves de índice de coleção MongoDB do Cosmos DB
MongoIndexKeys
Opções
Opções de chave de índice da coleção MongoDB do Cosmos DB
MongoIndexOptions
MongoIndexKeys
Designação
Descrição
Valor
Teclas
Lista de chaves para cada coleção MongoDB no serviço Azure Cosmos DB
string[]
MongoIndexOptions
Designação
Descrição
Valor
expirarAfterSeconds
Expirar após segundos
Int
único
É único ou não
Bool
ShardKeys
Designação
Descrição
Valor
Designação
Descrição
Valor
Exemplos de início rápido
Os exemplos de início rápido a seguir implantam esse tipo de recurso.
Arquivo Bicep
Descrição
Criar uma conta do Azure Cosmos para a API do MongoDB
Este modelo cria uma conta do Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões usando a taxa de transferência compartilhada e dedicada com duas coleções.
Criar uma conta do Azure Cosmos para o de dimensionamento automático da API do MongoDB
Este modelo cria uma conta do Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões usando a taxa de transferência de escala automática compartilhada e dedicada.
Definição de recurso de modelo ARM
O tipo de recurso databaseAccounts/mongodbDatabases/collections pode ser implantado com operações que visam:
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações .
Para criar um recurso Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
"apiVersion": "2021-06-15",
"name": "string",
"location": "string",
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"analyticalStorageTtl": "int",
"id": "string",
"indexes": [
{
"key": {
"keys": [ "string" ]
},
"options": {
"expireAfterSeconds": "int",
"unique": "bool"
}
}
],
"shardKey": {
"{customized property}": "string"
}
}
},
"tags": {
"{customized property}": "string"
}
}
Valores de propriedade
AutoscaleSettings
Designação
Descrição
Valor
maxTaxa de transferência
Representa a taxa de transferência máxima, até a qual o recurso pode ser dimensionado.
Int
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
Designação
Descrição
Valor
autoscaleConfigurações
Especifica as configurações de dimensionamento automático.
AutoscaleSettings
taxa de transferência
Solicite unidades por segundo. Por exemplo, "taxa de transferência": 10000.
Int
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
Designação
Descrição
Valor
apiVersion
A versão api
'2021-06-15'
Localização
O local do grupo de recursos ao qual o recurso pertence.
string
Designação
O nome do recurso
string (obrigatório)
propriedades
Propriedades para criar e atualizar a coleção MongoDB do Azure Cosmos DB.
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (obrigatório)
Etiquetas
Tags de recursos
Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo
O tipo de recurso
'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections'
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
Designação
Descrição
Valor
analíticoStorageTtl
TTL analítico.
Int
ID
Nome da coleção Cosmos DB MongoDB
string (obrigatório)
índices
Lista de chaves de índice
MongoIndex []
Chave de fragmento
Um par chave-valor de chaves de estilhaços a ser aplicado para a solicitação.
ShardKeys
MongoIndex
Designação
Descrição
Valor
chave
Chaves de índice de coleção MongoDB do Cosmos DB
MongoIndexKeys
Opções
Opções de chave de índice da coleção MongoDB do Cosmos DB
MongoIndexOptions
MongoIndexKeys
Designação
Descrição
Valor
Teclas
Lista de chaves para cada coleção MongoDB no serviço Azure Cosmos DB
string[]
MongoIndexOptions
Designação
Descrição
Valor
expirarAfterSeconds
Expirar após segundos
Int
único
É único ou não
Bool
ShardKeys
Designação
Descrição
Valor
Designação
Descrição
Valor
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 do Azure Cosmos para a API do MongoDB
Este modelo cria uma conta do Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões usando a taxa de transferência compartilhada e dedicada com duas coleções.
Criar uma conta do Azure Cosmos para o de dimensionamento automático da API do MongoDB
Este modelo cria uma conta do Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões usando a taxa de transferência de escala automática compartilhada e dedicada.
O tipo de recurso databaseAccounts/mongodbDatabases/collections pode ser implantado com operações que visam:
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações .
Para criar um recurso Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-06-15"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
options = {
autoscaleSettings = {
maxThroughput = int
}
throughput = int
}
resource = {
analyticalStorageTtl = int
id = "string"
indexes = [
{
key = {
keys = [
"string"
]
}
options = {
expireAfterSeconds = int
unique = bool
}
}
]
shardKey = {
{customized property} = "string"
}
}
}
})
}
Valores de propriedade
AutoscaleSettings
Designação
Descrição
Valor
maxTaxa de transferência
Representa a taxa de transferência máxima, até a qual o recurso pode ser dimensionado.
Int
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
Designação
Descrição
Valor
autoscaleConfigurações
Especifica as configurações de dimensionamento automático.
AutoscaleSettings
taxa de transferência
Solicite unidades por segundo. Por exemplo, "taxa de transferência": 10000.
Int
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
Designação
Descrição
Valor
Localização
O local do grupo de recursos ao qual o recurso pertence.
string
Designação
O nome do recurso
string (obrigatório)
parent_id
A ID do recurso que é o pai para este recurso.
ID para recurso do tipo: databaseAccounts/mongodbDatabases
propriedades
Propriedades para criar e atualizar a coleção MongoDB do Azure Cosmos DB.
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (obrigatório)
Etiquetas
Tags de recursos
Dicionário de nomes e valores de tags.
tipo
O tipo de recurso
"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-06-15"
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
Designação
Descrição
Valor
analíticoStorageTtl
TTL analítico.
Int
ID
Nome da coleção Cosmos DB MongoDB
string (obrigatório)
índices
Lista de chaves de índice
MongoIndex []
Chave de fragmento
Um par chave-valor de chaves de estilhaços a ser aplicado para a solicitação.
ShardKeys
MongoIndex
Designação
Descrição
Valor
chave
Chaves de índice de coleção MongoDB do Cosmos DB
MongoIndexKeys
Opções
Opções de chave de índice da coleção MongoDB do Cosmos DB
MongoIndexOptions
MongoIndexKeys
Designação
Descrição
Valor
Teclas
Lista de chaves para cada coleção MongoDB no serviço Azure Cosmos DB
string[]
MongoIndexOptions
Designação
Descrição
Valor
expirarAfterSeconds
Expirar após segundos
Int
único
É único ou não
Bool
ShardKeys
Designação
Descrição
Valor
Designação
Descrição
Valor