Microsoft.DocumentDB-DatenbankAccounts/mongodbDatenbanken/collections 2022-11-15

• Neueste
• 2024-05-15
• 15.05.2024
• 15.02.2024
• 2023-11-15
• 15.11.2023
• 2023-09-15
• 15.09.2023
• 2023-04-15
• 15.03.2023
• 15.03.2023
• 2023-03-01-preview
• 2022-11-15
• 15.11.2022
• 2022-08-15
• 2022-08-15-preview
• 2022-05-15
• 2022-05-15-preview
• 15.02.2022
• 15.11.2021
• 2021-10-15
• 15.10.2021
• 2021-07-01-preview
• 15.06.2021
• 2021-05-15
• 2021-04-15
• 2021-04-01-preview
• 2021-03-15
• 2021-03-01-preview
• 15.1.2021
• 2020-09-01
• 2020-06-01-preview
• 2020-04-01
• 2020-03-01
• 2019-12-12
• 2019-08-01

Bicep-Ressourcendefinition

Der Ressourcentyp databaseAccounts/mongodbDatabases/collections kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

• Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections-Ressource zu erstellen, fügen Sie Der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2022-11-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      id: 'string'
      indexes: [
        {
          key: {
            keys: [
              'string'
            ]
          }
          options: {
            expireAfterSeconds: int
            unique: bool
          }
        }
      ]
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
}

Eigenschaftswerte

databaseAccounts/mongodbDatabases/collections

Name	BESCHREIBUNG	Wert
name	Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen.	Zeichenfolge (erforderlich)
location	Der Speicherort der Ressourcengruppe, zu der die Ressource gehört.	Zeichenfolge
tags	Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB".	Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
parent	In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.	Symbolischer Name für Ressource vom Typ: mongodbDatabases
properties	Eigenschaften zum Erstellen und Aktualisieren der MongoDB-Sammlung von Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (erforderlich)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Name	BESCHREIBUNG	Wert
Optionen	Ein Schlüssel-Wert-Paar von Optionen, die für die Anforderung angewendet werden sollen. Dies entspricht den Headern, die mit der Anforderung gesendet wurden.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
resource	Das JSON-Standardformat einer MongoDB-Sammlung	MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (erforderlich)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Name	BESCHREIBUNG	Wert
autoscaleSettings	Gibt die Einstellungen für die automatische Skalierung an.	AutoscaleSettings
throughput	Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000.	INT

AutoscaleSettings

Name	BESCHREIBUNG	Wert
maxThroughput	Stellt den maximalen Durchsatz dar, auf den die Ressource hochskaliert werden kann.	INT

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Name	BESCHREIBUNG	Wert
analyticalStorageTtl	Analytische TTL.	INT
id	Name der Cosmos DB MongoDB-Sammlung	Zeichenfolge (erforderlich)
Indizes	Liste der Indexschlüssel	MongoIndex[]
shardKey	Ein Schlüssel-Wert-Paar von Shardschlüsseln, die für die Anforderung angewendet werden sollen.	ShardKeys

MongoIndex

Name	BESCHREIBUNG	Wert
Schlüssel	Cosmos DB MongoDB-Sammlungsindexschlüssel	MongoIndexKeys
Optionen	Cosmos DB MongoDB-Sammlungsindexschlüsseloptionen	MongoIndexOptions

MongoIndexKeys

Name	BESCHREIBUNG	Wert
keys	Liste der Schlüssel für jede MongoDB-Sammlung im Azure Cosmos DB-Dienst	string[]

MongoIndexOptions

Name	BESCHREIBUNG	Wert
expireAfterSeconds	Ablauf nach Sekunden	INT
unique	Eindeutig ist oder nicht	bool

ShardKeys

Name	BESCHREIBUNG	Wert
{angepasste Eigenschaft}		Zeichenfolge

Schnellstartvorlagen

Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.

Vorlage	BESCHREIBUNG
Erstellen eines Azure Cosmos-Kontos für die MongoDB-API	Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die MongoDB-API 4.2 in zwei Regionen mit freigegebenem und dediziertem Durchsatz mit zwei Sammlungen erstellt.
Erstellen eines Azure Cosmos-Kontos für die automatische Skalierung der MongoDB-API	Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die MongoDB-API 4.2 in zwei Regionen erstellt, wobei sowohl der freigegebene als auch der dedizierte Durchsatz für die automatische Skalierung verwendet wird.

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp databaseAccounts/mongodbDatabases/collections kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

• Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
  "apiVersion": "2022-11-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "id": "string",
      "indexes": [
        {
          "key": {
            "keys": [ "string" ]
          },
          "options": {
            "expireAfterSeconds": "int",
            "unique": "bool"
          }
        }
      ],
      "shardKey": {
        "{customized property}": "string"
      }
    }
  }
}

Eigenschaftswerte

databaseAccounts/mongodbDatabases/collections

Name	BESCHREIBUNG	Wert
type	Ressourcentyp	"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections"
apiVersion	Die Ressourcen-API-Version	'2022-11-15'
name	Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen.	Zeichenfolge (erforderlich)
location	Der Speicherort der Ressourcengruppe, zu der die Ressource gehört.	Zeichenfolge
tags	Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB".	Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
properties	Eigenschaften zum Erstellen und Aktualisieren der MongoDB-Sammlung von Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (erforderlich)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Name	BESCHREIBUNG	Wert
Optionen	Ein Schlüssel-Wert-Paar von Optionen, die für die Anforderung angewendet werden sollen. Dies entspricht den Headern, die mit der Anforderung gesendet werden.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
resource	Das JSON-Standardformat einer MongoDB-Auflistung	MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (erforderlich)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Name	BESCHREIBUNG	Wert
autoscaleSettings	Gibt die Einstellungen für die automatische Skalierung an.	AutoscaleSettings
throughput	Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000.	INT

AutoscaleSettings

Name	BESCHREIBUNG	Wert
maxThroughput	Stellt den maximalen Durchsatz dar, auf den die Ressource hochskaliert werden kann.	INT

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Name	BESCHREIBUNG	Wert
analyticalStorageTtl	Analytische Gültigkeitsdauer.	INT
id	Name der MongoDB-Sammlung von Cosmos DB	Zeichenfolge (erforderlich)
Indizes	Liste der Indexschlüssel	MongoIndex[]
shardKey	Ein Schlüssel-Wert-Paar von Shardschlüsseln, die für die Anforderung angewendet werden sollen.	ShardKeys

MongoIndex

Name	BESCHREIBUNG	Wert
Schlüssel	Cosmos DB MongoDB-Sammlungsindexschlüssel	MongoIndexKeys
Optionen	Optionen für Cosmos DB-MongoDB-Sammlungsindexschlüssel	MongoIndexOptions

MongoIndexKeys

Name	BESCHREIBUNG	Wert
keys	Liste der Schlüssel für jede MongoDB-Sammlung im Azure Cosmos DB-Dienst	string[]

MongoIndexOptions

Name	BESCHREIBUNG	Wert
expireAfterSeconds	Ablauf nach Sekunden	INT
unique	Ist eindeutig oder nicht	bool

ShardKeys

Name	BESCHREIBUNG	Wert
{angepasste Eigenschaft}		Zeichenfolge

Schnellstartvorlagen

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage	BESCHREIBUNG
Erstellen eines Azure Cosmos-Kontos für die MongoDB-API	Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die MongoDB-API 4.2 in zwei Regionen mit freigegebenem und dediziertem Durchsatz mit zwei Sammlungen.
Erstellen eines Azure Cosmos-Kontos für die automatische Skalierung der MongoDB-API	Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die MongoDB-API 4.2 in zwei Regionen mit freigegebenem und dediziertem Durchsatz für die autoskalierte Skalierung erstellt.

Terraform-Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp databaseAccounts/mongodbDatabases/collections kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

• Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Ressource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2022-11-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

Eigenschaftswerte

databaseAccounts/mongodbDatabases/collections

Name	BESCHREIBUNG	Wert
type	Der Ressourcentyp	"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2022-11-15"
name	Der Ressourcenname	Zeichenfolge (erforderlich)
location	Der Speicherort der Ressourcengruppe, zu der die Ressource gehört.	Zeichenfolge
parent_id	Die ID der Ressource, die das übergeordnete Element für diese Ressource ist.	ID für Ressource vom Typ: mongodbDatabases
tags	Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Beispielsweise ist die Standardumgebung für einen Vorlagentyp auf "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB".	Wörterbuch der Tagnamen und -werte.
properties	Eigenschaften zum Erstellen und Aktualisieren der MongoDB-Sammlung von Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (erforderlich)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Name	BESCHREIBUNG	Wert
Optionen	Ein Schlüssel-Wert-Paar von Optionen, die für die Anforderung angewendet werden sollen. Dies entspricht den Headern, die mit der Anforderung gesendet werden.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
resource	Das JSON-Standardformat einer MongoDB-Auflistung	MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (erforderlich)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Name	BESCHREIBUNG	Wert
autoscaleSettings	Gibt die Einstellungen für die automatische Skalierung an.	AutoscaleSettings
throughput	Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000.	INT

AutoscaleSettings

Name	BESCHREIBUNG	Wert
maxThroughput	Stellt den maximalen Durchsatz dar, auf den die Ressource hochskaliert werden kann.	INT

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Name	BESCHREIBUNG	Wert
analyticalStorageTtl	Analytische Gültigkeitsdauer.	INT
id	Name der MongoDB-Sammlung von Cosmos DB	Zeichenfolge (erforderlich)
Indizes	Liste der Indexschlüssel	MongoIndex[]
shardKey	Ein Schlüssel-Wert-Paar von Shardschlüsseln, die für die Anforderung angewendet werden sollen.	ShardKeys

MongoIndex

Name	BESCHREIBUNG	Wert
Schlüssel	Cosmos DB MongoDB-Sammlungsindexschlüssel	MongoIndexKeys
Optionen	Optionen für Cosmos DB-MongoDB-Sammlungsindexschlüssel	MongoIndexOptions

MongoIndexKeys

Name	BESCHREIBUNG	Wert
keys	Liste der Schlüssel für jede MongoDB-Sammlung im Azure Cosmos DB-Dienst	string[]

MongoIndexOptions

Name	BESCHREIBUNG	Wert
expireAfterSeconds	Ablauf nach Sekunden	INT
unique	Ist eindeutig oder nicht	bool

ShardKeys

Name	BESCHREIBUNG	Wert
{angepasste Eigenschaft}		Zeichenfolge