Udostępnij za pośrednictwem

Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2023-03-15

  • Artykuł

Definicja zasobu Bicep

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-03-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      id: 'string'
      indexes: [
        {
          key: {
            keys: [
              'string'
            ]
          }
          options: {
            expireAfterSeconds: int
            unique: bool
          }
        }
      ]
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
  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

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Nazwa Opis Wartość
autoskalowanieUstawienia Określa ustawienia autoskalu. AutoskalowanieUstawienia
przepustowość Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. Int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

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/mongodbDatabases
Właściwości Właściwości do tworzenia i aktualizowania kolekcji mongoDB usługi Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

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

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Nazwa Opis Wartość
analyticalStorageTtl Analityczny czas wygaśnięcia. Int
id Nazwa kolekcji MongoDB usługi Cosmos DB ciąg (wymagany)
Indeksy Lista kluczy indeksu MongoIndex []
shardKey Para klucz-wartość kluczy do zastosowania dla żądania. ShardKeys

MongoIndex

Nazwa Opis Wartość
klucz Klucze indeksu kolekcji mongoDB usługi Cosmos DB MongoIndexKeys
Opcje Opcje klucza indeksu kolekcji MongoDB usługi Cosmos DB MongoIndexOptions

MongoIndexKeys

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

MongoIndexOptions

Nazwa Opis Wartość
expireAfterSeconds Wygaśnięcie po sekundach Int
niepowtarzalny Jest unikatowy lub nie Bool

ShardKeys

Nazwa Opis Wartość

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
  "apiVersion": "2023-03-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "id": "string",
      "indexes": [
        {
          "key": {
            "keys": [ "string" ]
          },
          "options": {
            "expireAfterSeconds": "int",
            "unique": "bool"
          }
        }
      ],
      "shardKey": {
        "{customized property}": "string"
      }
    }
  },
  "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

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Nazwa Opis Wartość
autoskalowanieUstawienia Określa ustawienia autoskalu. AutoskalowanieUstawienia
przepustowość Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. Int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2023-03-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 kolekcji mongoDB usługi Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

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

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Nazwa Opis Wartość
analyticalStorageTtl Analityczny czas wygaśnięcia. Int
id Nazwa kolekcji MongoDB usługi Cosmos DB ciąg (wymagany)
Indeksy Lista kluczy indeksu MongoIndex []
shardKey Para klucz-wartość kluczy do zastosowania dla żądania. ShardKeys

MongoIndex

Nazwa Opis Wartość
klucz Klucze indeksu kolekcji mongoDB usługi Cosmos DB MongoIndexKeys
Opcje Opcje klucza indeksu kolekcji MongoDB usługi Cosmos DB MongoIndexOptions

MongoIndexKeys

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

MongoIndexOptions

Nazwa Opis Wartość
expireAfterSeconds Wygaśnięcie po sekundach Int
niepowtarzalny Jest unikatowy lub nie Bool

ShardKeys

Nazwa Opis Wartość

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-03-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        shardKey = {
          {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

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Nazwa Opis Wartość
autoskalowanieUstawienia Określa ustawienia autoskalu. AutoskalowanieUstawienia
przepustowość Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. Int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

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/mongodbDatabases
Właściwości Właściwości do tworzenia i aktualizowania kolekcji mongoDB usługi Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-03-15"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

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

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Nazwa Opis Wartość
analyticalStorageTtl Analityczny czas wygaśnięcia. Int
id Nazwa kolekcji MongoDB usługi Cosmos DB ciąg (wymagany)
Indeksy Lista kluczy indeksu MongoIndex []
shardKey Para klucz-wartość kluczy do zastosowania dla żądania. ShardKeys

MongoIndex

Nazwa Opis Wartość
klucz Klucze indeksu kolekcji mongoDB usługi Cosmos DB MongoIndexKeys
Opcje Opcje klucza indeksu kolekcji MongoDB usługi Cosmos DB MongoIndexOptions

MongoIndexKeys

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

MongoIndexOptions

Nazwa Opis Wartość
expireAfterSeconds Wygaśnięcie po sekundach Int
niepowtarzalny Jest unikatowy lub nie Bool

ShardKeys

Nazwa Opis Wartość

Tagi

Nazwa Opis Wartość