Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2024-05-15

• Najnowsza
• 2024-05-15
• 2024-05-15-preview
• 2024-02-15-preview
• 2023-11-15
• 2023-11-15-preview
• 2023-09-15
• 2023-09-15-preview
• 2023-04-15
• 2023-03-15
• 2023-03-15-preview
• 2023-03-01-preview
• 2022-11-15
• 2022-11-15-preview
• 2022-08-15
• 2022-08-15-preview
• 2022-05-15
• 2022-05-15-preview
• 2022-02-15-preview
• 2021-11-15-preview
• 2021-10-15
• 2021-10-15-preview
• 2021-07-01-preview
• 2021-06-15
• 2021-05-15
• 2021-04-15
• 2021-04-01-preview
• 2021-03-15
• 2021-03-01-preview
• 2021-01-15
• 2020-09-01
• 2020-06-01-preview
• 2020-04-01
• 2020-03-01
• 2019-12-12
• 2019-08-01

Definicja zasobu Bicep

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

• Grupy zasobów — zobacz polecenia wdrażania 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/collections, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-05-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      createMode: 'string'
      id: 'string'
      indexes: [
        {
          key: {
            keys: [
              'string'
            ]
          }
          options: {
            expireAfterSeconds: int
            unique: bool
          }
        }
      ]
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
      }
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
}

Wartości właściwości

databaseAccounts/mongodbDatabases/collections

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ą 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
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: mongodbDatabases
properties	Właściwości do tworzenia i aktualizowania kolekcji bazy danych MongoDB w usłudze Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (wymagane)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

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

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Nazwa	Opis	Wartość
analyticalStorageTtl	Analityczny czas wygaśnięcia.	int
createMode	Wyliczenie wskazujące tryb tworzenia zasobów.	"Wartość domyślna" "Przywróć"
identyfikator	Nazwa kolekcji Bazy danych MongoDB usługi Cosmos DB	ciąg (wymagany)
Indeksy	Lista kluczy indeksu	MongoIndex[]
restoreParameters	Parametry wskazujące informacje o przywracaniu	ResourceRestoreParameters
shardKey	Para klucz-wartość kluczy, które mają być stosowane do żądania.	ShardKeys

MongoIndex

Nazwa	Opis	Wartość
key	Klucze indeksu kolekcji Bazy danych MongoDB w usłudze Cosmos DB	MongoIndexKeys
opcje	Opcje klucza indeksu kolekcji MongoDB usługi Cosmos DB	MongoIndexOptions

MongoIndexKeys

Nazwa	Opis	Wartość
keys	Lista kluczy dla każdej kolekcji bazy danych MongoDB w usłudze Azure Cosmos DB	ciąg[]

MongoIndexOptions

Nazwa	Opis	Wartość
expireAfterSeconds	Wygasanie po sekundach	int
unique	Jest unikatowa lub nie	bool

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

ShardKeys

Nazwa	Opis	Wartość
{niestandardowa właściwość}		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	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	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/collections można wdrożyć z operacjami docelowymi:

• Grupy zasobów — zobacz polecenia wdrażania 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/collections, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
  "apiVersion": "2024-05-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "createMode": "string",
      "id": "string",
      "indexes": [
        {
          "key": {
            "keys": [ "string" ]
          },
          "options": {
            "expireAfterSeconds": "int",
            "unique": "bool"
          }
        }
      ],
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string"
      },
      "shardKey": {
        "{customized property}": "string"
      }
    }
  }
}

Wartości właściwości

databaseAccounts/mongodbDatabases/collections

Nazwa	Opis	Wartość
typ	Typ zasobu	"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections"
apiVersion	Wersja interfejsu API zasobów	'2024-05-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 kolekcji bazy danych MongoDB w usłudze Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (wymagane)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

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

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Nazwa	Opis	Wartość
analyticalStorageTtl	Analityczny czas wygaśnięcia.	int
createMode	Wyliczenie wskazujące tryb tworzenia zasobów.	"Wartość domyślna" "Przywróć"
identyfikator	Nazwa kolekcji bazy danych MongoDB usługi Cosmos DB	ciąg (wymagany)
Indeksy	Lista kluczy indeksu	MongoIndex[]
restoreParameters	Parametry wskazujące informacje o przywracaniu	ResourceRestoreParameters
klucz fragmentu	Para klucz-wartość kluczy do zastosowania dla żądania.	ShardKeys

Indeks Mongo

Nazwa	Opis	Wartość
key	Klucze indeksu kolekcji bazy danych MongoDB w usłudze Cosmos DB	MongoIndexKeys
opcje	Opcje klucza indeksu kolekcji Bazy danych MongoDB w usłudze Cosmos DB	MongoIndexOptions

MongoIndexKeys

Nazwa	Opis	Wartość
keys	Lista kluczy dla każdej kolekcji bazy danych MongoDB w usłudze Azure Cosmos DB	ciąg[]

MongoIndexOptions

Nazwa	Opis	Wartość
expireAfterSeconds	Wygaśnięcie po sekundach	int
unique	Jest unikatowy lub nie	bool

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

ShardKeys

Nazwa	Opis	Wartość
{niestandardowa właściwość}		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	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	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/collections można wdrożyć z operacjami docelowymi:

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-05-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        createMode = "string"
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
        }
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

Wartości właściwości

databaseAccounts/mongodbDatabases/collections

Nazwa	Opis	Wartość
typ	Typ zasobu	"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-05-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: mongodbDatabases
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.
properties	Właściwości do tworzenia i aktualizowania kolekcji bazy danych MongoDB w usłudze Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (wymagane)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

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

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Nazwa	Opis	Wartość
analyticalStorageTtl	Analityczny czas wygaśnięcia.	int
createMode	Wyliczenie wskazujące tryb tworzenia zasobów.	"Wartość domyślna" "Przywróć"
identyfikator	Nazwa kolekcji bazy danych MongoDB usługi Cosmos DB	ciąg (wymagany)
Indeksy	Lista kluczy indeksu	MongoIndex[]
restoreParameters	Parametry wskazujące informacje o przywracaniu	ResourceRestoreParameters
klucz fragmentu	Para klucz-wartość kluczy do zastosowania dla żądania.	ShardKeys

Indeks Mongo

Nazwa	Opis	Wartość
key	Klucze indeksu kolekcji bazy danych MongoDB w usłudze Cosmos DB	MongoIndexKeys
opcje	Opcje klucza indeksu kolekcji Bazy danych MongoDB w usłudze Cosmos DB	MongoIndexOptions

MongoIndexKeys

Nazwa	Opis	Wartość
keys	Lista kluczy dla każdej kolekcji bazy danych MongoDB w usłudze Azure Cosmos DB	ciąg[]

MongoIndexOptions

Nazwa	Opis	Wartość
expireAfterSeconds	Wygaśnięcie po sekundach	int
unique	Jest unikatowy lub nie	bool

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

ShardKeys

Nazwa	Opis	Wartość
{niestandardowa właściwość}		ciąg