Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections

  • Cikk

Bicep-erőforrásdefiníció

A databaseAccounts/mongodbDatabases/collections erőforrástípus üzembe helyezhető az alábbi célműveletekkel:

Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplóban találja.

Erőforrás formátuma

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections erőforrás létrehozásához adja hozzá a következő Bicep-et a sablonhoz.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-02-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'
        restoreWithTtlDisabled: bool
      }
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
}

Tulajdonságértékek

databaseAccounts/mongodbDatabases/collections

Név Leírás Érték
name Az erőforrás neve

Megtudhatja, hogyan állíthatja be a gyermekerőforrások nevét és típusát a Bicepben.		 sztring (kötelező)
location Annak az erőforráscsoportnak a helye, amelyhez az erőforrás tartozik. sztring
tags A címkék az erőforrást leíró kulcs-érték párok listája. Ezek a címkék használhatók az erőforrás megtekintéséhez és csoportosításához (erőforráscsoportok között). Egy erőforráshoz legfeljebb 15 címke adható meg. Minden címkének 128 karakternél nem nagyobb és 256 karakternél nem nagyobb értékű kulcsnak kell lennie. Egy sablontípus alapértelmezett felülete például "defaultExperience": "Cassandra". A jelenlegi "defaultExperience" értékek közé tartozik a "Table", a "Graph", a "DocumentDB" és a "MongoDB". Címkenevek és -értékek szótára. Címkék megtekintése sablonokban
Szülő A Bicepben megadhatja egy gyermekerőforrás szülőerőforrását. Ezt a tulajdonságot csak akkor kell hozzáadnia, ha a gyermekerőforrás a szülőerőforráson kívül van deklarálva.

További információ: Gyermekerőforrás a szülőerőforráson kívül.		 A típus erőforrásának szimbolikus neve: mongodbDatabases
identity Az erőforrás identitása. ManagedServiceIdentity
properties Tulajdonságok az Azure Cosmos DB MongoDB-gyűjtemény létrehozásához és frissítéséhez. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (kötelező)

ManagedServiceIdentity

Név Leírás Érték
típus "Nincs"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned": Az erőforráshoz használt identitás típusa. A "SystemAssigned,UserAssigned" típus magában foglal egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból.
userAssignedIdentities Az erőforráshoz társított felhasználói identitások listája. A felhasználói identitás szótárának kulcshivatkozásai a következő űrlapon található ARM-erőforrás-azonosítók: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Név Leírás Érték
{testreszabott tulajdonság} Összetevők1Jq1T4ISchemasManagedserviceidentityProper...

Összetevők1Jq1T4ISchemasManagedserviceidentityProper...

Ez az objektum nem tartalmaz az üzembe helyezés során beállítandó tulajdonságokat. Minden tulajdonság a ReadOnly.

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Név Leírás Érték
Lehetőségek A kérelemhez alkalmazandó kulcs-érték beállításpár. Ez a kéréssel küldött fejléceknek felel meg. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
erőforrás MongoDB-gyűjtemény szabványos JSON-formátuma MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (kötelező)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Név Leírás Érték
automatikus skálázásBeállítások Megadja az automatikus skálázás beállításait. Megjegyzés: Az átviteli sebesség vagy az automatikus skálázásBeállítások megadása kötelező, de nem mindkettő. Automatikus skálázásbeállítások
korlátozások Kérelemegységek másodpercenként. Például az "átviteli sebesség": 10000. int

Automatikus skálázásbeállítások

Név Leírás Érték
maxThroughput A maximális átviteli sebességet jelöli, az erőforrás vertikálisan felskálázható. int

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Név Leírás Érték
analyticalStorageTtl Elemzési TTL. int
createMode Szám az erőforrás-létrehozás módjának jelzéséhez. "Alapértelmezett"
"PointInTimeRestore"
"Visszaállítás"
id A Cosmos DB MongoDB-gyűjtemény neve sztring (kötelező)
Indexek Indexkulcsok listája MongoIndex[]
restoreParameters A visszaállítással kapcsolatos információkat jelző paraméterek ResourceRestoreParameters
shardKey A kérelemhez alkalmazni kívánt szegmenskulcsok kulcs-érték párja. ShardKeys

MongoIndex

Név Leírás Érték
kulcs Cosmos DB MongoDB-gyűjtemény indexkulcsai MongoIndexKeys
Lehetőségek A Cosmos DB MongoDB-gyűjtemény indexkulcsának beállításai MongoIndexOptions

MongoIndexKeys

Név Leírás Érték
keys Az Azure Cosmos DB szolgáltatásban található egyes MongoDB-gyűjtemények kulcsainak listája sztring[]

MongoIndexOptions

Név Leírás Érték
expireAfterSeconds Lejárat másodpercek után int
Egyedi Egyedi vagy nem logikai

ResourceRestoreParameters

Név Leírás Érték
restoreSource Annak a visszaállítható adatbázisfióknak az azonosítója, amelyről a visszaállítást el kell indítani. Például: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} sztring
restoreTimestampInUtc A fiók visszaállításának időpontja (ISO-8601 formátum). sztring
restoreWithTtlDisabled Meghatározza, hogy a visszaállított fiókban le lesz-e tiltva az élettartam a sikeres visszaállításkor. logikai

ShardKeys

Név Leírás Érték
{testreszabott tulajdonság} sztring

Gyorssablonok

Az alábbi rövid útmutatósablonok ezt az erőforrástípust helyezik üzembe.

Sablon Description
Azure Cosmos-fiók létrehozása a MongoDB API-hoz

Üzembe helyezés az Azure-ban		 Ez a sablon létrehoz egy Azure Cosmos DB-fiókot a MongoDB API 4.2-hez két régióban, megosztott és dedikált átviteli sebességgel két gyűjtemény használatával.
Azure Cosmos-fiók létrehozása automatikus MongoDB API-skálázáshoz

Üzembe helyezés az Azure-ban		 Ez a sablon létrehoz egy Azure Cosmos DB-fiókot a MongoDB API 4.2-hez két régióban, megosztott és dedikált automatikus skálázási átviteli sebesség használatával.

ARM-sablon erőforrásdefiníciója

A databaseAccounts/mongodbDatabases/collections erőforrástípus üzembe helyezhető az alábbi célműveletekkel:

Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplóban találja.

Erőforrás formátuma

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections erőforrás létrehozásához adja hozzá a következő JSON-t a sablonhoz.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
  "apiVersion": "2024-02-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",
        "restoreWithTtlDisabled": "bool"
      },
      "shardKey": {
        "{customized property}": "string"
      }
    }
  }
}

Tulajdonságértékek

databaseAccounts/mongodbDatabases/collections

Név Leírás Érték
típus Az erőforrás típusa "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections"
apiVersion Az erőforrás API-verziója "2024-02-15-preview"
name Az erőforrás neve

Megtudhatja, hogyan állíthatja be a gyermekerőforrások nevét és típusát A JSON ARM-sablonokban.		 sztring (kötelező)
location Annak az erőforráscsoportnak a helye, amelyhez az erőforrás tartozik. sztring
tags A címkék az erőforrást leíró kulcs-érték párok listája. Ezek a címkék használhatók az erőforrás megtekintéséhez és csoportosításához (erőforráscsoportok között). Egy erőforráshoz legfeljebb 15 címke adható meg. Minden címkének 128 karakternél nem nagyobb és 256 karakternél nem nagyobb értékű kulcsnak kell lennie. Egy sablontípus alapértelmezett felülete például "defaultExperience": "Cassandra". A jelenlegi "defaultExperience" értékek közé tartozik a "Table", a "Graph", a "DocumentDB" és a "MongoDB". Címkenevek és -értékek szótára. Címkék megtekintése sablonokban
identity Az erőforrás identitása. ManagedServiceIdentity
properties Tulajdonságok az Azure Cosmos DB MongoDB-gyűjtemény létrehozásához és frissítéséhez. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (kötelező)

ManagedServiceIdentity

Név Leírás Érték
típus "Nincs"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned": Az erőforráshoz használt identitás típusa. A "SystemAssigned,UserAssigned" típus magában foglal egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból.
userAssignedIdentities Az erőforráshoz társított felhasználói identitások listája. A felhasználói identitás szótárának kulcshivatkozásai a következő űrlapon található ARM-erőforrás-azonosítók: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Név Leírás Érték
{testreszabott tulajdonság} Összetevők1Jq1T4ISchemasManagedserviceidentityProper...

Összetevők1Jq1T4ISchemasManagedserviceidentityProper...

Ez az objektum nem tartalmaz az üzembe helyezés során beállítandó tulajdonságokat. Minden tulajdonság a ReadOnly.

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Név Leírás Érték
Lehetőségek A kérelemhez alkalmazandó kulcs-érték beállításpár. Ez a kéréssel küldött fejléceknek felel meg. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
erőforrás MongoDB-gyűjtemény szabványos JSON-formátuma MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (kötelező)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Név Leírás Érték
automatikus skálázásBeállítások Megadja az automatikus skálázás beállításait. Megjegyzés: Az átviteli sebesség vagy az automatikus skálázásBeállítások megadása kötelező, de nem mindkettő. Automatikus skálázásbeállítások
korlátozások Kérelemegységek másodpercenként. Például az "átviteli sebesség": 10000. int

Automatikus skálázásbeállítások

Név Leírás Érték
maxThroughput A maximális átviteli sebességet jelöli, az erőforrás vertikálisan felskálázható. int

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Név Leírás Érték
analyticalStorageTtl Elemzési TTL. int
createMode Szám az erőforrás-létrehozás módjának jelzéséhez. "Alapértelmezett"
"PointInTimeRestore"
"Visszaállítás"
id A Cosmos DB MongoDB-gyűjtemény neve sztring (kötelező)
Indexek Indexkulcsok listája MongoIndex[]
restoreParameters A visszaállítással kapcsolatos információkat jelző paraméterek ResourceRestoreParameters
shardKey A kérelemhez alkalmazni kívánt szegmenskulcsok kulcs-érték párja. ShardKeys

MongoIndex

Név Leírás Érték
kulcs Cosmos DB MongoDB-gyűjtemény indexkulcsai MongoIndexKeys
Lehetőségek A Cosmos DB MongoDB-gyűjtemény indexkulcsának beállításai MongoIndexOptions

MongoIndexKeys

Név Leírás Érték
keys Az Azure Cosmos DB szolgáltatásban található egyes MongoDB-gyűjtemények kulcsainak listája sztring[]

MongoIndexOptions

Név Leírás Érték
expireAfterSeconds Lejárat másodpercek után int
Egyedi Egyedi vagy nem logikai

ResourceRestoreParameters

Név Leírás Érték
restoreSource Annak a visszaállítható adatbázisfióknak az azonosítója, amelyről a visszaállítást el kell indítani. Például: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} sztring
restoreTimestampInUtc A fiók visszaállításának időpontja (ISO-8601 formátum). sztring
restoreWithTtlDisabled Meghatározza, hogy a visszaállított fiókban le lesz-e tiltva az élettartam a sikeres visszaállításkor. logikai

ShardKeys

Név Leírás Érték
{testreszabott tulajdonság} sztring

Gyorssablonok

Az alábbi rövid útmutatósablonok ezt az erőforrástípust helyezik üzembe.

Sablon Description
Azure Cosmos-fiók létrehozása a MongoDB API-hoz

Üzembe helyezés az Azure-ban		 Ez a sablon létrehoz egy Azure Cosmos DB-fiókot a MongoDB API 4.2-hez két régióban, megosztott és dedikált átviteli sebességgel két gyűjtemény használatával.
Azure Cosmos-fiók létrehozása automatikus MongoDB API-skálázáshoz

Üzembe helyezés az Azure-ban		 Ez a sablon létrehoz egy Azure Cosmos DB-fiókot a MongoDB API 4.2-hez két régióban, megosztott és dedikált automatikus skálázási átviteli sebesség használatával.

Terraform (AzAPI-szolgáltató) erőforrásdefiníció

A databaseAccounts/mongodbDatabases/collections erőforrástípus üzembe helyezhető az alábbi célműveletekkel:

  • Erőforráscsoportok

Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplóban találja.

Erőforrás formátuma

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections erőforrás létrehozásához adja hozzá a következő Terraformot a sablonhoz.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-02-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"
          restoreWithTtlDisabled = bool
        }
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

Tulajdonságértékek

databaseAccounts/mongodbDatabases/collections

Név Leírás Érték
típus Az erőforrás típusa "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-02-15-preview"
name Az erőforrás neve sztring (kötelező)
location Annak az erőforráscsoportnak a helye, amelyhez az erőforrás tartozik. sztring
parent_id Annak az erőforrásnak az azonosítója, amely ennek az erőforrásnak a szülője. A következő típusú erőforrás azonosítója: mongodbDatabases
tags A címkék az erőforrást leíró kulcs-érték párok listája. Ezek a címkék használhatók az erőforrás megtekintéséhez és csoportosításához (erőforráscsoportok között). Egy erőforráshoz legfeljebb 15 címke adható meg. Minden címkének 128 karakternél nem hosszabb és 256 karakternél nem nagyobb értékű kulcsnak kell lennie. Egy sablontípus alapértelmezett felülete például a "defaultExperience": "Cassandra" értékre van állítva. Az aktuális "defaultExperience" értékek közé tartozik a "Table", a "Graph", a "DocumentDB" és a "MongoDB" is. Címkenevek és -értékek szótára.
identity Az erőforrás identitása. ManagedServiceIdentity
properties Tulajdonságok az Azure Cosmos DB MongoDB-gyűjtemény létrehozásához és frissítéséhez. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (kötelező)

ManagedServiceIdentity

Név Leírás Érték
típus "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned": Az erőforráshoz használt identitás típusa. A "SystemAssigned,UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból.
identity_ids Az erőforráshoz társított felhasználói identitások listája. A felhasználói identitás szótárkulcs-hivatkozásai ARM-erőforrásazonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". Felhasználói identitásazonosítók tömbje.

ManagedServiceIdentityUserAssignedIdentities

Név Leírás Érték
{customized property} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Ez az objektum nem tartalmaz az üzembe helyezés során beállítandó tulajdonságokat. Minden tulajdonság readOnly.

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Név Leírás Érték
Lehetőségek A kérelemre alkalmazandó kulcs-érték beállításpár. Ez megfelel a kéréssel küldött fejléceknek. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
erőforrás MongoDB-gyűjtemény szabványos JSON-formátuma MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (kötelező)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Név Leírás Érték
automatikus skálázásBeállítások Megadja az automatikus skálázás beállításait. Megjegyzés: Az átviteli sebesség vagy az automatikus skálázásBeállítások megadása kötelező, de nem mindkettő. Automatikus skálázásbeállítások
korlátozások Kérelemegységek másodpercenként. Például: "átviteli sebesség": 10000. int

Automatikus skálázásbeállítások

Név Leírás Érték
maxThroughput A maximális átviteli sebességet jelöli, az erőforrás vertikálisan felskálázható. int

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Név Leírás Érték
analyticalStorageTtl Elemzési TTL. int
createMode Enumerálás az erőforrás-létrehozás módjának jelzésére. "Alapértelmezett"
"PointInTimeRestore"
"Visszaállítás"
id A Cosmos DB MongoDB-gyűjtemény neve sztring (kötelező)
Indexek Indexkulcsok listája MongoIndex[]
restoreParameters A visszaállítással kapcsolatos információkat jelző paraméterek ResourceRestoreParameters
shardKey A kérelemhez alkalmazni kívánt szegmenskulcsok kulcs-érték párja. ShardKeys

MongoIndex

Név Leírás Érték
kulcs Cosmos DB MongoDB-gyűjtemény indexkulcsai MongoIndexKeys
Lehetőségek A Cosmos DB MongoDB-gyűjtemény indexkulcsának beállításai MongoIndexOptions

MongoIndexKeys

Név Leírás Érték
keys Az Azure Cosmos DB szolgáltatásban található egyes MongoDB-gyűjtemények kulcsainak listája sztring[]

MongoIndexOptions

Név Leírás Érték
expireAfterSeconds Lejárat másodpercek után int
Egyedi Egyedi vagy nem logikai

ResourceRestoreParameters

Név Leírás Érték
restoreSource Annak a visszaállítható adatbázisfióknak az azonosítója, amelyről a visszaállítást el kell indítani. Például: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} sztring
restoreTimestampInUtc A fiók visszaállításának időpontja (ISO-8601 formátum). sztring
restoreWithTtlDisabled Meghatározza, hogy a visszaállított fiókban le lesz-e tiltva az élettartam a sikeres visszaállításkor. logikai

ShardKeys

Név Leírás Érték
{testreszabott tulajdonság} sztring