Partilhar via

Microsoft.DocumentDB mongoClusters 2024-10-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-10-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    administrator: {
      password: 'string'
      userName: 'string'
    }
    backup: {}
    compute: {
      tier: 'string'
    }
    createMode: 'string'
    dataApi: {
      mode: 'string'
    }
    highAvailability: {
      targetMode: 'string'
    }
    previewFeatures: [
      'string'
    ]
    publicNetworkAccess: 'string'
    replicaParameters: {
      sourceLocation: 'string'
      sourceResourceId: 'string'
    }
    restoreParameters: {
      pointInTimeUTC: 'string'
      sourceResourceId: 'string'
    }
    serverVersion: 'string'
    sharding: {
      shardCount: int
    }
    storage: {
      sizeGb: int
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

AdministradorPropriedades

Designação Descrição Valor
palavra-passe A senha de administrador. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
nome de utilizador O nome de usuário do administrador. string

BackupPropriedades

Designação Descrição Valor

ComputeProperties

Designação Descrição Valor
nível A camada de computação a ser atribuída ao cluster, onde cada camada é mapeada para um núcleo virtual e tamanho de memória. Valores de exemplo: 'M30', 'M40'. string

DataApiProperties

Designação Descrição Valor
modo O modo para indicar se a API de dados Mongo está habilitada para um cluster. 'Desativado'
'Habilitado'

HighAvailabilityProperties

Designação Descrição Valor
targetMode O modo de alta disponibilidade de destino solicitado para o cluster. 'Desativado'
'SameZone'
'ZoneRedundantPreferred'

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
administrador As propriedades do administrador local para o cluster mongo. AdministratorProperties
backup As propriedades de backup do cluster mongo. BackupProperties
computação As propriedades de computação do cluster mongo. ComputeProperties
createMode O modo para criar um cluster mongo. 'Inadimplência'
'GeoRéplica'
'PointInTimeRestore'
'Réplica'
dataApi As propriedades da API de dados do cluster mongo. DataApiProperties
alta disponibilidade As propriedades de alta disponibilidade do cluster mongo. HighAvailabilityProperties
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
fragmentação As propriedades de fragmentação do aglomerado mongo. ShardingProperties
armazenamento As propriedades de armazenamento do cluster mongo. StorageProperties

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

ShardingProperties

Designação Descrição Valor
Contagem de fragmentos Número de fragmentos a serem provisionados no cluster. Int

Propriedades de armazenamento

Designação Descrição Valor
tamanhoGb O tamanho do disco de dados atribuído a cada servidor. Int

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-10-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "administrator": {
      "password": "string",
      "userName": "string"
    },
    "backup": {
    },
    "compute": {
      "tier": "string"
    },
    "createMode": "string",
    "dataApi": {
      "mode": "string"
    },
    "highAvailability": {
      "targetMode": "string"
    },
    "previewFeatures": [ "string" ],
    "publicNetworkAccess": "string",
    "replicaParameters": {
      "sourceLocation": "string",
      "sourceResourceId": "string"
    },
    "restoreParameters": {
      "pointInTimeUTC": "string",
      "sourceResourceId": "string"
    },
    "serverVersion": "string",
    "sharding": {
      "shardCount": "int"
    },
    "storage": {
      "sizeGb": "int"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

AdministradorPropriedades

Designação Descrição Valor
palavra-passe A senha de administrador. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
nome de utilizador O nome de usuário do administrador. string

BackupPropriedades

Designação Descrição Valor

ComputeProperties

Designação Descrição Valor
nível A camada de computação a ser atribuída ao cluster, onde cada camada é mapeada para um núcleo virtual e tamanho de memória. Valores de exemplo: 'M30', 'M40'. string

DataApiProperties

Designação Descrição Valor
modo O modo para indicar se a API de dados Mongo está habilitada para um cluster. 'Desativado'
'Habilitado'

HighAvailabilityProperties

Designação Descrição Valor
targetMode O modo de alta disponibilidade de destino solicitado para o cluster. 'Desativado'
'SameZone'
'ZoneRedundantPreferred'

Microsoft.DocumentDB/mongoClusters

Designação Descrição Valor
apiVersion A versão api '2024-10-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
administrador As propriedades do administrador local para o cluster mongo. AdministratorProperties
backup As propriedades de backup do cluster mongo. BackupProperties
computação As propriedades de computação do cluster mongo. ComputeProperties
createMode O modo para criar um cluster mongo. 'Inadimplência'
'GeoRéplica'
'PointInTimeRestore'
'Réplica'
dataApi As propriedades da API de dados do cluster mongo. DataApiProperties
alta disponibilidade As propriedades de alta disponibilidade do cluster mongo. HighAvailabilityProperties
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
fragmentação As propriedades de fragmentação do aglomerado mongo. ShardingProperties
armazenamento As propriedades de armazenamento do cluster mongo. StorageProperties

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

ShardingProperties

Designação Descrição Valor
Contagem de fragmentos Número de fragmentos a serem provisionados no cluster. Int

Propriedades de armazenamento

Designação Descrição Valor
tamanhoGb O tamanho do disco de dados atribuído a cada servidor. Int

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-10-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      administrator = {
        password = "string"
        userName = "string"
      }
      backup = {
      }
      compute = {
        tier = "string"
      }
      createMode = "string"
      dataApi = {
        mode = "string"
      }
      highAvailability = {
        targetMode = "string"
      }
      previewFeatures = [
        "string"
      ]
      publicNetworkAccess = "string"
      replicaParameters = {
        sourceLocation = "string"
        sourceResourceId = "string"
      }
      restoreParameters = {
        pointInTimeUTC = "string"
        sourceResourceId = "string"
      }
      serverVersion = "string"
      sharding = {
        shardCount = int
      }
      storage = {
        sizeGb = int
      }
    }
  })
}

Valores de propriedade

AdministradorPropriedades

Designação Descrição Valor
palavra-passe A senha de administrador. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
nome de utilizador O nome de usuário do administrador. string

BackupPropriedades

Designação Descrição Valor

ComputeProperties

Designação Descrição Valor
nível A camada de computação a ser atribuída ao cluster, onde cada camada é mapeada para um núcleo virtual e tamanho de memória. Valores de exemplo: 'M30', 'M40'. string

DataApiProperties

Designação Descrição Valor
modo O modo para indicar se a API de dados Mongo está habilitada para um cluster. 'Desativado'
'Habilitado'

HighAvailabilityProperties

Designação Descrição Valor
targetMode O modo de alta disponibilidade de destino solicitado para o cluster. 'Desativado'
'SameZone'
'ZoneRedundantPreferred'

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-10-01-preview"

MongoClusterProperties

Designação Descrição Valor
administrador As propriedades do administrador local para o cluster mongo. AdministratorProperties
backup As propriedades de backup do cluster mongo. BackupProperties
computação As propriedades de computação do cluster mongo. ComputeProperties
createMode O modo para criar um cluster mongo. 'Inadimplência'
'GeoRéplica'
'PointInTimeRestore'
'Réplica'
dataApi As propriedades da API de dados do cluster mongo. DataApiProperties
alta disponibilidade As propriedades de alta disponibilidade do cluster mongo. HighAvailabilityProperties
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
fragmentação As propriedades de fragmentação do aglomerado mongo. ShardingProperties
armazenamento As propriedades de armazenamento do cluster mongo. StorageProperties

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

ShardingProperties

Designação Descrição Valor
Contagem de fragmentos Número de fragmentos a serem provisionados no cluster. Int

Propriedades de armazenamento

Designação Descrição Valor
tamanhoGb O tamanho do disco de dados atribuído a cada servidor. Int

TrackedResourceTags

Designação Descrição Valor