Microsoft.DocumentDB mongoClusters 2023-09-15-preview
Definição de recurso do Bicep
O tipo de recurso mongoClusters 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/mongoClusters, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2023-09-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 (obrigatório) |
| localização | A localização geográfica onde o recurso se encontra | cadeia (obrigatório) |
| etiquetas | Etiquetas de recursos. | Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos |
| propriedades | Propriedades do cluster do mongo. | MongoClusterProperties |
MongoClusterProperties
| Nome | Descrição | Valor |
|---|---|---|
| administratorLogin | O início de sessão do administrador para o cluster do mongo. | string |
| administratorLoginPassword | A palavra-passe do início de sessão do administrador. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| createMode | O modo para criar um cluster do mongo. | 'Predefinição' 'PointInTimeRestore' "Restaurar" |
| nodeGroupSpecs | A lista de especificações do grupo de nós no cluster. | NodeGroupSpec[] Restrições: Comprimento mínimo = 1 |
| restoreParameters | Parâmetros utilizados para operações de restauro | MongoClusterRestoreParameters |
| serverVersion | A versão do servidor do Mongo DB. A predefinição é a versão mais recente disponível, se não for especificada. | string |
NodeGroupSpec
| Nome | Descrição | Valor |
|---|---|---|
| diskSizeGB | O tamanho de armazenamento do disco para o grupo de nós em GB. Valores de exemplo: 128, 256, 512, 1024. | int |
| enableHa | Se a elevada disponibilidade está ativada no grupo de nós. | bool |
| tipo | O tipo de nó implementado 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. Isto define o tamanho da CPU e da memória que é aprovisionada para cada nó. Valores de exemplo: "M30", "M40". | string |
MongoClusterRestoreParameters
| Nome | Descrição | Valor |
|---|---|---|
| pointInTimeUTC | PONTO UTC no tempo para restaurar um cluster do mongo | string |
| sourceResourceId | ID do Recurso para localizar o cluster de origem a restaurar | string |
Definição de recurso de modelo do ARM
O tipo de recurso mongoClusters 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/mongoClusters, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.DocumentDB/mongoClusters",
"apiVersion": "2023-09-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 de recursos | "2023-09-15-preview" |
| name | O nome do recurso | cadeia (obrigatório) |
| localização | A localização geográfica onde o recurso se encontra | cadeia (obrigatório) |
| etiquetas | Etiquetas de recursos. | Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos |
| propriedades | Propriedades do cluster do mongo. | MongoClusterProperties |
MongoClusterProperties
| Nome | Descrição | Valor |
|---|---|---|
| administratorLogin | O início de sessão do administrador para o cluster do mongo. | string |
| administratorLoginPassword | A palavra-passe do início de sessão do administrador. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| createMode | O modo para criar um cluster do mongo. | 'Predefinição' 'PointInTimeRestore' "Restaurar" |
| nodeGroupSpecs | A lista de especificações do grupo de nós no cluster. | NodeGroupSpec[] Restrições: Comprimento mínimo = 1 |
| restoreParameters | Parâmetros utilizados para operações de restauro | MongoClusterRestoreParameters |
| serverVersion | A versão do servidor do Mongo DB. A predefinição é a versão mais recente disponível, se não for especificada. | string |
NodeGroupSpec
| Nome | Descrição | Valor |
|---|---|---|
| diskSizeGB | O tamanho de armazenamento do disco para o grupo de nós em GB. Valores de exemplo: 128, 256, 512, 1024. | int |
| enableHa | Se a elevada disponibilidade está ativada no grupo de nós. | bool |
| tipo | O tipo de nó implementado 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. Isto define o tamanho da CPU e da memória que é aprovisionada para cada nó. Valores de exemplo: "M30", "M40". | string |
MongoClusterRestoreParameters
| Nome | Descrição | Valor |
|---|---|---|
| pointInTimeUTC | PONTO UTC no tempo para restaurar um cluster do mongo | string |
| sourceResourceId | ID do Recurso para localizar o cluster de origem a restaurar | string |
Definição de recurso do Terraform (fornecedor AzAPI)
O tipo de recurso mongoClusters 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/mongoClusters, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/mongoClusters@2023-09-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-09-15-preview" |
| name | O nome do recurso | cadeia (obrigatório) |
| localização | A localização geográfica onde o recurso se encontra | cadeia (obrigatório) |
| parent_id | Para implementar num grupo de recursos, utilize o ID desse grupo de recursos. | cadeia (obrigatório) |
| etiquetas | Etiquetas de recursos. | Dicionário de nomes e valores de etiquetas. |
| propriedades | Propriedades do cluster do mongo. | MongoClusterProperties |
MongoClusterProperties
| Nome | Descrição | Valor |
|---|---|---|
| administratorLogin | O início de sessão do administrador para o cluster do mongo. | string |
| administratorLoginPassword | A palavra-passe do início de sessão do administrador. | string Restrições: Valor sensível. Transmita como um parâmetro seguro. |
| createMode | O modo para criar um cluster do mongo. | "Predefinição" "PointInTimeRestore" "Restaurar" |
| nodeGroupSpecs | A lista de especificações do grupo de nós no cluster. | NodeGroupSpec[] Restrições: Comprimento mínimo = 1 |
| restoreParameters | Parâmetros utilizados para operações de restauro | MongoClusterRestoreParameters |
| serverVersion | A versão do servidor do Mongo DB. A predefinição é a versão mais recente disponível, se não for especificada. | string |
NodeGroupSpec
| Nome | Descrição | Valor |
|---|---|---|
| diskSizeGB | O tamanho de armazenamento do disco para o grupo de nós em GB. Valores de exemplo: 128, 256, 512, 1024. | int |
| enableHa | Se a elevada disponibilidade está ativada no grupo de nós. | bool |
| tipo | O tipo de nó implementado no grupo de nós. | "Partição horizontal" |
| nodeCount | O número de nós no grupo de nós. | int |
| sku | O sku de recurso para o grupo de nós. Isto define o tamanho da CPU e da memória que é aprovisionada para cada nó. Valores de exemplo: "M30", "M40". | string |
MongoClusterRestoreParameters
| Nome | Descrição | Valor |
|---|---|---|
| pointInTimeUTC | PONTO UTC no tempo para restaurar um cluster do mongo | string |
| sourceResourceId | ID do Recurso para localizar o cluster de origem a restaurar | 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