Dela via

Microsoft.DocumentDB mongoClusters 2024-06-01-preview

  • Artikel

Bicep-resursdefinition

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

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

Egenskapsvärden

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
administratorLogin Administratörens inloggning för mongo-klustret. sträng
administratorLoginPassword Lösenordet för administratörsinloggningen. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
createMode Läget för att skapa ett mongo-kluster. "Standard"
"GeoReplica"
"PointInTimeRestore"
"Replik"
nodeGroupSpecs Listan över nodgruppsspecifikationer i klustret. NodeGroupSpec[]
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

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

NodeGroupSpec

Namn Beskrivning Värde
diskSizeGB Disklagringsstorleken för nodgruppen i GB. Exempelvärden: 128, 256, 512, 1024. Int
enableHa Om hög tillgänglighet är aktiverat i nodgruppen. Bool
sort Nodtypen som distribueras i nodgruppen. "Shard"
nodeCount Antalet noder i nodgruppen. Int
Sku Resurs-SKU:n för nodgruppen. Detta definierar storleken på processorn och minnet som etableras för varje nod. Exempelvärden: "M30", "M40". sträng

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:

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

Egenskapsvärden

Microsoft.DocumentDB/mongoClusters

Namn Beskrivning Värde
apiVersion API-versionen "2024-06-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
administratorLogin Administratörens inloggning för mongo-klustret. sträng
administratorLoginPassword Lösenordet för administratörsinloggningen. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
createMode Läget för att skapa ett mongo-kluster. "Standard"
"GeoReplica"
"PointInTimeRestore"
"Replik"
nodeGroupSpecs Listan över nodgruppsspecifikationer i klustret. NodeGroupSpec[]
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

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

NodeGroupSpec

Namn Beskrivning Värde
diskSizeGB Disklagringsstorleken för nodgruppen i GB. Exempelvärden: 128, 256, 512, 1024. Int
enableHa Om hög tillgänglighet är aktiverat i nodgruppen. Bool
sort Nodtypen som distribueras i nodgruppen. "Shard"
nodeCount Antalet noder i nodgruppen. Int
Sku Resurs-SKU:n för nodgruppen. Detta definierar storleken på processorn och minnet som etableras för varje nod. Exempelvärden: "M30", "M40". sträng

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-06-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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"
    }
  }
}

Egenskapsvärden

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

MongoClusterEgenskaper

Namn Beskrivning Värde
administratorLogin Administratörens inloggning för mongo-klustret. sträng
administratorLoginPassword Lösenordet för administratörsinloggningen. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
createMode Läget för att skapa ett mongo-kluster. "Standard"
"GeoReplica"
"PointInTimeRestore"
"Replik"
nodeGroupSpecs Listan över nodgruppsspecifikationer i klustret. NodeGroupSpec[]
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

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

NodeGroupSpec

Namn Beskrivning Värde
diskSizeGB Disklagringsstorleken för nodgruppen i GB. Exempelvärden: 128, 256, 512, 1024. Int
enableHa Om hög tillgänglighet är aktiverat i nodgruppen. Bool
sort Nodtypen som distribueras i nodgruppen. "Shard"
nodeCount Antalet noder i nodgruppen. Int
Sku Resurs-SKU:n för nodgruppen. Detta definierar storleken på processorn och minnet som etableras för varje nod. Exempelvärden: "M30", "M40". sträng

TrackedResourceTags

Namn Beskrivning Värde