Udostępnij przez


Baza danych Microsoft.DocumentDBAccounts/mongodbDatabases

Definicja zasobu Bicep

Typ zasobu databaseAccounts/mongodbDatabases 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/databaseAccounts/mongodbDatabases, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2025-11-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      createMode: 'string'
      id: 'string'
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Wartości właściwości

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases

Nazwa Opis Wartość
tożsamość Tożsamość zasobu. ManagedServiceIdentity (tożsamość usługi)
lokalizacja Lokalizacja grupy zasobów, do której należy zasób. ciąg
nazwa Nazwa zasobu ciąg (wymagany)
nadrzędny W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.
Nazwa symboliczna zasobu typu: databaseAccounts
Właściwości Właściwości do tworzenia i aktualizowania bazy danych MongoDB usługi Azure Cosmos DB. MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

AutoskalowanieUstawienia

Nazwa Opis Wartość
maxThroughput (maksymalna przepływność) Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nazwa Opis Wartość

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions

Nazwa Opis Wartość
autoskalowanieUstawienia Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie. AutoskalowanieUstawienia
przepływność Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. Int

ManagedServiceIdentity (tożsamość usługi)

Nazwa Opis Wartość
typ Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. "Brak"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
tożsamości przypisane użytkownikom Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nazwa Opis Wartość

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties

Nazwa Opis Wartość
Opcje Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions
zasób Standardowy format JSON bazy danych MongoDB MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource (wymagane)

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource

Nazwa Opis Wartość
createMode (tryb tworzenia) Wyliczenie wskazujące tryb tworzenia zasobów. "Wartość domyślna"
"Przywracanie"
id Nazwa bazy danych MongoDB usługi Cosmos DB ciąg (wymagany)
restoreParameters (parametry przywracania) Parametry wskazujące informacje o przywracaniu ResourceRestoreParameters

ResourceRestoreParameters

Nazwa Opis Wartość
restoreSource (przywróć źródło) Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} ciąg
restoreTimestampInUtc Godzina przywrócenia konta (format ISO-8601). ciąg
restoreWithTtlDisabled (przywracać z TtlDisabled) Określa, czy przywrócone konto będzie mieć czas-To-Live wyłączone po pomyślnym przywróceniu. Bool

Tagi

Nazwa Opis Wartość

Przykłady użycia

Przykłady szybkiego startu platformy Azure

Poniższe szablony szybkiego startu platformy Azure zawierają przykłady Bicep na potrzeby wdrażania tego typu zasobu.

Plik Bicep Opis
Tworzenie konta usługi Azure Cosmos dla interfejsu API bazy danych MongoDB Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API bazy danych MongoDB 4.2 w dwóch regionach przy użyciu udostępnionej i dedykowanej przepływności z dwiema kolekcjami.
Tworzenie konta usługi Azure Cosmos dla interfejsu API bazy danych MongoDB Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API bazy danych MongoDB 4.2 w dwóch regionach przy użyciu udostępnionej i dedykowanej przepływności autoskalowania.

Definicja zasobu szablonu usługi ARM

Typ zasobu databaseAccounts/mongodbDatabases 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/databaseAccounts/mongodbDatabases, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases",
  "apiVersion": "2025-11-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "createMode": "string",
      "id": "string",
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Wartości właściwości

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) Wersja interfejsu API "2025-11-01-podgląd"
tożsamość Tożsamość zasobu. ManagedServiceIdentity (tożsamość usługi)
lokalizacja Lokalizacja grupy zasobów, do której należy zasób. ciąg
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości do tworzenia i aktualizowania bazy danych MongoDB usługi Azure Cosmos DB. MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases"

AutoskalowanieUstawienia

Nazwa Opis Wartość
maxThroughput (maksymalna przepływność) Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nazwa Opis Wartość

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions

Nazwa Opis Wartość
autoskalowanieUstawienia Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie. AutoskalowanieUstawienia
przepływność Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. Int

ManagedServiceIdentity (tożsamość usługi)

Nazwa Opis Wartość
typ Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. "Brak"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
tożsamości przypisane użytkownikom Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nazwa Opis Wartość

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties

Nazwa Opis Wartość
Opcje Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions
zasób Standardowy format JSON bazy danych MongoDB MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource (wymagane)

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource

Nazwa Opis Wartość
createMode (tryb tworzenia) Wyliczenie wskazujące tryb tworzenia zasobów. "Wartość domyślna"
"Przywracanie"
id Nazwa bazy danych MongoDB usługi Cosmos DB ciąg (wymagany)
restoreParameters (parametry przywracania) Parametry wskazujące informacje o przywracaniu ResourceRestoreParameters

ResourceRestoreParameters

Nazwa Opis Wartość
restoreSource (przywróć źródło) Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} ciąg
restoreTimestampInUtc Godzina przywrócenia konta (format ISO-8601). ciąg
restoreWithTtlDisabled (przywracać z TtlDisabled) Określa, czy przywrócone konto będzie mieć czas-To-Live wyłączone po pomyślnym przywróceniu. Bool

Tagi

Nazwa Opis Wartość

Przykłady użycia

Szablony szybkiego startu platformy Azure

Następujące szablony szybkiego startu platformy Azure wdrożyć ten typ zasobu.

Szablon Opis
Tworzenie konta usługi Azure Cosmos dla interfejsu API bazy danych MongoDB

wdrażanie w usłudze Azure
Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API bazy danych MongoDB 4.2 w dwóch regionach przy użyciu udostępnionej i dedykowanej przepływności z dwiema kolekcjami.
Tworzenie konta usługi Azure Cosmos dla interfejsu API bazy danych MongoDB

wdrażanie w usłudze Azure
Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API bazy danych MongoDB 4.2 w dwóch regionach przy użyciu udostępnionej i dedykowanej przepływności autoskalowania.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu databaseAccounts/mongodbDatabases 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/databaseAccounts/mongodbDatabases, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2025-11-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        createMode = "string"
        id = "string"
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
      }
    }
  }
}

Wartości właściwości

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases

Nazwa Opis Wartość
tożsamość Tożsamość zasobu. ManagedServiceIdentity (tożsamość usługi)
lokalizacja Lokalizacja grupy zasobów, do której należy zasób. ciąg
nazwa Nazwa zasobu ciąg (wymagany)
parent_id (identyfikator rodzica) Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: databaseAccounts
Właściwości Właściwości do tworzenia i aktualizowania bazy danych MongoDB usługi Azure Cosmos DB. MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2025-11-01-preview"

AutoskalowanieUstawienia

Nazwa Opis Wartość
maxThroughput (maksymalna przepływność) Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nazwa Opis Wartość

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions

Nazwa Opis Wartość
autoskalowanieUstawienia Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie. AutoskalowanieUstawienia
przepływność Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. Int

ManagedServiceIdentity (tożsamość usługi)

Nazwa Opis Wartość
typ Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. "Brak"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
tożsamości przypisane użytkownikom Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nazwa Opis Wartość

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties

Nazwa Opis Wartość
Opcje Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions
zasób Standardowy format JSON bazy danych MongoDB MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource (wymagane)

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource

Nazwa Opis Wartość
createMode (tryb tworzenia) Wyliczenie wskazujące tryb tworzenia zasobów. "Wartość domyślna"
"Przywracanie"
id Nazwa bazy danych MongoDB usługi Cosmos DB ciąg (wymagany)
restoreParameters (parametry przywracania) Parametry wskazujące informacje o przywracaniu ResourceRestoreParameters

ResourceRestoreParameters

Nazwa Opis Wartość
restoreSource (przywróć źródło) Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} ciąg
restoreTimestampInUtc Godzina przywrócenia konta (format ISO-8601). ciąg
restoreWithTtlDisabled (przywracać z TtlDisabled) Określa, czy przywrócone konto będzie mieć czas-To-Live wyłączone po pomyślnym przywróceniu. Bool

Tagi

Nazwa Opis Wartość

Przykłady użycia

Przykłady programu Terraform

Podstawowy przykład wdrażania bazy danych Mongo Database na koncie usługi Cosmos DB.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "databaseAccount" {
  type      = "Microsoft.DocumentDB/databaseAccounts@2021-10-15"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "MongoDB"
    properties = {
      capabilities = [
        {
          name = "EnableMongo"
        },
      ]
      consistencyPolicy = {
        defaultConsistencyLevel = "Strong"
        maxIntervalInSeconds    = 5
        maxStalenessPrefix      = 100
      }
      databaseAccountOfferType           = "Standard"
      defaultIdentity                    = "FirstPartyIdentity"
      disableKeyBasedMetadataWriteAccess = false
      disableLocalAuth                   = false
      enableAnalyticalStorage            = false
      enableAutomaticFailover            = false
      enableFreeTier                     = false
      enableMultipleWriteLocations       = false
      ipRules = [
      ]
      isVirtualNetworkFilterEnabled = false
      locations = [
        {
          failoverPriority = 0
          isZoneRedundant  = false
          locationName     = "West Europe"
        },
      ]
      networkAclBypass = "None"
      networkAclBypassResourceIds = [
      ]
      publicNetworkAccess = "Enabled"
      virtualNetworkRules = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "mongodbDatabase" {
  type      = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-10-15"
  parent_id = azapi_resource.databaseAccount.id
  name      = var.resource_name
  body = {
    properties = {
      options = {
      }
      resource = {
        id = var.resource_name
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}