Microsoft.DocumentDB mongoClusters 2023-11-15-preview
Definição de recurso do Bicep
O tipo de recurso mongoClusters 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/mongoClusters, adicione o Bicep a seguir ao modelo.
resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2023-11-15-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
administratorLogin: 'string'
administratorLoginPassword: 'string'
createMode: 'string'
nodeGroupSpecs: [
{
diskSizeGB: int
enableHa: bool
kind: 'Shard'
nodeCount: int
sku: 'string'
}
]
restoreParameters: {
pointInTimeUTC: 'string'
sourceResourceId: 'string'
}
serverVersion: 'string'
}
}
Valores de propriedade
mongoClusters
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome do recurso | cadeia de caracteres (obrigatório) |
| local | A localização geográfica em que o recurso reside | cadeia de caracteres (obrigatório) |
| marcas | Marcas de recurso. | Dicionário de nomes e valores de marcas. Confira Marcas em modelos |
| properties | Propriedades do cluster mongo. | MongoClusterProperties |
MongoClusterProperties
| Nome | Descrição | Valor |
|---|---|---|
| administratorLogin | O logon do administrador para o cluster mongo. | string |
| administratorLoginPassword | A senha do logon do administrador. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| createMode | O modo para criar um cluster mongo. | 'Padrão' 'PointInTimeRestore' 'Restore' |
| nodeGroupSpecs | A lista de especificações de grupo de nós no cluster. | NodeGroupSpec[] Restrições: Comprimento mínimo = 1 |
| restoreParameters | Parâmetros usados para operações de restauração | MongoClusterRestoreParameters |
| Versão do servidor | A versão do servidor Mongo DB. O padrão é a versão mais recente disponível, se não especificada. | string |
NodeGroupSpec
| Nome | Descrição | Valor |
|---|---|---|
| diskSizeGB | O tamanho do armazenamento em disco para o grupo de nós em GB. Valores de exemplo: 128, 256, 512, 1024. | INT |
| enableHa | Se a alta disponibilidade está habilitada no grupo de nós. | bool |
| kind | O tipo de nó implantado no grupo de nós. | 'Shard' |
| nodeCount | O número de nós no grupo de nós. | INT |
| sku | O sku de recurso para o grupo de nós. Isso define o tamanho da CPU e da memória provisionadas para cada nó. Valores de exemplo: 'M30', 'M40'. | string |
MongoClusterRestoreParameters
| Nome | Descrição | Valor |
|---|---|---|
| pointInTimeUTC | Ponto UTC no tempo para restaurar um cluster mongo | string |
| sourceResourceId | ID do recurso para localizar o cluster de origem a ser restaurado | string |
Definição de recurso de modelo do ARM
O tipo de recurso mongoClusters 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/mongoClusters, adicione o JSON a seguir ao modelo.
{
"type": "Microsoft.DocumentDB/mongoClusters",
"apiVersion": "2023-11-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"administratorLogin": "string",
"administratorLoginPassword": "string",
"createMode": "string",
"nodeGroupSpecs": [
{
"diskSizeGB": "int",
"enableHa": "bool",
"kind": "Shard",
"nodeCount": "int",
"sku": "string"
}
],
"restoreParameters": {
"pointInTimeUTC": "string",
"sourceResourceId": "string"
},
"serverVersion": "string"
}
}
Valores de propriedade
mongoClusters
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | 'Microsoft.DocumentDB/mongoClusters' |
| apiVersion | A versão da API do recurso | '2023-11-15-preview' |
| name | O nome do recurso | cadeia de caracteres (obrigatório) |
| local | A localização geográfica em que o recurso reside | cadeia de caracteres (obrigatório) |
| marcas | Marcas de recurso. | Dicionário de nomes e valores de marcas. Confira Marcas em modelos |
| properties | Propriedades do cluster mongo. | MongoClusterProperties |
MongoClusterProperties
| Nome | Descrição | Valor |
|---|---|---|
| administratorLogin | O logon do administrador para o cluster mongo. | string |
| administratorLoginPassword | A senha do logon do administrador. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| createMode | O modo para criar um cluster mongo. | 'Padrão' 'PointInTimeRestore' 'Restore' |
| nodeGroupSpecs | A lista de especificações de grupo de nós no cluster. | NodeGroupSpec[] Restrições: Comprimento mínimo = 1 |
| restoreParameters | Parâmetros usados para operações de restauração | MongoClusterRestoreParameters |
| Versão do servidor | A versão do servidor Mongo DB. O padrão é a versão mais recente disponível, se não especificada. | string |
NodeGroupSpec
| Nome | Descrição | Valor |
|---|---|---|
| diskSizeGB | O tamanho do armazenamento em disco para o grupo de nós em GB. Valores de exemplo: 128, 256, 512, 1024. | INT |
| enableHa | Se a alta disponibilidade está habilitada no grupo de nós. | bool |
| kind | O tipo de nó implantado no grupo de nós. | 'Shard' |
| nodeCount | O número de nós no grupo de nós. | INT |
| sku | O sku de recurso para o grupo de nós. Isso define o tamanho da CPU e da memória provisionadas para cada nó. Valores de exemplo: 'M30', 'M40'. | string |
MongoClusterRestoreParameters
| Nome | Descrição | Valor |
|---|---|---|
| pointInTimeUTC | Ponto UTC no tempo para restaurar um cluster mongo | string |
| sourceResourceId | ID do recurso para localizar o cluster de origem a ser restaurado | string |
Definição de recurso do Terraform (provedor de AzAPI)
O tipo de recurso mongoClusters 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/mongoClusters, adicione o Terraform a seguir ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/mongoClusters@2023-11-15-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
administratorLogin = "string"
administratorLoginPassword = "string"
createMode = "string"
nodeGroupSpecs = [
{
diskSizeGB = int
enableHa = bool
kind = "Shard"
nodeCount = int
sku = "string"
}
]
restoreParameters = {
pointInTimeUTC = "string"
sourceResourceId = "string"
}
serverVersion = "string"
}
})
}
Valores de propriedade
mongoClusters
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.DocumentDB/mongoClusters@2023-11-15-preview" |
| name | O nome do recurso | cadeia de caracteres (obrigatório) |
| local | A localização geográfica em que o recurso reside | cadeia de caracteres (obrigatório) |
| parent_id | Para implantar em um grupo de recursos, use a ID desse grupo de recursos. | cadeia de caracteres (obrigatório) |
| marcas | Marcas de recurso. | Dicionário de nomes e valores de marcas. |
| properties | Propriedades do cluster mongo. | MongoClusterProperties |
MongoClusterProperties
| Nome | Descrição | Valor |
|---|---|---|
| administratorLogin | O logon do administrador para o cluster mongo. | string |
| administratorLoginPassword | A senha do logon do administrador. | string Restrições: Valor confidencial. Passe como um parâmetro seguro. |
| createMode | O modo para criar um cluster mongo. | "Padrão" "PointInTimeRestore" "Restaurar" |
| nodeGroupSpecs | A lista de especificações de grupo de nós no cluster. | NodeGroupSpec[] Restrições: Comprimento mínimo = 1 |
| restoreParameters | Parâmetros usados para operações de restauração | MongoClusterRestoreParameters |
| Versão do servidor | A versão do servidor do Mongo DB. O padrão será a versão mais recente disponível, se não for especificada. | string |
NodeGroupSpec
| Nome | Descrição | Valor |
|---|---|---|
| diskSizeGB | O tamanho do armazenamento em disco para o grupo de nós em GB. Valores de exemplo: 128, 256, 512, 1024. | INT |
| enableHa | Se a alta disponibilidade está habilitada no grupo de nós. | bool |
| kind | O tipo de nó implantado no grupo de nós. | "Fragmento" |
| nodeCount | O número de nós no grupo de nós. | INT |
| sku | O sku de recursos para o grupo de nós. Isso define o tamanho da CPU e da memória provisionadas para cada nó. Valores de exemplo: 'M30', 'M40'. | string |
MongoClusterRestoreParameters
| Nome | Descrição | Valor |
|---|---|---|
| pointInTimeUTC | Ponto UTC no tempo para restaurar um cluster mongo | string |
| sourceResourceId | ID do recurso para localizar o cluster de origem a ser restaurado | string |