Udostępnij za pośrednictwem

Microsoft.DocumentDB databaseAccounts/mongodbDatabases 2024-11-15

  • Artykuł

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@2024-11-15' = {
  parent: resourceSymbolicName
  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

AutoskalowanieUstawienia

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

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions

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

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases

Nazwa Opis Wartość
lokalizacja Lokalizacja grupy zasobów, do której należy zasób. struna
nazwa Nazwa zasobu ciąg (wymagany)
rodzic 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

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 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 wskazujące informacje o przywracaniu ResourceRestoreParameters

ResourceRestoreParameters

Nazwa Opis Wartość
restoreSource Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} struna
restoreTimestampInUtc Godzina przywrócenia konta (format ISO-8601). struna
restoreWithTtlDisabled 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": "2024-11-15",
  "name": "string",
  "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

AutoskalowanieUstawienia

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

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions

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

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2024-11-15'
lokalizacja Lokalizacja grupy zasobów, do której należy zasób. struna
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"

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 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 wskazujące informacje o przywracaniu ResourceRestoreParameters

ResourceRestoreParameters

Nazwa Opis Wartość
restoreSource Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} struna
restoreTimestampInUtc Godzina przywrócenia konta (format ISO-8601). struna
restoreWithTtlDisabled 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:

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2024-11-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    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

AutoskalowanieUstawienia

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

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions

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

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases

Nazwa Opis Wartość
lokalizacja Lokalizacja grupy zasobów, do której należy zasób. struna
nazwa Nazwa zasobu ciąg (wymagany)
parent_id 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@2024-11-15"

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 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 wskazujące informacje o przywracaniu ResourceRestoreParameters

ResourceRestoreParameters

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

Tagi

Nazwa Opis Wartość