Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2024-02-15-preview

• Senaste
• 2024-05-15
• 2024-05-15-preview
• 2024-02-15-preview
• 2023-11-15
• 2023-11-15-förhandsversion
• 2023-09-15
• 2023-09-15-preview
• 2023-04-15
• 2023-03-15
• 2023-03-15-preview
• Förhandsversion av 2023-03-01
• 2022-11-15
• 2022-11-15-förhandsversion
• 2022-08-15
• 2022-08-15-preview
• 2022-05-15
• 2022-05-15-preview
• 2022-02-15-preview
• 2021-11-15-förhandsversion
• 2021-10-15
• Förhandsversion 2021-10-15
• 2021-07-01-preview
• 2021-06-15
• 2021-05-15
• 2021-04-15
• Förhandsversion 2021-04-01
• 2021-03-15
• Förhandsversion av 2021-03-01
• 2021-01-15
• 2020-09-01
• Förhandsversion 2020-06-01
• 2020-04-01
• 2020-03-01
• 2019-12-12
• 2019-08-01

Bicep-resursdefinition

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

• Resursgrupper – Se kommandon för resursgruppsdistribution

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

Resursformat

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

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

Egenskapsvärden

databaseAccounts/mongodbDatabases/collections

Name	Beskrivning	Värde
name	Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep.	sträng (krävs)
location	Platsen för resursgruppen som resursen tillhör.	sträng
tags	Taggar är en lista över nyckel/värde-par som beskriver resursen. De här taggarna kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB".	Ordlista med taggnamn och värden. Se Taggar i mallar
parent	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 överordnad resurs.	Symboliskt namn för resurs av typen: mongodbDatabases
identity	Identitet för resursen.	ManagedServiceIdentity
properties	Egenskaper för att skapa och uppdatera Azure Cosmos DB MongoDB-samlingen.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (krävs)

ManagedServiceIdentity

Name	Beskrivning	Värde
typ	Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.	"Ingen" "SystemAssigned" "SystemAssigned,UserAssigned" "Användartilldelade"
userAssignedIdentities	Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name	Beskrivning	Värde
{anpassad egenskap}		Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Name	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.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
resource	JSON-standardformatet för en MongoDB-samling	MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (krävs)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Name	Beskrivning	Värde
autoscaleSettings	Anger inställningarna för autoskalning. Obs! Antingen dataflöde eller autoscaleSettings krävs, men inte båda.	AutoskalningInställningar
dataflöde	Enheter för programbegäran per sekund. Till exempel "dataflöde": 10000.	int

AutoskalningInställningar

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

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Name	Beskrivning	Värde
analyticalStorageTtl	TTL för analys.	int
createMode	Räkna upp för att ange läget för resursskapande.	"Standard" "PointInTimeRestore" "Å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

Name	Beskrivning	Värde
nyckel	Cosmos DB MongoDB-samlingsindexnycklar	MongoIndexKeys
alternativ	Nyckelalternativ för Cosmos DB MongoDB-samlingsindex	MongoIndexOptions

MongoIndexKeys

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

MongoIndexOptions

Name	Beskrivning	Värde
expireAfterSeconds	Upphör att gälla efter sekunder	int
Unik	Är unikt eller inte	boolesk

ResourceRestoreParameters

Name	Beskrivning	Värde
restoreSource	ID:t för det återställningsbara databaskonto som återställningen måste initieras från. 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
restoreWithTtlDisabled	Anger om det återställda kontot ska ha Time-To-Live inaktiverat vid den lyckade återställningen.	boolesk

ShardKeys

Name	Beskrivning	Värde
{anpassad egenskap}		sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall	Description
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 både delat och dedikerat dataflöde för autoskalning.

Resursdefinition för ARM-mall

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

• Resursgrupper – Se kommandon för resursgruppsdistribution

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

Resursformat

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

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

Egenskapsvärden

databaseAccounts/mongodbDatabases/collections

Name	Beskrivning	Värde
typ	Resurstypen	"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections"
apiVersion	Resurs-API-versionen	"2024-02-15-preview"
name	Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.	sträng (krävs)
location	Platsen för resursgruppen som resursen tillhör.	sträng
tags	Taggar är en lista över nyckel/värde-par som beskriver resursen. De här taggarna kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB".	Ordlista med taggnamn och värden. Se Taggar i mallar
identity	Identitet för resursen.	ManagedServiceIdentity
properties	Egenskaper för att skapa och uppdatera Azure Cosmos DB MongoDB-samlingen.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (krävs)

ManagedServiceIdentity

Name	Beskrivning	Värde
typ	Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.	"Ingen" "SystemAssigned" "SystemAssigned,UserAssigned" "Användartilldelade"
userAssignedIdentities	Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name	Beskrivning	Värde
{anpassad egenskap}		Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Name	Beskrivning	Värde
alternativ	Ett nyckel/värde-par med alternativ som ska tillämpas för begäran. Detta motsvarar de huvuden som skickas med begäran.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
resource	JSON-standardformatet för en MongoDB-samling	MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (krävs)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Name	Beskrivning	Värde
autoscaleSettings	Anger inställningarna för autoskalning. Obs! Antingen dataflöde eller autoscaleSettings krävs, men inte båda.	AutoscaleSettings
dataflöde	Enheter för programbegäran per sekund. Till exempel "dataflöde": 10000.	int

AutoskalningInställningar

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

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Name	Beskrivning	Värde
analyticalStorageTtl	TTL för analys.	int
createMode	Räkna upp för att ange läget för resursskapande.	"Standard" "PointInTimeRestore" "Å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

Name	Beskrivning	Värde
nyckel	Cosmos DB MongoDB-samlingsindexnycklar	MongoIndexKeys
alternativ	Nyckelalternativ för Cosmos DB MongoDB-samlingsindex	MongoIndexOptions

MongoIndexKeys

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

MongoIndexOptions

Name	Beskrivning	Värde
expireAfterSeconds	Upphör att gälla efter sekunder	int
Unik	Är unikt eller inte	boolesk

ResourceRestoreParameters

Name	Beskrivning	Värde
restoreSource	ID:t för det återställningsbara databaskonto som återställningen måste initieras från. 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
restoreWithTtlDisabled	Anger om det återställda kontot ska ha Time-To-Live inaktiverat vid den lyckade återställningen.	boolesk

ShardKeys

Name	Beskrivning	Värde
{anpassad egenskap}		sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall	Description
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 både delat och dedikerat dataflöde för autoskalning.

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 Resurs för Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections lägger du till följande Terraform i mallen.

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

Egenskapsvärden

databaseAccounts/mongodbDatabases/collections

Name	Beskrivning	Värde
typ	Resurstypen	"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-02-15-preview"
name	Resursnamnet	sträng (krävs)
location	Platsen för resursgruppen som resursen tillhör.	sträng
parent_id	ID för resursen som är överordnad för den här resursen.	ID för resurs av typen: mongodbDatabases
tags	Taggar är en lista över nyckel/värde-par som beskriver resursen. De här taggarna kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB".	Ordlista med taggnamn och värden.
identity	Identitet för resursen.	ManagedServiceIdentity
properties	Egenskaper för att skapa och uppdatera Azure Cosmos DB MongoDB-samlingen.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (krävs)

ManagedServiceIdentity

Name	Beskrivning	Värde
typ	Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.	"SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned"
identity_ids	Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	Matris med användaridentitets-ID:t.

ManagedServiceIdentityUserAssignedIdentities

Name	Beskrivning	Värde
{anpassad egenskap}		Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Name	Beskrivning	Värde
alternativ	Ett nyckel/värde-par med alternativ som ska tillämpas för begäran. Detta motsvarar de huvuden som skickas med begäran.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
resource	JSON-standardformatet för en MongoDB-samling	MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (krävs)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Name	Beskrivning	Värde
autoscaleSettings	Anger inställningarna för autoskalning. Obs! Antingen dataflöde eller autoscaleSettings krävs, men inte båda.	AutoscaleSettings
dataflöde	Enheter för programbegäran per sekund. Till exempel "dataflöde": 10000.	int

AutoscaleSettings

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

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

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

MongoIndex

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

MongoIndexKeys

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

MongoIndexOptions

Name	Beskrivning	Värde
expireAfterSeconds	Upphör att gälla efter sekunder	int
Unik	Är unik eller inte	boolesk

ResourceRestoreParameters

Name	Beskrivning	Värde
restoreSource	ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Exempel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}	sträng
restoreTimestampInUtc	Tid till vilken kontot måste återställas (ISO-8601-format).	sträng
restoreWithTtlDisabled	Anger om det återställda kontot ska ha Time-To-Live inaktiverat vid en lyckad återställning.	boolesk

ShardKeys

Name	Beskrivning	Värde
{anpassad egenskap}		sträng