MongoClusters Microsoft.DocumentDB

Artigo
12/20/2024

Definição de recurso do Bicep

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

Grupos de recursos - Consulte comandos de implantação do grupo 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 Bicep a seguir ao 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

AdministratorProperties

Nome	Descrição	Valor
senha	A senha do administrador.	corda Restrições: Valor confidencial. Passe como um parâmetro seguro.
userName	O nome de usuário do administrador.	corda

BackupProperties

Nome	Descrição	Valor

ComputeProperties

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

DataApiProperties

Nome	Descrição	Valor
modo	O modo para indicar se a API de Dados do Mongo está habilitada para um cluster.	'Desabilitado' 'Habilitado'

HighAvailabilityProperties

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

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 = 3 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
administrador	As propriedades do administrador local para o cluster mongo.	AdministratorProperties
backup	As propriedades de backup do cluster mongo.	BackupProperties
calcular	As propriedades de computação do cluster mongo.	ComputeProperties
createMode	O modo para criar um cluster mongo.	'Padrão' 'GeoReplica' 'PointInTimeRestore' 'Réplica'
dataApi	As propriedades da API de Dados do cluster mongo.	DataApiProperties
highAvailability	As propriedades de alta disponibilidade do cluster mongo.	HighAvailabilityProperties
previewFeatures	Lista de conexões de ponto de extremidade privado.	Matriz de cadeia de caracteres que contém qualquer um dos: 'GeoReplicas'
publicNetworkAccess	Se o acesso ao ponto de extremidade público é permitido ou não para este cluster mongo.	'Desabilitado' 'Habilitado'
replicaParameters	Os parâmetros para criar um cluster mongo de réplica.	MongoClusterReplicaParameters
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
fragmentação	As propriedades de fragmentação do cluster mongo.	shardingProperties
armazenamento	As propriedades de armazenamento do cluster mongo.	StorageProperties

MongoClusterReplicaParameters

Nome	Descrição	Valor
sourceLocation	O local do cluster de origem	cadeia de caracteres (obrigatório)
sourceResourceId	A ID do cluster de origem de replicação.	cadeia de caracteres (obrigatório)

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

ShardingProperties

Nome	Descrição	Valor
shardCount	Número de fragmentos a serem provisionadas no cluster.	int

StorageProperties

Nome	Descrição	Valor
sizeGb	O tamanho do disco de dados atribuído a cada servidor.	int

TrackedResourceTags

Nome	Descrição	Valor

Definição de recurso de modelo do ARM

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

Grupos de recursos - Consulte comandos de implantação do grupo 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 JSON a seguir ao 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

AdministratorProperties

Nome	Descrição	Valor
senha	A senha do administrador.	corda Restrições: Valor confidencial. Passe como um parâmetro seguro.
userName	O nome de usuário do administrador.	corda

BackupProperties

Nome	Descrição	Valor

ComputeProperties

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

DataApiProperties

Nome	Descrição	Valor
modo	O modo para indicar se a API de Dados do Mongo está habilitada para um cluster.	'Desabilitado' 'Habilitado'

HighAvailabilityProperties

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

Microsoft.DocumentDB/mongoClusters

Nome	Descrição	Valor
apiVersion	A versão da API	'2024-10-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 = 3 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
administrador	As propriedades do administrador local para o cluster mongo.	AdministratorProperties
backup	As propriedades de backup do cluster mongo.	BackupProperties
calcular	As propriedades de computação do cluster mongo.	ComputeProperties
createMode	O modo para criar um cluster mongo.	'Padrão' 'GeoReplica' 'PointInTimeRestore' 'Réplica'
dataApi	As propriedades da API de Dados do cluster mongo.	DataApiProperties
highAvailability	As propriedades de alta disponibilidade do cluster mongo.	HighAvailabilityProperties
previewFeatures	Lista de conexões de ponto de extremidade privado.	Matriz de cadeia de caracteres que contém qualquer um dos: 'GeoReplicas'
publicNetworkAccess	Se o acesso ao ponto de extremidade público é permitido ou não para este cluster mongo.	'Desabilitado' 'Habilitado'
replicaParameters	Os parâmetros para criar um cluster mongo de réplica.	MongoClusterReplicaParameters
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
fragmentação	As propriedades de fragmentação do cluster mongo.	shardingProperties
armazenamento	As propriedades de armazenamento do cluster mongo.	StorageProperties

MongoClusterReplicaParameters

Nome	Descrição	Valor
sourceLocation	O local do cluster de origem	cadeia de caracteres (obrigatório)
sourceResourceId	A ID do cluster de origem de replicação.	cadeia de caracteres (obrigatório)

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

ShardingProperties

Nome	Descrição	Valor
shardCount	Número de fragmentos a serem provisionadas no cluster.	int

StorageProperties

Nome	Descrição	Valor
sizeGb	O tamanho do disco de dados atribuído a cada servidor.	int

TrackedResourceTags

Nome	Descrição	Valor

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-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

AdministratorProperties

Nome	Descrição	Valor
senha	A senha do administrador.	corda Restrições: Valor confidencial. Passe como um parâmetro seguro.
userName	O nome de usuário do administrador.	corda

BackupProperties

Nome	Descrição	Valor

ComputeProperties

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

DataApiProperties

Nome	Descrição	Valor
modo	O modo para indicar se a API de Dados do Mongo está habilitada para um cluster.	'Desabilitado' 'Habilitado'

HighAvailabilityProperties

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

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

MongoClusterProperties

Nome	Descrição	Valor
administrador	As propriedades do administrador local para o cluster mongo.	AdministratorProperties
backup	As propriedades de backup do cluster mongo.	BackupProperties
calcular	As propriedades de computação do cluster mongo.	ComputeProperties
createMode	O modo para criar um cluster mongo.	'Padrão' 'GeoReplica' 'PointInTimeRestore' 'Réplica'
dataApi	As propriedades da API de Dados do cluster mongo.	DataApiProperties
highAvailability	As propriedades de alta disponibilidade do cluster mongo.	HighAvailabilityProperties
previewFeatures	Lista de conexões de ponto de extremidade privado.	Matriz de cadeia de caracteres que contém qualquer um dos: 'GeoReplicas'
publicNetworkAccess	Se o acesso ao ponto de extremidade público é permitido ou não para este cluster mongo.	'Desabilitado' 'Habilitado'
replicaParameters	Os parâmetros para criar um cluster mongo de réplica.	MongoClusterReplicaParameters
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
fragmentação	As propriedades de fragmentação do cluster mongo.	shardingProperties
armazenamento	As propriedades de armazenamento do cluster mongo.	StorageProperties

MongoClusterReplicaParameters

Nome	Descrição	Valor
sourceLocation	O local do cluster de origem	cadeia de caracteres (obrigatório)
sourceResourceId	A ID do cluster de origem de replicação.	cadeia de caracteres (obrigatório)

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

ShardingProperties

Nome	Descrição	Valor
shardCount	Número de fragmentos a serem provisionadas no cluster.	int

StorageProperties

Nome	Descrição	Valor
sizeGb	O tamanho do disco de dados atribuído a cada servidor.	int

TrackedResourceTags

Nome	Descrição	Valor

Compartilhar via

MongoClusters Microsoft.DocumentDB

Definição de recurso do Bicep

Formato de recurso

Valores de propriedade

AdministratorProperties

BackupProperties

ComputeProperties

DataApiProperties

HighAvailabilityProperties

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterReplicaParameters

MongoClusterRestoreParameters

ShardingProperties

StorageProperties

TrackedResourceTags

Definição de recurso de modelo do ARM

Formato de recurso

Valores de propriedade

AdministratorProperties

BackupProperties

ComputeProperties

DataApiProperties

HighAvailabilityProperties

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterReplicaParameters

MongoClusterRestoreParameters

ShardingProperties

StorageProperties

TrackedResourceTags

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

Formato de recurso

Valores de propriedade

AdministratorProperties

BackupProperties

ComputeProperties

DataApiProperties

HighAvailabilityProperties

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterReplicaParameters

MongoClusterRestoreParameters

ShardingProperties

StorageProperties

TrackedResourceTags

Comentários

Recursos adicionais