Partilhar via

Microsoft.DocumentDB mongoClusters 2024-06-01-visualização

  • Artigo

Definição de recursos do bíceps

O tipo de recurso mongoClusters 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.

Formato do recurso

Para criar um recurso Microsoft.DocumentDB/mongoClusters, adicione o seguinte Bicep ao seu modelo.

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

Valores de propriedade

Microsoft.DocumentDB/mongoClusters

Designação Descrição Valor
Localização A geolocalização onde o recurso vive string (obrigatório)
Designação O nome do recurso string

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

MongoClusterProperties

Designação Descrição Valor
administradorLogin O login do administrador para o cluster mongo. string
administradorLoginPassword A senha do login de administrador. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
createMode O modo para criar um cluster mongo. 'Inadimplência'
'GeoRéplica'
'PointInTimeRestore'
'Réplica'
nodeGroupSpecs A lista de especificações do grupo de nós no cluster. NodeGroupSpec []
pré-visualizaçãoFuncionalidades Lista de conexões de ponto de extremidade privadas. Matriz de cadeia de caracteres contendo qualquer uma das:
'GeoRéplicas'
publicNetworkAccess Se o acesso público ao endpoint é permitido ou não para este cluster mongo. 'Desativado'
'Habilitado'
replicaParameters Os parâmetros para criar uma réplica mongo cluster. MongoClusterReplicaParameters
restoreParameters Os parâmetros para criar um cluster mongo de restauração point-in-time. MongoClusterRestoreParameters
serverVersion A versão do servidor Mongo DB. O padrão é a versão mais recente disponível, se não for especificado. string

MongoClusterReplicaParameters

Designação Descrição Valor
fonteLocalização O local do cluster de origem string (obrigatório)
sourceResourceId A id do cluster de origem de replicação. string (obrigatório)

MongoClusterRestoreParameters

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

NodeGroupSpec

Designação Descrição Valor
diskSizeGB O tamanho do armazenamento em disco para o grupo de nós em GB. Exemplos de valores: 128, 256, 512, 1024. Int
habilitarHa Se a alta disponibilidade está habilitada no grupo de nós. Bool
tipo 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 recurso para o grupo de nós. Isso define o tamanho da CPU e da memória provisionada para cada nó. Valores de exemplo: 'M30', 'M40'. string

TrackedResourceTags

Designação Descrição Valor

Definição de recurso de modelo ARM

O tipo de recurso mongoClusters 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.

Formato do recurso

Para criar um recurso Microsoft.DocumentDB/mongoClusters, adicione o seguinte JSON ao seu modelo.

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

Valores de propriedade

Microsoft.DocumentDB/mongoClusters

Designação Descrição Valor
apiVersion A versão api '2024-06-01-pré-visualização'
Localização A geolocalização onde o recurso vive string (obrigatório)
Designação O nome do recurso string

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

MongoClusterProperties

Designação Descrição Valor
administradorLogin O login do administrador para o cluster mongo. string
administradorLoginPassword A senha do login de administrador. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
createMode O modo para criar um cluster mongo. 'Inadimplência'
'GeoRéplica'
'PointInTimeRestore'
'Réplica'
nodeGroupSpecs A lista de especificações do grupo de nós no cluster. NodeGroupSpec []
pré-visualizaçãoFuncionalidades Lista de conexões de ponto de extremidade privadas. Matriz de cadeia de caracteres contendo qualquer uma das:
'GeoRéplicas'
publicNetworkAccess Se o acesso público ao endpoint é permitido ou não para este cluster mongo. 'Desativado'
'Habilitado'
replicaParameters Os parâmetros para criar uma réplica mongo cluster. MongoClusterReplicaParameters
restoreParameters Os parâmetros para criar um cluster mongo de restauração point-in-time. MongoClusterRestoreParameters
serverVersion A versão do servidor Mongo DB. O padrão é a versão mais recente disponível, se não for especificado. string

MongoClusterReplicaParameters

Designação Descrição Valor
fonteLocalização O local do cluster de origem string (obrigatório)
sourceResourceId A id do cluster de origem de replicação. string (obrigatório)

MongoClusterRestoreParameters

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

NodeGroupSpec

Designação Descrição Valor
diskSizeGB O tamanho do armazenamento em disco para o grupo de nós em GB. Exemplos de valores: 128, 256, 512, 1024. Int
habilitarHa Se a alta disponibilidade está habilitada no grupo de nós. Bool
tipo 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 recurso para o grupo de nós. Isso define o tamanho da CPU e da memória provisionada para cada nó. Valores de exemplo: 'M30', 'M40'. string

TrackedResourceTags

Designação Descrição Valor

Definição de recursos Terraform (provedor AzAPI)

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

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log 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@2024-06-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"
        }
      ]
      previewFeatures = [
        "string"
      ]
      publicNetworkAccess = "string"
      replicaParameters = {
        sourceLocation = "string"
        sourceResourceId = "string"
      }
      restoreParameters = {
        pointInTimeUTC = "string"
        sourceResourceId = "string"
      }
      serverVersion = "string"
    }
  })
}

Valores de propriedade

Microsoft.DocumentDB/mongoClusters

Designação Descrição Valor
Localização A geolocalização onde o recurso vive string (obrigatório)
Designação O nome do recurso string

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

MongoClusterProperties

Designação Descrição Valor
administradorLogin O login do administrador para o cluster mongo. string
administradorLoginPassword A senha do login de administrador. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
createMode O modo para criar um cluster mongo. 'Inadimplência'
'GeoRéplica'
'PointInTimeRestore'
'Réplica'
nodeGroupSpecs A lista de especificações do grupo de nós no cluster. NodeGroupSpec []
pré-visualizaçãoFuncionalidades Lista de conexões de ponto de extremidade privadas. Matriz de cadeia de caracteres contendo qualquer uma das:
'GeoRéplicas'
publicNetworkAccess Se o acesso público ao endpoint é permitido ou não para este cluster mongo. 'Desativado'
'Habilitado'
replicaParameters Os parâmetros para criar uma réplica mongo cluster. MongoClusterReplicaParameters
restoreParameters Os parâmetros para criar um cluster mongo de restauração point-in-time. MongoClusterRestoreParameters
serverVersion A versão do servidor Mongo DB. O padrão é a versão mais recente disponível, se não for especificado. string

MongoClusterReplicaParameters

Designação Descrição Valor
fonteLocalização O local do cluster de origem string (obrigatório)
sourceResourceId A id do cluster de origem de replicação. string (obrigatório)

MongoClusterRestoreParameters

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

NodeGroupSpec

Designação Descrição Valor
diskSizeGB O tamanho do armazenamento em disco para o grupo de nós em GB. Exemplos de valores: 128, 256, 512, 1024. Int
habilitarHa Se a alta disponibilidade está habilitada no grupo de nós. Bool
tipo 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 recurso para o grupo de nós. Isso define o tamanho da CPU e da memória provisionada para cada nó. Valores de exemplo: 'M30', 'M40'. string

TrackedResourceTags

Designação Descrição Valor