Delen via

Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collecties 2023-11-15

Bicep-resourcedefinitie

Het resourcetype databaseAccounts/mongodbDatabases/collections kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-11-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  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'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Eigenschapswaarden

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Naam Beschrijving Waarde
plaats De locatie van de resourcegroep waartoe de resource behoort. snaar
naam De resourcenaam tekenreeks (vereist)
ouder In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd.

Zie onderliggende resource buiten de bovenliggende resourcevoor meer informatie.		 Symbolische naam voor resource van het type: databaseAccounts/mongodbDatabases
Eigenschappen Eigenschappen voor het maken en bijwerken van azure Cosmos DB MongoDB-verzameling. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (vereist)
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen

Instellingen voor automatisch schalen

Naam Beschrijving Waarde
maximale doorvoer Vertegenwoordigt de maximale doorvoer, de resource kan omhoog worden geschaald. Int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Naam Beschrijving Waarde
autoscale-instellingen Hiermee geeft u de instellingen voor automatisch schalen. Opmerking: doorvoer of autoscaleSettings is vereist, maar niet beide. Instellingen voor automatisch schalen
Doorvoer Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. Int

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Naam Beschrijving Waarde
Opties Een sleutel-waardepaar met opties die moeten worden toegepast voor de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions-
hulpbron De standaard JSON-indeling van een MongoDB-verzameling MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (vereist)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Naam Beschrijving Waarde
analyticalStorageTtl Analytische TTL. Int
createMode Opsomming om de modus voor het maken van resources aan te geven. 'Standaard'
'Herstellen'
legitimatiebewijs Naam van de Cosmos DB MongoDB-verzameling tekenreeks (vereist)
Indexen Lijst met indexsleutels MongoIndex
Parameters herstellen Parameters om de informatie over de herstelbewerking aan te geven ResourceRestoreParameters
scherf Sleutel Een sleutel-waardepaar van shardsleutels die moeten worden toegepast voor de aanvraag. Scherf Sleutels

Mongo-index

Naam Beschrijving Waarde
sleutel Indexsleutels voor Cosmos DB MongoDB-verzameling MongoIndexKeys
Opties Indexopties voor cosmos DB MongoDB-verzameling MongoIndexOptions-

MongoIndexKeys

Naam Beschrijving Waarde
Sleutels Lijst met sleutels voor elke MongoDB-verzameling in de Azure Cosmos DB-service tekenreeks[]

MongoIndexOpties

Naam Beschrijving Waarde
vervaltAfterSeconds Verlopen na seconden Int
uniek Is uniek of niet Bool

ResourceRestoreParameters

Naam Beschrijving Waarde
Bron herstellen De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} snaar
herstelTimestampInUtc Tijd waarop het account moet worden hersteld (ISO-8601-indeling). snaar

Scherf Sleutels

Naam Beschrijving Waarde

Tags

Naam Beschrijving Waarde

Gebruiksvoorbeelden

Azure-snelstartvoorbeelden

De volgende Azure-quickstartsjablonen bicep-voorbeelden bevatten voor het implementeren van dit resourcetype.

Bicep-bestand Beschrijving
Een Azure Cosmos-account maken voor mongoDB-API- Met deze sjabloon maakt u een Azure Cosmos DB-account voor MongoDB API 4.2 in twee regio's met behulp van gedeelde en toegewezen doorvoer met twee verzamelingen.
Een Azure Cosmos-account maken voor automatische schaalaanpassing van MongoDB-API's Met deze sjabloon maakt u een Azure Cosmos DB-account voor MongoDB API 4.2 in twee regio's met behulp van zowel gedeelde als toegewezen doorvoer voor automatische schaalaanpassing.

Resourcedefinitie van ARM-sjabloon

Het resourcetype databaseAccounts/mongodbDatabases/collections kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
  "apiVersion": "2023-11-15",
  "name": "string",
  "location": "string",
  "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"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Eigenschapswaarden

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Naam Beschrijving Waarde
apiVersion De API-versie '2023-11-15'
plaats De locatie van de resourcegroep waartoe de resource behoort. snaar
naam De resourcenaam tekenreeks (vereist)
Eigenschappen Eigenschappen voor het maken en bijwerken van azure Cosmos DB MongoDB-verzameling. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (vereist)
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
soort Het resourcetype 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections'

Instellingen voor automatisch schalen

Naam Beschrijving Waarde
maximale doorvoer Vertegenwoordigt de maximale doorvoer, de resource kan omhoog worden geschaald. Int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Naam Beschrijving Waarde
autoscale-instellingen Hiermee geeft u de instellingen voor automatisch schalen. Opmerking: doorvoer of autoscaleSettings is vereist, maar niet beide. Instellingen voor automatisch schalen
Doorvoer Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. Int

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Naam Beschrijving Waarde
Opties Een sleutel-waardepaar met opties die moeten worden toegepast voor de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions-
hulpbron De standaard JSON-indeling van een MongoDB-verzameling MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (vereist)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Naam Beschrijving Waarde
analyticalStorageTtl Analytische TTL. Int
createMode Opsomming om de modus voor het maken van resources aan te geven. 'Standaard'
'Herstellen'
legitimatiebewijs Naam van de Cosmos DB MongoDB-verzameling tekenreeks (vereist)
Indexen Lijst met indexsleutels MongoIndex
Parameters herstellen Parameters om de informatie over de herstelbewerking aan te geven ResourceRestoreParameters
scherf Sleutel Een sleutel-waardepaar van shardsleutels die moeten worden toegepast voor de aanvraag. Scherf Sleutels

Mongo-index

Naam Beschrijving Waarde
sleutel Indexsleutels voor Cosmos DB MongoDB-verzameling MongoIndexKeys
Opties Indexopties voor cosmos DB MongoDB-verzameling MongoIndexOptions-

MongoIndexKeys

Naam Beschrijving Waarde
Sleutels Lijst met sleutels voor elke MongoDB-verzameling in de Azure Cosmos DB-service tekenreeks[]

MongoIndexOpties

Naam Beschrijving Waarde
vervaltAfterSeconds Verlopen na seconden Int
uniek Is uniek of niet Bool

ResourceRestoreParameters

Naam Beschrijving Waarde
Bron herstellen De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} snaar
herstelTimestampInUtc Tijd waarop het account moet worden hersteld (ISO-8601-indeling). snaar

Scherf Sleutels

Naam Beschrijving Waarde

Tags

Naam Beschrijving Waarde

Gebruiksvoorbeelden

Azure-snelstartsjablonen

De volgende Azure-quickstartsjablonen dit resourcetype implementeren.

Sjabloon Beschrijving
Een Azure Cosmos-account maken voor mongoDB-API-

implementeren in Azure 		Met deze sjabloon maakt u een Azure Cosmos DB-account voor MongoDB API 4.2 in twee regio's met behulp van gedeelde en toegewezen doorvoer met twee verzamelingen.
Een Azure Cosmos-account maken voor automatische schaalaanpassing van MongoDB-API's

implementeren in Azure 		Met deze sjabloon maakt u een Azure Cosmos DB-account voor MongoDB API 4.2 in twee regio's met behulp van zowel gedeelde als toegewezen doorvoer voor automatische schaalaanpassing.

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype databaseAccounts/mongodbDatabases/collections kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-11-15"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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"
        }
      }
    }
  }
}

Eigenschapswaarden

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Naam Beschrijving Waarde
plaats De locatie van de resourcegroep waartoe de resource behoort. snaar
naam De resourcenaam tekenreeks (vereist)
ouder_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van het type: databaseAccounts/mongodbDatabases
Eigenschappen Eigenschappen voor het maken en bijwerken van azure Cosmos DB MongoDB-verzameling. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (vereist)
Tags Resourcetags Woordenlijst met tagnamen en -waarden.
soort Het resourcetype "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-11-15"

Instellingen voor automatisch schalen

Naam Beschrijving Waarde
maximale doorvoer Vertegenwoordigt de maximale doorvoer, de resource kan omhoog worden geschaald. Int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Naam Beschrijving Waarde
autoscale-instellingen Hiermee geeft u de instellingen voor automatisch schalen. Opmerking: doorvoer of autoscaleSettings is vereist, maar niet beide. Instellingen voor automatisch schalen
Doorvoer Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. Int

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Naam Beschrijving Waarde
Opties Een sleutel-waardepaar met opties die moeten worden toegepast voor de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions-
hulpbron De standaard JSON-indeling van een MongoDB-verzameling MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (vereist)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Naam Beschrijving Waarde
analyticalStorageTtl Analytische TTL. Int
createMode Opsomming om de modus voor het maken van resources aan te geven. 'Standaard'
'Herstellen'
legitimatiebewijs Naam van de Cosmos DB MongoDB-verzameling tekenreeks (vereist)
Indexen Lijst met indexsleutels MongoIndex
Parameters herstellen Parameters om de informatie over de herstelbewerking aan te geven ResourceRestoreParameters
scherf Sleutel Een sleutel-waardepaar van shardsleutels die moeten worden toegepast voor de aanvraag. Scherf Sleutels

Mongo-index

Naam Beschrijving Waarde
sleutel Indexsleutels voor Cosmos DB MongoDB-verzameling MongoIndexKeys
Opties Indexopties voor cosmos DB MongoDB-verzameling MongoIndexOptions-

MongoIndexKeys

Naam Beschrijving Waarde
Sleutels Lijst met sleutels voor elke MongoDB-verzameling in de Azure Cosmos DB-service tekenreeks[]

MongoIndexOpties

Naam Beschrijving Waarde
vervaltAfterSeconds Verlopen na seconden Int
uniek Is uniek of niet Bool

ResourceRestoreParameters

Naam Beschrijving Waarde
Bron herstellen De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} snaar
herstelTimestampInUtc Tijd waarop het account moet worden hersteld (ISO-8601-indeling). snaar

Scherf Sleutels

Naam Beschrijving Waarde

Tags

Naam Beschrijving Waarde