Compartilhar via

Microsoft.DocumentDB mongoClusters 2024-03-01-preview

  • Artigo

Definição de recurso do Bicep

O tipo de recurso mongoClusters pode ser implantado com operações de destino:

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/mongoClusters, adicione o Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2024-03-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    administratorLogin: 'string'
    administratorLoginPassword: 'string'
    createMode: 'string'
    nodeGroupSpecs: [
      {
        diskSizeGB: int
        enableHa: bool
        kind: 'string'
        nodeCount: int
        sku: 'string'
      }
    ]
    publicNetworkAccess: 'string'
    restoreParameters: {
      pointInTimeUTC: 'string'
      sourceResourceId: 'string'
    }
    serverVersion: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores da propriedade

Microsoft.DocumentDB/mongoClusters

Nome Descrição Valor
localização A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 40
Padrão = ^[a-z0-9]+(-[a-z0-9]+)* (obrigatório)
Propriedades As propriedades específicas do recurso para esse recurso. MongoClusterProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

MongoClusterProperties

Nome Descrição Valor
administratorLogin O logon do administrador para o cluster mongo. corda
administratorLoginPassword A senha do logon do administrador. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
createMode O modo para criar um cluster mongo. 'Padrão'
'PointInTimeRestore'
nodeGroupSpecs A lista de especificações de grupo de nós no cluster. NodeGroupSpec []
publicNetworkAccess Se o acesso ao ponto de extremidade público é permitido ou não para este cluster mongo. 'Desabilitado'
'Habilitado'
restoreParameters Os parâmetros para criar um cluster mongo de restauração pontual. MongoClusterRestoreParameters
serverVersion A versão do servidor do Mongo DB. O padrão é a versão mais recente disponível, se não for especificada. corda

MongoClusterRestoreParameters

Nome Descrição Valor
pointInTimeUTC Ponto UTC no tempo para restaurar um cluster mongo corda
sourceResourceId ID do recurso para localizar o cluster de origem a ser restaurado corda

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
tipo 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 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'. corda

TrackedResourceTags

Nome Descrição Valor

Exemplos de uso

Módulos verificados do Azure

O módulos verificados do Azure a seguir pode ser usado para implantar esse tipo de recurso.

Módulo Descrição
Cosmos DB para MongoDB (vCore) Módulo de recurso AVM para Cosmos DB para MongoDB (vCore)

Definição de recurso de modelo do ARM

O tipo de recurso mongoClusters pode ser implantado com operações de destino:

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/mongoClusters, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.DocumentDB/mongoClusters",
  "apiVersion": "2024-03-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "administratorLogin": "string",
    "administratorLoginPassword": "string",
    "createMode": "string",
    "nodeGroupSpecs": [
      {
        "diskSizeGB": "int",
        "enableHa": "bool",
        "kind": "string",
        "nodeCount": "int",
        "sku": "string"
      }
    ],
    "publicNetworkAccess": "string",
    "restoreParameters": {
      "pointInTimeUTC": "string",
      "sourceResourceId": "string"
    },
    "serverVersion": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores da propriedade

Microsoft.DocumentDB/mongoClusters

Nome Descrição Valor
apiVersion A versão da API '2024-03-01-preview'
localização A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 40
Padrão = ^[a-z0-9]+(-[a-z0-9]+)* (obrigatório)
Propriedades As propriedades específicas do recurso para esse recurso. MongoClusterProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.DocumentDB/mongoClusters'

MongoClusterProperties

Nome Descrição Valor
administratorLogin O logon do administrador para o cluster mongo. corda
administratorLoginPassword A senha do logon do administrador. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
createMode O modo para criar um cluster mongo. 'Padrão'
'PointInTimeRestore'
nodeGroupSpecs A lista de especificações de grupo de nós no cluster. NodeGroupSpec []
publicNetworkAccess Se o acesso ao ponto de extremidade público é permitido ou não para este cluster mongo. 'Desabilitado'
'Habilitado'
restoreParameters Os parâmetros para criar um cluster mongo de restauração pontual. MongoClusterRestoreParameters
serverVersion A versão do servidor do Mongo DB. O padrão é a versão mais recente disponível, se não for especificada. corda

MongoClusterRestoreParameters

Nome Descrição Valor
pointInTimeUTC Ponto UTC no tempo para restaurar um cluster mongo corda
sourceResourceId ID do recurso para localizar o cluster de origem a ser restaurado corda

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
tipo 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 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'. corda

TrackedResourceTags

Nome Descrição Valor

Exemplos de uso

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso mongoClusters 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/mongoClusters, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/mongoClusters@2024-03-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      administratorLogin = "string"
      administratorLoginPassword = "string"
      createMode = "string"
      nodeGroupSpecs = [
        {
          diskSizeGB = int
          enableHa = bool
          kind = "string"
          nodeCount = int
          sku = "string"
        }
      ]
      publicNetworkAccess = "string"
      restoreParameters = {
        pointInTimeUTC = "string"
        sourceResourceId = "string"
      }
      serverVersion = "string"
    }
  })
}

Valores da propriedade

Microsoft.DocumentDB/mongoClusters

Nome Descrição Valor
localização A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 40
Padrão = ^[a-z0-9]+(-[a-z0-9]+)* (obrigatório)
Propriedades As propriedades específicas do recurso para esse recurso. MongoClusterProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.DocumentDB/mongoClusters@2024-03-01-preview"

MongoClusterProperties

Nome Descrição Valor
administratorLogin O logon do administrador para o cluster mongo. corda
administratorLoginPassword A senha do logon do administrador. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
createMode O modo para criar um cluster mongo. 'Padrão'
'PointInTimeRestore'
nodeGroupSpecs A lista de especificações de grupo de nós no cluster. NodeGroupSpec []
publicNetworkAccess Se o acesso ao ponto de extremidade público é permitido ou não para este cluster mongo. 'Desabilitado'
'Habilitado'
restoreParameters Os parâmetros para criar um cluster mongo de restauração pontual. MongoClusterRestoreParameters
serverVersion A versão do servidor do Mongo DB. O padrão é a versão mais recente disponível, se não for especificada. corda

MongoClusterRestoreParameters

Nome Descrição Valor
pointInTimeUTC Ponto UTC no tempo para restaurar um cluster mongo corda
sourceResourceId ID do recurso para localizar o cluster de origem a ser restaurado corda

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
tipo 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 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'. corda

TrackedResourceTags

Nome Descrição Valor