Dela via

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

  • Artikel

Bicep-resursdefinition

Resurstypen databaseAccounts/mongodbDatabases/collections kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections-resurs lägger du till följande Bicep i mallen.

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'
  }
}

Egenskapsvärden

AutoskalningInställningar

Namn Beskrivning Värde
maxThroughput Representerar maximalt dataflöde, resursen kan skalas upp till. Int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Namn Beskrivning Värde
autoscaleSettings Anger inställningarna för autoskalning. Obs! Antingen dataflöde eller autoskalningInställningar krävs, men inte båda. AutoscaleSettings
genomströmning Enheter för begäranden per sekund. Till exempel "dataflöde": 10000. Int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Namn Beskrivning Värde
plats Platsen för den resursgrupp som resursen tillhör. sträng
Namn Resursnamnet sträng (krävs)
förälder I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför den överordnade resursen.		 Symboliskt namn för resurs av typen: databaseAccounts/mongodbDatabases
Egenskaper Egenskaper för att skapa och uppdatera Azure Cosmos DB MongoDB-samlingen. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (krävs)
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Namn Beskrivning Värde
Alternativ Ett nyckel/värde-par med alternativ som ska användas för begäran. Detta motsvarar rubrikerna som skickas med begäran. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
resurs JSON-standardformatet för en MongoDB-samling MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (krävs)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Namn Beskrivning Värde
analyticalStorageTtl TTL för analys. Int
createMode Uppräkning för att ange läget för att skapa resurser. "Standard"
"Återställ"
Id Namnet på Cosmos DB MongoDB-samlingen sträng (krävs)
Index Lista över indexnycklar MongoIndex[]
restoreParameters Parametrar som anger information om återställningen ResourceRestoreParameters
shardKey Ett nyckel/värde-par med shardnycklar som ska användas för begäran. ShardKeys

MongoIndex

Namn Beskrivning Värde
nyckel Cosmos DB MongoDB-samlingsindexnycklar MongoIndexKeys
Alternativ Alternativ för Cosmos DB MongoDB-samlingsindexnyckel MongoIndexOptions

MongoIndexKeys

Namn Beskrivning Värde
Nycklar Lista över nycklar för varje MongoDB-samling i Azure Cosmos DB-tjänsten string[]

MongoIndexOptions

Namn Beskrivning Värde
expireAfterSeconds Upphör att gälla efter sekunder Int
unik Är unik eller inte Bool

ResourceRestoreParameters

Namn Beskrivning Värde
restoreSource ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Till exempel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} sträng
restoreTimestampInUtc Tid då kontot måste återställas (ISO-8601-format). sträng

ShardKeys

Namn Beskrivning Värde

Taggar

Namn Beskrivning Värde

Snabbstartsexempel

Följande snabbstartsexempel distribuerar den här resurstypen.

Bicep-fil Beskrivning
Skapa ett Azure Cosmos-konto för MongoDB API Den här mallen skapar ett Azure Cosmos DB-konto för MongoDB API 4.2 i två regioner med delat och dedikerat dataflöde med två samlingar.
Skapa ett Azure Cosmos-konto för autoskalning av MongoDB API Den här mallen skapar ett Azure Cosmos DB-konto för MongoDB API 4.2 i två regioner med hjälp av både delat och dedikerat autoskalningsdataflöde.

Resursdefinition för ARM-mall

Resurstypen databaseAccounts/mongodbDatabases/collections kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections-resurs lägger du till följande JSON i mallen.

{
  "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"
  }
}

Egenskapsvärden

AutoskalningInställningar

Namn Beskrivning Värde
maxThroughput Representerar maximalt dataflöde, resursen kan skalas upp till. Int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Namn Beskrivning Värde
autoscaleSettings Anger inställningarna för autoskalning. Obs! Antingen dataflöde eller autoskalningInställningar krävs, men inte båda. AutoscaleSettings
genomströmning Enheter för begäranden per sekund. Till exempel "dataflöde": 10000. Int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Namn Beskrivning Värde
apiVersion API-versionen '2023-11-15'
plats Platsen för den resursgrupp som resursen tillhör. sträng
Namn Resursnamnet sträng (krävs)
Egenskaper Egenskaper för att skapa och uppdatera Azure Cosmos DB MongoDB-samlingen. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (krävs)
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Namn Beskrivning Värde
Alternativ Ett nyckel/värde-par med alternativ som ska användas för begäran. Detta motsvarar rubrikerna som skickas med begäran. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
resurs JSON-standardformatet för en MongoDB-samling MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (krävs)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Namn Beskrivning Värde
analyticalStorageTtl TTL för analys. Int
createMode Uppräkning för att ange läget för att skapa resurser. "Standard"
"Återställ"
Id Namnet på Cosmos DB MongoDB-samlingen sträng (krävs)
Index Lista över indexnycklar MongoIndex[]
restoreParameters Parametrar som anger information om återställningen ResourceRestoreParameters
shardKey Ett nyckel/värde-par med shardnycklar som ska användas för begäran. ShardKeys

MongoIndex

Namn Beskrivning Värde
nyckel Cosmos DB MongoDB-samlingsindexnycklar MongoIndexKeys
Alternativ Alternativ för Cosmos DB MongoDB-samlingsindexnyckel MongoIndexOptions

MongoIndexKeys

Namn Beskrivning Värde
Nycklar Lista över nycklar för varje MongoDB-samling i Azure Cosmos DB-tjänsten string[]

MongoIndexOptions

Namn Beskrivning Värde
expireAfterSeconds Upphör att gälla efter sekunder Int
unik Är unik eller inte Bool

ResourceRestoreParameters

Namn Beskrivning Värde
restoreSource ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Till exempel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} sträng
restoreTimestampInUtc Tid då kontot måste återställas (ISO-8601-format). sträng

ShardKeys

Namn Beskrivning Värde

Taggar

Namn Beskrivning Värde

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Beskrivning
Skapa ett Azure Cosmos-konto för MongoDB API

Distribuera till Azure 		Den här mallen skapar ett Azure Cosmos DB-konto för MongoDB API 4.2 i två regioner med delat och dedikerat dataflöde med två samlingar.
Skapa ett Azure Cosmos-konto för autoskalning av MongoDB API

Distribuera till Azure 		Den här mallen skapar ett Azure Cosmos DB-konto för MongoDB API 4.2 i två regioner med hjälp av både delat och dedikerat autoskalningsdataflöde.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen databaseAccounts/mongodbDatabases/collections kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections-resurs lägger du till följande Terraform i mallen.

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"
        }
      }
    }
  })
}

Egenskapsvärden

AutoskalningInställningar

Namn Beskrivning Värde
maxThroughput Representerar maximalt dataflöde, resursen kan skalas upp till. Int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Namn Beskrivning Värde
autoscaleSettings Anger inställningarna för autoskalning. Obs! Antingen dataflöde eller autoskalningInställningar krävs, men inte båda. AutoscaleSettings
genomströmning Enheter för begäranden per sekund. Till exempel "dataflöde": 10000. Int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Namn Beskrivning Värde
plats Platsen för den resursgrupp som resursen tillhör. sträng
Namn Resursnamnet sträng (krävs)
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: databaseAccounts/mongodbDatabases
Egenskaper Egenskaper för att skapa och uppdatera Azure Cosmos DB MongoDB-samlingen. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (krävs)
Taggar Resurstaggar Ordlista med taggnamn och värden.
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-11-15"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Namn Beskrivning Värde
Alternativ Ett nyckel/värde-par med alternativ som ska användas för begäran. Detta motsvarar rubrikerna som skickas med begäran. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
resurs JSON-standardformatet för en MongoDB-samling MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (krävs)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Namn Beskrivning Värde
analyticalStorageTtl TTL för analys. Int
createMode Uppräkning för att ange läget för att skapa resurser. "Standard"
"Återställ"
Id Namnet på Cosmos DB MongoDB-samlingen sträng (krävs)
Index Lista över indexnycklar MongoIndex[]
restoreParameters Parametrar som anger information om återställningen ResourceRestoreParameters
shardKey Ett nyckel/värde-par med shardnycklar som ska användas för begäran. ShardKeys

MongoIndex

Namn Beskrivning Värde
nyckel Cosmos DB MongoDB-samlingsindexnycklar MongoIndexKeys
Alternativ Alternativ för Cosmos DB MongoDB-samlingsindexnyckel MongoIndexOptions

MongoIndexKeys

Namn Beskrivning Värde
Nycklar Lista över nycklar för varje MongoDB-samling i Azure Cosmos DB-tjänsten string[]

MongoIndexOptions

Namn Beskrivning Värde
expireAfterSeconds Upphör att gälla efter sekunder Int
unik Är unik eller inte Bool

ResourceRestoreParameters

Namn Beskrivning Värde
restoreSource ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Till exempel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} sträng
restoreTimestampInUtc Tid då kontot måste återställas (ISO-8601-format). sträng

ShardKeys

Namn Beskrivning Värde

Taggar

Namn Beskrivning Värde