Sdílet prostřednictvím

Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2019-08-01

  • Článek

Definice prostředku Bicep

Typ prostředku databaseAccounts/mongodbDatabases/collections je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2019-08-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      {customized property}: 'string'
    }
    resource: {
      id: 'string'
      indexes: [
        {
          key: {
            keys: [
              'string'
            ]
          }
          options: {
            expireAfterSeconds: int
            unique: bool
          }
        }
      ]
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Hodnoty vlastností

CreateUpdateOptions

Jméno Popis Hodnota

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Jméno Popis Hodnota
umístění Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku string (povinné)
rodič V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.		 Symbolický název prostředku typu: databaseAccounts/mongodbDatabases
vlastnosti Vlastnosti pro vytvoření a aktualizaci kolekce MongoDB služby Azure Cosmos DB MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Jméno Popis Hodnota
volby Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptions (povinné)
zdroj Standardní formát JSON kolekce MongoDB MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (povinné)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Jméno Popis Hodnota
id Název kolekce MongoDB služby Cosmos DB string (povinné)
indexy Seznam klíčů indexu MongoIndex[]
shardKey Pár klíč-hodnota klíče horizontálního oddílu, který se má použít pro požadavek. ShardKeys

MongoIndex

Jméno Popis Hodnota
klíč Klíče indexu kolekce MongoDB služby Cosmos DB MongoIndexKeys
volby Možnosti klíče indexu kolekce MongoDB služby Cosmos DB MongoIndexOptions

MongoIndexKeys

Jméno Popis Hodnota
klíče Seznam klíčů pro každou kolekci MongoDB ve službě Azure Cosmos DB string[]

MongoIndexOptions

Jméno Popis Hodnota
expireAfterSeconds Vypršení platnosti po sekundách Int
jedinečný Je jedinečný nebo ne Bool

ShardKeys

Jméno Popis Hodnota

Visačky

Jméno Popis Hodnota

Příklady použití

Ukázky rychlého startu Azure

Následující šablony Azure pro rychlý start obsahují ukázky Bicep pro nasazení tohoto typu prostředku.

Soubor Bicep Popis
vytvoření účtu služby Azure Cosmos pro rozhraní MongoDB API Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní MongoDB API 4.2 ve dvou oblastech pomocí sdílené a vyhrazené propustnosti se dvěma kolekcemi.
Vytvoření účtu služby Azure Cosmos pro automatické škálování rozhraní MongoDB API Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní MongoDB API 4.2 ve dvou oblastech s využitím sdílené i vyhrazené propustnosti automatického škálování.

Definice prostředku šablony ARM

Typ prostředku databaseAccounts/mongodbDatabases/collections je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, přidejte do šablony následující JSON.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
  "apiVersion": "2019-08-01",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "{customized property}": "string"
    },
    "resource": {
      "id": "string",
      "indexes": [
        {
          "key": {
            "keys": [ "string" ]
          },
          "options": {
            "expireAfterSeconds": "int",
            "unique": "bool"
          }
        }
      ],
      "shardKey": {
        "{customized property}": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Hodnoty vlastností

CreateUpdateOptions

Jméno Popis Hodnota

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Jméno Popis Hodnota
apiVersion Verze rozhraní API '2019-08-01'
umístění Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku string (povinné)
vlastnosti Vlastnosti pro vytvoření a aktualizaci kolekce MongoDB služby Azure Cosmos DB MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Jméno Popis Hodnota
volby Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptions (povinné)
zdroj Standardní formát JSON kolekce MongoDB MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (povinné)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Jméno Popis Hodnota
id Název kolekce MongoDB služby Cosmos DB string (povinné)
indexy Seznam klíčů indexu MongoIndex[]
shardKey Pár klíč-hodnota klíče horizontálního oddílu, který se má použít pro požadavek. ShardKeys

MongoIndex

Jméno Popis Hodnota
klíč Klíče indexu kolekce MongoDB služby Cosmos DB MongoIndexKeys
volby Možnosti klíče indexu kolekce MongoDB služby Cosmos DB MongoIndexOptions

MongoIndexKeys

Jméno Popis Hodnota
klíče Seznam klíčů pro každou kolekci MongoDB ve službě Azure Cosmos DB string[]

MongoIndexOptions

Jméno Popis Hodnota
expireAfterSeconds Vypršení platnosti po sekundách Int
jedinečný Je jedinečný nebo ne Bool

ShardKeys

Jméno Popis Hodnota

Visačky

Jméno Popis Hodnota

Příklady použití

Šablony azure pro rychlý start

Následující šablony Azure Pro rychlý start nasadit tento typ prostředku.

Šablona Popis
vytvoření účtu služby Azure Cosmos pro rozhraní MongoDB API

nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní MongoDB API 4.2 ve dvou oblastech pomocí sdílené a vyhrazené propustnosti se dvěma kolekcemi.
Vytvoření účtu služby Azure Cosmos pro automatické škálování rozhraní MongoDB API

nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní MongoDB API 4.2 ve dvou oblastech s využitím sdílené i vyhrazené propustnosti automatického škálování.

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku databaseAccounts/mongodbDatabases/collections je možné nasadit s operacemi, které cílí:

  • skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2019-08-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        {customized property} = "string"
      }
      resource = {
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

Hodnoty vlastností

CreateUpdateOptions

Jméno Popis Hodnota

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Jméno Popis Hodnota
umístění Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku string (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: databaseAccounts/mongodbDatabases
vlastnosti Vlastnosti pro vytvoření a aktualizaci kolekce MongoDB služby Azure Cosmos DB MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2019-08-01

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Jméno Popis Hodnota
volby Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptions (povinné)
zdroj Standardní formát JSON kolekce MongoDB MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (povinné)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Jméno Popis Hodnota
id Název kolekce MongoDB služby Cosmos DB string (povinné)
indexy Seznam klíčů indexu MongoIndex[]
shardKey Pár klíč-hodnota klíče horizontálního oddílu, který se má použít pro požadavek. ShardKeys

MongoIndex

Jméno Popis Hodnota
klíč Klíče indexu kolekce MongoDB služby Cosmos DB MongoIndexKeys
volby Možnosti klíče indexu kolekce MongoDB služby Cosmos DB MongoIndexOptions

MongoIndexKeys

Jméno Popis Hodnota
klíče Seznam klíčů pro každou kolekci MongoDB ve službě Azure Cosmos DB string[]

MongoIndexOptions

Jméno Popis Hodnota
expireAfterSeconds Vypršení platnosti po sekundách Int
jedinečný Je jedinečný nebo ne Bool

ShardKeys

Jméno Popis Hodnota

Visačky

Jméno Popis Hodnota