Udostępnij za pośrednictwem

Microsoft.DocumentDB mongoClusters

  • Artykuł

Definicja zasobu Bicep

Typ zasobu mongoClusters można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/mongoClusters, dodaj następujący kod Bicep do szablonu.

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

Wartości właściwości

Właściwości administratora

Nazwa Opis Wartość
hasło Hasło administratora. struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.
userName Nazwa użytkownika administratora. struna

Właściwości kopii zapasowej

Nazwa Opis Wartość

Właściwości obliczeniowe

Nazwa Opis Wartość
kondygnacja Warstwa obliczeniowa do przypisania do klastra, w której każda warstwa jest mapowana na rozmiar rdzenia wirtualnego i pamięci. Przykładowe wartości: "M30", "M40". struna

DataApiProperties

Nazwa Opis Wartość
tryb Tryb wskazujący, czy interfejs API danych Mongo jest włączony dla klastra. "Wyłączone"
"Włączone"

HighAvailabilityProperties

Nazwa Opis Wartość
targetMode Docelowy tryb wysokiej dostępności żądany dla klastra. "Wyłączone"
"Ta sama strefa"
"ZoneRedundantPreferred"

Microsoft.DocumentDB/mongoClusters

Nazwa Opis Wartość
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 3
Maksymalna długość = 3
Wzorzec = ^[a-z0-9]+(-[a-z0-9]+)* (wymagane)
Właściwości Właściwości specyficzne dla zasobu dla tego zasobu. MongoClusterProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

MongoClusterProperties

Nazwa Opis Wartość
administrator Właściwości administratora lokalnego dla klastra mongo. administrator
kopia zapasowa Właściwości kopii zapasowej klastra mongo. BackupProperties
liczyć Właściwości obliczeniowe klastra mongo. ComputeProperties
createMode Tryb tworzenia klastra mongo. "Wartość domyślna"
"GeoReplica"
"PointInTimeRestore"
"Replika"
dataApi Właściwości interfejsu API danych klastra mongo. DataApiProperties
highAvailability Właściwości wysokiej dostępności klastra mongo. HighAvailabilityProperties
previewFeatures Lista połączeń prywatnych punktów końcowych. Tablica ciągów zawierająca dowolną z:
"GeoReplicas"
publicNetworkAccess Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego klastra mongo. "Wyłączone"
"Włączone"
replicaParameters Parametry do utworzenia repliki klastra mongo. MongoClusterReplicaParameters
restoreParameters Parametry do utworzenia klastra mongo przywracania do punktu w czasie. MongoClusterRestoreParameters
serverVersion Wersja serwera Mongo DB. Wartość domyślna to najnowsza dostępna wersja, jeśli nie zostanie określona. struna
fragmentowanie Właściwości fragmentowania klastra mongo. ShardingProperties
składowanie Właściwości magazynu klastra mongo. StorageWłaściwości

MongoClusterReplicaParameters

Nazwa Opis Wartość
sourceLocation Lokalizacja klastra źródłowego ciąg (wymagany)
sourceResourceId Identyfikator klastra źródłowego replikacji. ciąg (wymagany)

MongoClusterRestoreParameters

Nazwa Opis Wartość
pointInTimeUTC Punkt CZASU UTC w celu przywrócenia klastra mongo struna
sourceResourceId Identyfikator zasobu do zlokalizowania klastra źródłowego do przywrócenia struna

ShardingProperties

Nazwa Opis Wartość
shardCount Liczba fragmentów do aprowizacji w klastrze. Int

Właściwości magazynu

Nazwa Opis Wartość
sizeGb Rozmiar dysku danych przypisany do każdego serwera. Int

TrackedResourceTags

Nazwa Opis Wartość

Definicja zasobu szablonu usługi ARM

Typ zasobu mongoClusters można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/mongoClusters, dodaj następujący kod JSON do szablonu.

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

Wartości właściwości

Właściwości administratora

Nazwa Opis Wartość
hasło Hasło administratora. struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.
userName Nazwa użytkownika administratora. struna

Właściwości kopii zapasowej

Nazwa Opis Wartość

Właściwości obliczeniowe

Nazwa Opis Wartość
kondygnacja Warstwa obliczeniowa do przypisania do klastra, w której każda warstwa jest mapowana na rozmiar rdzenia wirtualnego i pamięci. Przykładowe wartości: "M30", "M40". struna

DataApiProperties

Nazwa Opis Wartość
tryb Tryb wskazujący, czy interfejs API danych Mongo jest włączony dla klastra. "Wyłączone"
"Włączone"

HighAvailabilityProperties

Nazwa Opis Wartość
targetMode Docelowy tryb wysokiej dostępności żądany dla klastra. "Wyłączone"
"Ta sama strefa"
"ZoneRedundantPreferred"

Microsoft.DocumentDB/mongoClusters

Nazwa Opis Wartość
apiVersion Wersja interfejsu API "2024-10-01-preview"
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 3
Maksymalna długość = 3
Wzorzec = ^[a-z0-9]+(-[a-z0-9]+)* (wymagane)
Właściwości Właściwości specyficzne dla zasobu dla tego zasobu. MongoClusterProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.DocumentDB/mongoClusters"

MongoClusterProperties

Nazwa Opis Wartość
administrator Właściwości administratora lokalnego dla klastra mongo. administrator
kopia zapasowa Właściwości kopii zapasowej klastra mongo. BackupProperties
liczyć Właściwości obliczeniowe klastra mongo. ComputeProperties
createMode Tryb tworzenia klastra mongo. "Wartość domyślna"
"GeoReplica"
"PointInTimeRestore"
"Replika"
dataApi Właściwości interfejsu API danych klastra mongo. DataApiProperties
highAvailability Właściwości wysokiej dostępności klastra mongo. HighAvailabilityProperties
previewFeatures Lista połączeń prywatnych punktów końcowych. Tablica ciągów zawierająca dowolną z:
"GeoReplicas"
publicNetworkAccess Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego klastra mongo. "Wyłączone"
"Włączone"
replicaParameters Parametry do utworzenia repliki klastra mongo. MongoClusterReplicaParameters
restoreParameters Parametry do utworzenia klastra mongo przywracania do punktu w czasie. MongoClusterRestoreParameters
serverVersion Wersja serwera Mongo DB. Wartość domyślna to najnowsza dostępna wersja, jeśli nie zostanie określona. struna
fragmentowanie Właściwości fragmentowania klastra mongo. ShardingProperties
składowanie Właściwości magazynu klastra mongo. StorageWłaściwości

MongoClusterReplicaParameters

Nazwa Opis Wartość
sourceLocation Lokalizacja klastra źródłowego ciąg (wymagany)
sourceResourceId Identyfikator klastra źródłowego replikacji. ciąg (wymagany)

MongoClusterRestoreParameters

Nazwa Opis Wartość
pointInTimeUTC Punkt CZASU UTC w celu przywrócenia klastra mongo struna
sourceResourceId Identyfikator zasobu do zlokalizowania klastra źródłowego do przywrócenia struna

ShardingProperties

Nazwa Opis Wartość
shardCount Liczba fragmentów do aprowizacji w klastrze. Int

Właściwości magazynu

Nazwa Opis Wartość
sizeGb Rozmiar dysku danych przypisany do każdego serwera. Int

TrackedResourceTags

Nazwa Opis Wartość

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu mongoClusters można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/mongoClusters, dodaj następujący program Terraform do szablonu.

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

Wartości właściwości

Właściwości administratora

Nazwa Opis Wartość
hasło Hasło administratora. struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.
userName Nazwa użytkownika administratora. struna

Właściwości kopii zapasowej

Nazwa Opis Wartość

Właściwości obliczeniowe

Nazwa Opis Wartość
kondygnacja Warstwa obliczeniowa do przypisania do klastra, w której każda warstwa jest mapowana na rozmiar rdzenia wirtualnego i pamięci. Przykładowe wartości: "M30", "M40". struna

DataApiProperties

Nazwa Opis Wartość
tryb Tryb wskazujący, czy interfejs API danych Mongo jest włączony dla klastra. "Wyłączone"
"Włączone"

HighAvailabilityProperties

Nazwa Opis Wartość
targetMode Docelowy tryb wysokiej dostępności żądany dla klastra. "Wyłączone"
"Ta sama strefa"
"ZoneRedundantPreferred"

Microsoft.DocumentDB/mongoClusters

Nazwa Opis Wartość
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 3
Maksymalna długość = 3
Wzorzec = ^[a-z0-9]+(-[a-z0-9]+)* (wymagane)
Właściwości Właściwości specyficzne dla zasobu dla tego zasobu. MongoClusterProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.DocumentDB/mongoClusters@2024-10-01-preview"

MongoClusterProperties

Nazwa Opis Wartość
administrator Właściwości administratora lokalnego dla klastra mongo. administrator
kopia zapasowa Właściwości kopii zapasowej klastra mongo. BackupProperties
liczyć Właściwości obliczeniowe klastra mongo. ComputeProperties
createMode Tryb tworzenia klastra mongo. "Wartość domyślna"
"GeoReplica"
"PointInTimeRestore"
"Replika"
dataApi Właściwości interfejsu API danych klastra mongo. DataApiProperties
highAvailability Właściwości wysokiej dostępności klastra mongo. HighAvailabilityProperties
previewFeatures Lista połączeń prywatnych punktów końcowych. Tablica ciągów zawierająca dowolną z:
"GeoReplicas"
publicNetworkAccess Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego klastra mongo. "Wyłączone"
"Włączone"
replicaParameters Parametry do utworzenia repliki klastra mongo. MongoClusterReplicaParameters
restoreParameters Parametry do utworzenia klastra mongo przywracania do punktu w czasie. MongoClusterRestoreParameters
serverVersion Wersja serwera Mongo DB. Wartość domyślna to najnowsza dostępna wersja, jeśli nie zostanie określona. struna
fragmentowanie Właściwości fragmentowania klastra mongo. ShardingProperties
składowanie Właściwości magazynu klastra mongo. StorageWłaściwości

MongoClusterReplicaParameters

Nazwa Opis Wartość
sourceLocation Lokalizacja klastra źródłowego ciąg (wymagany)
sourceResourceId Identyfikator klastra źródłowego replikacji. ciąg (wymagany)

MongoClusterRestoreParameters

Nazwa Opis Wartość
pointInTimeUTC Punkt CZASU UTC w celu przywrócenia klastra mongo struna
sourceResourceId Identyfikator zasobu do zlokalizowania klastra źródłowego do przywrócenia struna

ShardingProperties

Nazwa Opis Wartość
shardCount Liczba fragmentów do aprowizacji w klastrze. Int

Właściwości magazynu

Nazwa Opis Wartość
sizeGb Rozmiar dysku danych przypisany do każdego serwera. Int

TrackedResourceTags

Nazwa Opis Wartość