Databáze Microsoft.DocumentDBAccounts/mongodbDatabases/collections 2022-11-15-preview

  • Č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@2022-11-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  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'
      }
    }
  }
}

Hodnoty vlastností

databaseAccounts/mongodbDatabases/collections

Název Description Hodnota
name Název prostředku

Přečtěte si, jak nastavit názvy a typy pro podřízené prostředky v Bicepu.		 string (povinné)
location Umístění skupiny prostředků, do které prostředek patří. řetězec
tags Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupení tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč nejvýše 128 znaků a hodnotu nesmí být větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastavené na defaultExperience: "Cassandra". Aktuální hodnoty defaultExperience zahrnují také "Table", "Graph", "DocumentDB" a "MongoDB". Slovník názvů značek a hodnot. Viz Značky v šablonách
Nadřazené V nástroji Bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost stačí 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 : mongodbDatabases
identity Identita prostředku. ManagedServiceIdentity
properties Vlastnosti pro vytvoření a aktualizaci kolekce MongoDB ve službě Azure Cosmos DB MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (povinné)

ManagedServiceIdentity

Název Description Hodnota
typ Typ identity použité pro prostředek Typ SystemAssigned,UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity. 'Žádný'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentity Seznam identit uživatelů přidružených k prostředku Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentity

ManagedServiceIdentityUserAssignedIdentity

Název Description Hodnota
{přizpůsobená vlastnost} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou jen pro čtení.

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Název Description Hodnota
možnosti Dvojice možností klíč-hodnota, které se použijí pro požadavek. To odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
prostředek Standardní formát JSON kolekce MongoDB MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (povinné)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Název Description Hodnota
nastavení automatického škálování Určuje nastavení automatického škálování. Nastavení automatického škálování
throughput Jednotky žádostí za sekundu. Například propustnost: 10000. int

Nastavení automatického škálování

Název Description Hodnota
maxThroughput Představuje maximální propustnost, na které se prostředek může vertikálně navýšit. int

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Název Description Hodnota
analyticalStorageTtl Hodnota TTL analytického úložiště. int
createMode Výčet označující režim vytváření prostředků. 'Výchozí'
Obnovit
id Název kolekce MongoDB ve službě Cosmos DB string (povinné)
Indexy Seznam klíčů indexu MongoIndex[]
obnoveníParameters Parametry označující informace o obnovení ResourceRestoreParameters
klíč horizontálního dělení Pár klíč-hodnota klíčů horizontálních oddílů, které se použijí pro požadavek. ShardKeys

MongoIndex

Název Description Hodnota
Klíč Klíče indexu kolekce MongoDB ve službě Cosmos DB MongoIndexKeys
možnosti Možnosti klíče indexu kolekce MongoDB ve službě Cosmos DB MongoIndexOptions

MongoIndexKeys

Název Description Hodnota
keys Seznam klíčů pro každou kolekci MongoDB ve službě Azure Cosmos DB string[]

MongoIndexOptions

Název Description Hodnota
expireAfterSeconds Vypršení platnosti po sekundách int
unique Je nebo není jedinečný bool

ResourceRestoreParameters

Název Description Hodnota
obnovitzdroj ID obnovitelného databázového účtu, ze kterého se má zahájit obnovení. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} řetězec
restoreTimestampInUtc Čas, do kterého musí být účet obnoven (formát ISO-8601). řetězec

ShardKeys

Název Description Hodnota
{přizpůsobená vlastnost} řetězec

Šablony pro rychlý start

Následující šablony pro rychlý start nasadí tento typ prostředku.

Template (Šablona) Description
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 s využitím 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 šablony ARM

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

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í kód JSON.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
  "apiVersion": "2022-11-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "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"
      }
    }
  }
}

Hodnoty vlastností

databaseAccounts/mongodbDatabáze/kolekce

Název Description Hodnota
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
apiVersion Verze rozhraní API prostředku 2022-11-15-preview
name Název prostředku

Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v šablonách JSON ARM.		 string (povinné)
location Umístění skupiny prostředků, do které prostředek patří. řetězec
tags Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupení tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč, který nesmí být delší než 128 znaků a hodnota nesmí být větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastavené na defaultExperience: Cassandra. Aktuální hodnoty defaultExperience také zahrnují "Table", "Graph", "DocumentDB" a "MongoDB". Slovník názvů a hodnot značek. Zobrazit značky v šablonách
identity Identita prostředku. Identita spravované služby
properties Vlastnosti pro vytvoření a aktualizaci kolekce MongoDB ve službě Azure Cosmos DB MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (povinné)

Identita spravované služby

Název Description Hodnota
typ Typ identity použitý pro prostředek. Typ SystemAssigned,UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity. 'Žádný'
'SystemAssigned'
'SystemAssigned,UserAssigned'
UserAssigned
userAssignedIdentity Seznam identit uživatelů přidružených k prostředku. Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu//subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentity

ManagedServiceIdentityUserAssignedIdentity

Název Description Hodnota
{přizpůsobená vlastnost} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou jen pro čtení.

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Název Description Hodnota
možnosti Dvojice možností klíč-hodnota, které se použijí pro požadavek. To odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
prostředek Standardní formát JSON kolekce MongoDB MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (povinné)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Název Description Hodnota
nastavení automatického škálování Určuje nastavení automatického škálování. Nastavení automatického škálování
throughput Jednotky žádostí za sekundu. Například propustnost: 10000. int

Nastavení automatického škálování

Název Description Hodnota
maxThroughput Představuje maximální propustnost, na které se prostředek může vertikálně navýšit. int

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Název Description Hodnota
analyticalStorageTtl Hodnota TTL analytického úložiště. int
createMode Výčet označující režim vytváření prostředků. 'Výchozí'
Obnovit
id Název kolekce MongoDB ve službě Cosmos DB string (povinné)
Indexy Seznam klíčů indexu MongoIndex[]
obnoveníParameters Parametry označující informace o obnovení ResourceRestoreParameters
klíč horizontálního dělení Pár klíč-hodnota klíčů horizontálních oddílů, které se použijí pro požadavek. ShardKeys

MongoIndex

Název Description Hodnota
Klíč Klíče indexu kolekce MongoDB ve službě Cosmos DB MongoIndexKeys
možnosti Možnosti klíče indexu kolekce MongoDB ve službě Cosmos DB MongoIndexOptions

MongoIndexKeys

Název Description Hodnota
keys Seznam klíčů pro každou kolekci MongoDB ve službě Azure Cosmos DB string[]

MongoIndexOptions

Název Description Hodnota
expireAfterSeconds Vypršení platnosti po sekundách int
unique Je nebo není jedinečný bool

ResourceRestoreParameters

Název Description Hodnota
obnovitzdroj ID obnovitelného databázového účtu, ze kterého se má zahájit obnovení. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} řetězec
restoreTimestampInUtc Čas, do kterého musí být účet obnoven (formát ISO-8601). řetězec

ShardKeys

Název Description Hodnota
{přizpůsobená vlastnost} řetězec

Šablony pro rychlý start

Následující šablony pro rychlý start nasadí tento typ prostředku.

Template (Šablona) Description
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 s využitím 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 Terraform (poskytovatel AzAPI)

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

  • 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@2022-11-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  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"
        }
      }
    }
  })
}

Hodnoty vlastností

databaseAccounts/mongodbDatabáze/kolekce

Název Description Hodnota
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2022-11-15-preview
name Název prostředku string (povinné)
location Umístění skupiny prostředků, do které prostředek patří. řetězec
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu : mongodbDatabases
tags Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupení tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč, který nesmí být delší než 128 znaků a hodnota nesmí být větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastavené na defaultExperience: Cassandra. Aktuální hodnoty defaultExperience také zahrnují "Table", "Graph", "DocumentDB" a "MongoDB". Slovník názvů a hodnot značek.
identity Identita prostředku. Identita spravované služby
properties Vlastnosti pro vytvoření a aktualizaci kolekce MongoDB ve službě Azure Cosmos DB MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (povinné)

Identita spravované služby

Název Description Hodnota
typ Typ identity použitý pro prostředek. Typ SystemAssigned,UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity. "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
identity_ids Seznam identit uživatelů přidružených k prostředku. Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu//subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Pole ID identit uživatelů

ManagedServiceIdentityUserAssignedIdentity

Název Description Hodnota
{přizpůsobená vlastnost} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou jen pro čtení.

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Název Description Hodnota
možnosti Dvojice možností klíč-hodnota, které se použijí pro požadavek. To odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
prostředek Standardní formát JSON kolekce MongoDB MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (povinné)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Název Description Hodnota
nastavení automatického škálování Určuje nastavení automatického škálování. Nastavení automatického škálování
throughput Jednotky žádostí za sekundu. Například propustnost: 10000. int

Nastavení automatického škálování

Název Description Hodnota
maxThroughput Představuje maximální propustnost, na které se prostředek může vertikálně navýšit. int

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Název Description Hodnota
analyticalStorageTtl Hodnota TTL analytického úložiště. int
createMode Výčet označující režim vytváření prostředků. "Výchozí"
"Obnovit"
id Název kolekce MongoDB ve službě Cosmos DB string (povinné)
Indexy Seznam klíčů indexu MongoIndex[]
obnoveníParameters Parametry označující informace o obnovení ResourceRestoreParameters
klíč horizontálního dělení Pár klíč-hodnota klíčů horizontálních oddílů, které se použijí pro požadavek. ShardKeys

MongoIndex

Název Description Hodnota
Klíč Klíče indexu kolekce MongoDB ve službě Cosmos DB MongoIndexKeys
možnosti Možnosti klíče indexu kolekce MongoDB služby Cosmos DB MongoIndexOptions

MongoIndexKeys

Název Description Hodnota
keys Seznam klíčů pro každou kolekci MongoDB ve službě Azure Cosmos DB string[]

MongoIndexOptions

Název Description Hodnota
expireAfterSeconds Vypršení platnosti po sekundách int
unique Je jedinečný nebo ne bool

ResourceRestoreParameters

Název Description Hodnota
restoreSource ID obnovitelného databázového účtu, ze kterého se má zahájit obnovení. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} řetězec
restoreTimestampInUtc Čas, do kterého musí být účet obnoven (formát ISO-8601). řetězec

ShardKeys

Název Description Hodnota
{přizpůsobená vlastnost} řetězec