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

• meest recente
• 2024-12-01-preview-
• 2024-11-15
• 2024-09-01-preview-
• 2024-08-15
• 2024-05-15
• 2024-05-15-preview-
• 2024-02-15-preview-
• 2023-11-15
• 2023-11-15-preview-
• 2023-09-15
• 2023-09-15-preview-
• 2023-04-15
• 2023-03-15
• 2023-03-15-preview-
• 2023-03-01-preview-
• 2022-11-15
• 2022-11-15-preview-
• 2022-08-15
• 2022-08-15-preview-
• 2022-05-15
• 2022-05-15-preview-
• 2022-02-15-preview-
• 2021-11-15-preview-
• 2021-10-15
• 2021-10-15-preview-
• 2021-07-01-preview-
• 2021-06-15
• 2021-05-15
• 2021-04-15
• 2021-04-01-preview-
• 2021-03-15
• 2021-03-01-preview-
• 2021-01-15
• 2020-09-01
• 2020-06-01-preview-
• 2020-04-01
• 2020-03-01
• 2019-12-12
• 2019-08-01

Bicep-resourcedefinitie

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

• Resourcegroepen - Zie opdrachten voor de implementatie van 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 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

AutoscaleSettings

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

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

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

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

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[]
restoreParameters	Parameters om de informatie over de herstelbewerking aan te geven	ResourceRestoreParameters
shardKey	Een sleutel-waardepaar van shardsleutels die moeten worden toegepast voor de aanvraag.	ShardKeys

MongoIndex

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[]

MongoIndexOptions

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

ResourceRestoreParameters

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

ShardKeys

Naam	Beschrijving	Waarde

Tags

Naam	Beschrijving	Waarde

Quickstart-voorbeelden

In de volgende quickstartvoorbeelden wordt dit resourcetype geïmplementeerd.

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:

• Resourcegroepen - Zie opdrachten voor de implementatie van 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 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

AutoscaleSettings

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

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

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

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
type	Het resourcetype	'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections'

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[]
restoreParameters	Parameters om de informatie over de herstelbewerking aan te geven	ResourceRestoreParameters
shardKey	Een sleutel-waardepaar van shardsleutels die moeten worden toegepast voor de aanvraag.	ShardKeys

MongoIndex

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[]

MongoIndexOptions

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

ResourceRestoreParameters

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

ShardKeys

Naam	Beschrijving	Waarde

Tags

Naam	Beschrijving	Waarde

Quickstart-sjablonen

Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Sjabloon	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 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"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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"
        }
      }
    }
  })
}

Eigenschapswaarden

AutoscaleSettings

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

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

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

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Naam	Beschrijving	Waarde
plaats	De locatie van de resourcegroep waartoe de resource behoort.	snaar
naam	De resourcenaam	tekenreeks (vereist)
parent_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.
type	Het resourcetype	"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-11-15"

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[]
restoreParameters	Parameters om de informatie over de herstelbewerking aan te geven	ResourceRestoreParameters
shardKey	Een sleutel-waardepaar van shardsleutels die moeten worden toegepast voor de aanvraag.	ShardKeys

MongoIndex

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[]

MongoIndexOptions

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

ResourceRestoreParameters

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

ShardKeys

Naam	Beschrijving	Waarde

Tags

Naam	Beschrijving	Waarde