Microsoft.DocumentDB mongoClusters

Artikel
2025-05-05

Bicep-resursdefinition

Resurstypen mongoClusters kan distribueras med åtgärder som mål:

Resursgrupper – Se resursgruppsdistributionskommandon

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/mongoClusters-resurs lägger du till följande Bicep i mallen.

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

Egenskapsvärden

AdministratörEgenskaper

Namn	Beskrivning	Värde
lösenord	Administratörslösenordet.	sträng Begränsningar: Känsligt värde. Skicka in som en säker parameter.
userName	Administratörens användarnamn.	sträng

BackupEgenskaper

Namn	Beskrivning	Värde

ComputeProperties

Namn	Beskrivning	Värde
Nivå	Beräkningsnivån som ska tilldelas till klustret, där varje nivå mappas till en virtuell kärna och minnesstorlek. Exempelvärden: "M30", "M40".	sträng

DataApiEgenskaper

Namn	Beskrivning	Värde
läge	Läget för att ange om Mongo Data API är aktiverat för ett kluster.	"Inaktiverad" "Aktiverad"

HighAvailabilityProperties

Namn	Beskrivning	Värde
targetMode	Det målläge för hög tillgänglighet som begärs för klustret.	"Inaktiverad" "SameZone" "ZoneRedundantPreferred"

Microsoft.DocumentDB/mongoClusters

Namn	Beskrivning	Värde
plats	Den geo-plats där resursen finns	sträng (krävs)
Namn	Resursnamnet	sträng Begränsningar: Min längd = 3 Maximal längd = 40 Mönster = `^[a-z0-9]+(-[a-z0-9]+)*` (krävs)
Egenskaper	Resursspecifika egenskaper för den här resursen.	MongoClusterEgenskaper
Taggar	Resurstaggar	Ordlista med taggnamn och värden. Se taggar i mallar

MongoClusterEgenskaper

Namn	Beskrivning	Värde
administratör	De lokala administratörsegenskaperna för mongo-klustret.	AdministratörEgenskaper
säkerhetskopia	Egenskaperna för säkerhetskopiering av mongo-klustret.	BackupEgenskaper
beräkna	Beräkningsegenskaperna för mongo-klustret.	ComputeProperties
createMode	Läget för att skapa ett mongo-kluster.	"Standard" "GeoReplica" "PointInTimeRestore" "Replik"
dataApi	Egenskaperna för Data-API:et för mongo-klustret.	DataApiEgenskaper
highAvailability	Mongo-klustrets egenskaper med hög tillgänglighet.	HighAvailabilityProperties
previewFeatures	Lista över privata slutpunktsanslutningar.	Strängmatris som innehåller något av: "GeoReplicas"
publicNetworkAccess	Om offentlig slutpunktsåtkomst tillåts för det här mongo-klustret eller inte.	"Inaktiverad" "Aktiverad"
replicaParameters	Parametrarna för att skapa ett mongo-replikkluster.	MongoClusterReplicaParameters
restoreParameters	Parametrarna för att skapa ett mongo-kluster för återställning till tidpunkt.	MongoClusterRestoreParameters
serverVersion	Mongo DB-serverversionen. Standardvärdet är den senaste tillgängliga versionen om den inte har angetts.	sträng
horisontell partitionering	Mongo-klustrets horisontella egenskaper.	ShardingEgenskaper
lagring	Lagringsegenskaperna för mongo-klustret.	StorageProperties

MongoClusterReplicaParameters

Namn	Beskrivning	Värde
sourceLocation	Källklustrets plats	sträng (krävs)
sourceResourceId	ID för replikeringsklustret.	sträng (krävs)

MongoClusterRestoreParameters

Namn	Beskrivning	Värde
pointInTimeUTC	UTC-tidpunkt för att återställa ett mongo-kluster	sträng
sourceResourceId	Resurs-ID för att hitta källklustret som ska återställas	sträng

ShardingEgenskaper

Namn	Beskrivning	Värde
shardCount	Antal shards som ska etableras i klustret.	Int

StorageProperties

Namn	Beskrivning	Värde
sizeGb	Storleken på den datadisk som tilldelats till varje server.	Int

TrackedResourceTags

Namn	Beskrivning	Värde

Användningsexempel

Azure-verifierade moduler

Följande Azure-verifierade moduler kan användas för att distribuera den här resurstypen.

Modul	Beskrivning
Cosmos DB för MongoDB (virtuell kärna)	AVM-resursmodul för Cosmos DB för MongoDB (virtuell kärna)

Resursdefinition för ARM-mall

Resurstypen mongoClusters kan distribueras med åtgärder som mål:

Resursgrupper – Se resursgruppsdistributionskommandon

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/mongoClusters-resurs lägger du till följande JSON i mallen.

{
  "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"
  }
}

Egenskapsvärden

AdministratörEgenskaper

Namn	Beskrivning	Värde
lösenord	Administratörslösenordet.	sträng Begränsningar: Känsligt värde. Skicka in som en säker parameter.
userName	Administratörens användarnamn.	sträng

BackupEgenskaper

Namn	Beskrivning	Värde

ComputeProperties

Namn	Beskrivning	Värde
Nivå	Beräkningsnivån som ska tilldelas till klustret, där varje nivå mappas till en virtuell kärna och minnesstorlek. Exempelvärden: "M30", "M40".	sträng

DataApiEgenskaper

Namn	Beskrivning	Värde
läge	Läget för att ange om Mongo Data API är aktiverat för ett kluster.	"Inaktiverad" "Aktiverad"

HighAvailabilityProperties

Namn	Beskrivning	Värde
targetMode	Det målläge för hög tillgänglighet som begärs för klustret.	"Inaktiverad" "SameZone" "ZoneRedundantPreferred"

Microsoft.DocumentDB/mongoClusters

Namn	Beskrivning	Värde
apiVersion	API-versionen	"2024-10-01-preview"
plats	Den geo-plats där resursen finns	sträng (krävs)
Namn	Resursnamnet	sträng Begränsningar: Min längd = 3 Maximal längd = 40 Mönster = `^[a-z0-9]+(-[a-z0-9]+)*` (krävs)
Egenskaper	Resursspecifika egenskaper för den här resursen.	MongoClusterEgenskaper
Taggar	Resurstaggar	Ordlista med taggnamn och värden. Se taggar i mallar
typ	Resurstypen	"Microsoft.DocumentDB/mongoClusters"

MongoClusterEgenskaper

Namn	Beskrivning	Värde
administratör	De lokala administratörsegenskaperna för mongo-klustret.	AdministratörEgenskaper
säkerhetskopia	Egenskaperna för säkerhetskopiering av mongo-klustret.	BackupEgenskaper
beräkna	Beräkningsegenskaperna för mongo-klustret.	ComputeProperties
createMode	Läget för att skapa ett mongo-kluster.	"Standard" "GeoReplica" "PointInTimeRestore" "Replik"
dataApi	Egenskaperna för Data-API:et för mongo-klustret.	DataApiEgenskaper
highAvailability	Mongo-klustrets egenskaper med hög tillgänglighet.	HighAvailabilityProperties
previewFeatures	Lista över privata slutpunktsanslutningar.	Strängmatris som innehåller något av: "GeoReplicas"
publicNetworkAccess	Om offentlig slutpunktsåtkomst tillåts för det här mongo-klustret eller inte.	"Inaktiverad" "Aktiverad"
replicaParameters	Parametrarna för att skapa ett mongo-replikkluster.	MongoClusterReplicaParameters
restoreParameters	Parametrarna för att skapa ett mongo-kluster för återställning till tidpunkt.	MongoClusterRestoreParameters
serverVersion	Mongo DB-serverversionen. Standardvärdet är den senaste tillgängliga versionen om den inte har angetts.	sträng
horisontell partitionering	Mongo-klustrets horisontella egenskaper.	ShardingEgenskaper
lagring	Lagringsegenskaperna för mongo-klustret.	StorageProperties

MongoClusterReplicaParameters

Namn	Beskrivning	Värde
sourceLocation	Källklustrets plats	sträng (krävs)
sourceResourceId	ID för replikeringsklustret.	sträng (krävs)

MongoClusterRestoreParameters

Namn	Beskrivning	Värde
pointInTimeUTC	UTC-tidpunkt för att återställa ett mongo-kluster	sträng
sourceResourceId	Resurs-ID för att hitta källklustret som ska återställas	sträng

ShardingEgenskaper

Namn	Beskrivning	Värde
shardCount	Antal shards som ska etableras i klustret.	Int

StorageProperties

Namn	Beskrivning	Värde
sizeGb	Storleken på den datadisk som tilldelats till varje server.	Int

TrackedResourceTags

Namn	Beskrivning	Värde

Användningsexempel

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen mongoClusters kan distribueras med åtgärder som mål:

Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/mongoClusters-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/mongoClusters@2024-10-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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
      }
    }
  }
}

Egenskapsvärden

AdministratörEgenskaper

Namn	Beskrivning	Värde
lösenord	Administratörslösenordet.	sträng Begränsningar: Känsligt värde. Skicka in som en säker parameter.
userName	Administratörens användarnamn.	sträng

BackupEgenskaper

Namn	Beskrivning	Värde

ComputeProperties

Namn	Beskrivning	Värde
Nivå	Beräkningsnivån som ska tilldelas till klustret, där varje nivå mappas till en virtuell kärna och minnesstorlek. Exempelvärden: "M30", "M40".	sträng

DataApiEgenskaper

Namn	Beskrivning	Värde
läge	Läget för att ange om Mongo Data API är aktiverat för ett kluster.	"Inaktiverad" "Aktiverad"

HighAvailabilityProperties

Namn	Beskrivning	Värde
targetMode	Det målläge för hög tillgänglighet som begärs för klustret.	"Inaktiverad" "SameZone" "ZoneRedundantPreferred"

Microsoft.DocumentDB/mongoClusters

Namn	Beskrivning	Värde
plats	Den geo-plats där resursen finns	sträng (krävs)
Namn	Resursnamnet	sträng Begränsningar: Min längd = 3 Maximal längd = 40 Mönster = `^[a-z0-9]+(-[a-z0-9]+)*` (krävs)
Egenskaper	Resursspecifika egenskaper för den här resursen.	MongoClusterEgenskaper
Taggar	Resurstaggar	Ordlista med taggnamn och värden.
typ	Resurstypen	"Microsoft.DocumentDB/mongoClusters@2024-10-01-preview"

MongoClusterEgenskaper

Namn	Beskrivning	Värde
administratör	De lokala administratörsegenskaperna för mongo-klustret.	AdministratörEgenskaper
säkerhetskopia	Egenskaperna för säkerhetskopiering av mongo-klustret.	BackupEgenskaper
beräkna	Beräkningsegenskaperna för mongo-klustret.	ComputeProperties
createMode	Läget för att skapa ett mongo-kluster.	"Standard" "GeoReplica" "PointInTimeRestore" "Replik"
dataApi	Egenskaperna för Data-API:et för mongo-klustret.	DataApiEgenskaper
highAvailability	Mongo-klustrets egenskaper med hög tillgänglighet.	HighAvailabilityProperties
previewFeatures	Lista över privata slutpunktsanslutningar.	Strängmatris som innehåller något av: "GeoReplicas"
publicNetworkAccess	Om offentlig slutpunktsåtkomst tillåts för det här mongo-klustret eller inte.	"Inaktiverad" "Aktiverad"
replicaParameters	Parametrarna för att skapa ett mongo-replikkluster.	MongoClusterReplicaParameters
restoreParameters	Parametrarna för att skapa ett mongo-kluster för återställning till tidpunkt.	MongoClusterRestoreParameters
serverVersion	Mongo DB-serverversionen. Standardvärdet är den senaste tillgängliga versionen om den inte har angetts.	sträng
horisontell partitionering	Mongo-klustrets horisontella egenskaper.	ShardingEgenskaper
lagring	Lagringsegenskaperna för mongo-klustret.	StorageProperties

MongoClusterReplicaParameters

Namn	Beskrivning	Värde
sourceLocation	Källklustrets plats	sträng (krävs)
sourceResourceId	ID för replikeringsklustret.	sträng (krävs)

MongoClusterRestoreParameters

Namn	Beskrivning	Värde
pointInTimeUTC	UTC-tidpunkt för att återställa ett mongo-kluster	sträng
sourceResourceId	Resurs-ID för att hitta källklustret som ska återställas	sträng

ShardingEgenskaper

Namn	Beskrivning	Värde
shardCount	Antal shards som ska etableras i klustret.	Int

StorageProperties

Namn	Beskrivning	Värde
sizeGb	Storleken på den datadisk som tilldelats till varje server.	Int

TrackedResourceTags

Namn	Beskrivning	Värde

Dela via

Microsoft.DocumentDB mongoClusters

Bicep-resursdefinition

Resursformat

Egenskapsvärden

AdministratörEgenskaper

BackupEgenskaper

ComputeProperties

DataApiEgenskaper

HighAvailabilityProperties

Microsoft.DocumentDB/mongoClusters

MongoClusterEgenskaper

MongoClusterReplicaParameters

MongoClusterRestoreParameters

ShardingEgenskaper

StorageProperties

TrackedResourceTags

Användningsexempel

Azure-verifierade moduler

Resursdefinition för ARM-mall

Resursformat

Egenskapsvärden

AdministratörEgenskaper

BackupEgenskaper

ComputeProperties

DataApiEgenskaper

HighAvailabilityProperties

Microsoft.DocumentDB/mongoClusters

MongoClusterEgenskaper

MongoClusterReplicaParameters

MongoClusterRestoreParameters

ShardingEgenskaper

StorageProperties

TrackedResourceTags

Användningsexempel

Resursdefinition för Terraform (AzAPI-provider)

Resursformat

Egenskapsvärden

AdministratörEgenskaper

BackupEgenskaper

ComputeProperties

DataApiEgenskaper

HighAvailabilityProperties

Microsoft.DocumentDB/mongoClusters

MongoClusterEgenskaper

MongoClusterReplicaParameters

MongoClusterRestoreParameters

ShardingEgenskaper

StorageProperties

TrackedResourceTags

Feedback

Ytterligare resurser