Udostępnij za pośrednictwem

Baza danych Microsoft.DocumentDBAccounts/mongodbDatabases 2023-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 dziennik 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@2023-11-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      createMode: 'string'
      id: 'string'
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
      }
    }
  }
}

Wartości właściwości

databaseAccounts/mongodbDatabases

Nazwa Opis Wartość
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep.		 ciąg (wymagany)
location Lokalizacja grupy zasobów, do której należy zasób. ciąg
tags Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą być używane w wyświetlaniu i grupowaniu tego zasobu (w grupach zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawione z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
Nadrzędny W pliku 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
properties Właściwości do tworzenia i aktualizowania bazy danych MongoDB usługi Azure Cosmos DB. MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (wymagane)

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...

Nazwa Opis Wartość
opcje Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysłanym z żądaniem. CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
zasób Standardowy format JSON bazy danych MongoDB MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (wymagane)

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...

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

AutoskalowanieUstawienia

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

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...

Nazwa Opis Wartość
createMode Wyliczenie wskazujące tryb tworzenia zasobów. "Wartość domyślna"
"Przywróć"
identyfikator 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 konta bazy danych, z którego ma zostać zainicjowane 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

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

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

Wdróż na platformie 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 autoskalowania interfejsu API bazy danych MongoDB

Wdróż na platformie 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 skalowania automatycznego.

Definicja zasobu szablonu usługi ARM

Typ zasobu databaseAccounts/mongodbDatabases można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik 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": "2023-11-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "createMode": "string",
      "id": "string",
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string"
      }
    }
  }
}

Wartości właściwości

databaseAccounts/mongodbDatabases

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases"
apiVersion Wersja interfejsu API zasobów '2023-11-15'
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM w formacie JSON.		 ciąg (wymagany)
location Lokalizacja grupy zasobów, do której należy zasób. ciąg
tags Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą służyć do wyświetlania i grupowania tego zasobu (między grupami zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawiane z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
properties Właściwości do tworzenia i aktualizowania bazy danych MongoDB usługi Azure Cosmos DB. MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (wymagane)

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...

Nazwa Opis Wartość
opcje Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
zasób Standardowy format JSON bazy danych MongoDB MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (wymagane)

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...

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

AutoskalowanieUstawienia

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

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...

Nazwa Opis Wartość
createMode Wyliczenie wskazujące tryb tworzenia zasobów. "Wartość domyślna"
"Przywróć"
identyfikator 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} ciąg
restoreTimestampInUtc Czas przywrócenia konta (format ISO-8601). ciąg

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

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

Wdróż na platformie 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 automatycznego skalowania interfejsu API bazy danych MongoDB

Wdróż na platformie 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 skalowania automatycznego.

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 dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/mongodbDatabases, dodaj następujące narzędzie Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2023-11-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        createMode = "string"
        id = "string"
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
        }
      }
    }
  })
}

Wartości właściwości

databaseAccounts/mongodbDatabases

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2023-11-15"
name Nazwa zasobu ciąg (wymagany)
location Lokalizacja grupy zasobów, do której należy zasób. ciąg
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: databaseAccounts
tags Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą być używane w wyświetlaniu i grupowaniu tego zasobu (w grupach zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawione z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". Słownik nazw tagów i wartości.
properties Właściwości do tworzenia i aktualizowania bazy danych MongoDB usługi Azure Cosmos DB. MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (wymagane)

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...

Nazwa Opis Wartość
opcje Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysłanym z żądaniem. CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
zasób Standardowy format JSON bazy danych MongoDB MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (wymagane)

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...

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

AutoskalowanieUstawienia

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

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...

Nazwa Opis Wartość
createMode Wyliczenie wskazujące tryb tworzenia zasobów. "Wartość domyślna"
"Przywróć"
identyfikator 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} ciąg
restoreTimestampInUtc Czas przywrócenia konta (format ISO-8601). ciąg