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

  • Artikel

Bicep-Ressourcendefinition

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

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 den folgenden Bicep hinzu.

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

Eigenschaftswerte

databaseAccounts/mongodbDatabases/collections

Name BESCHREIBUNG Wert
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep.		 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. 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. Weitere Informationen finden Sie unter 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 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. Hinweis: Es ist entweder "throughput" oder "autoscaleSettings" erforderlich, aber nicht beides. 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
createMode Enumeration, um den Modus der Ressourcenerstellung anzugeben. 'Standardwert'
"Wiederherstellen"
id Name der MongoDB-Sammlung von Cosmos DB Zeichenfolge (erforderlich)
Indizes Liste der Indexschlüssel MongoIndex[]
restoreParameters Parameter zum Angeben der Informationen zur Wiederherstellung ResourceRestoreParameters
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

ResourceRestoreParameters

Name BESCHREIBUNG Wert
restoreSource Die ID des wiederherstellbaren Datenbankkontos, von dem aus die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts/{restorableDatabaseAccountName} Zeichenfolge
restoreTimestampInUtc Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). Zeichenfolge

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

Bereitstellen in Azure		 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

Bereitstellen in Azure		 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.

Ressourcendefinition mit einer ARM-Vorlage

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

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 den folgenden JSON-Code hinzu.

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

Eigenschaftswerte

databaseAccounts/mongodbDatabases/collections

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections"
apiVersion Die Version der Ressourcen-API '2023-11-15'
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen.		 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. 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. Weitere Informationen finden Sie unter 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. Hinweis: Es ist entweder "throughput" oder "autoscaleSettings" erforderlich, aber nicht beides. 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
createMode Enumeration, um den Modus der Ressourcenerstellung anzugeben. 'Standardwert'
"Wiederherstellen"
id Name der MongoDB-Sammlung von Cosmos DB Zeichenfolge (erforderlich)
Indizes Liste der Indexschlüssel MongoIndex[]
restoreParameters Parameter zum Angeben der Informationen zur Wiederherstellung ResourceRestoreParameters
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

ResourceRestoreParameters

Name BESCHREIBUNG Wert
restoreSource Die ID des wiederherstellbaren Datenbankkontos, von dem aus die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts/{restorableDatabaseAccountName} Zeichenfolge
restoreTimestampInUtc Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). Zeichenfolge

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

Bereitstellen in Azure		 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

Bereitstellen in Azure		 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@2023-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
        createMode = "string"
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
        }
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

Eigenschaftswerte

databaseAccounts/mongodbDatabases/collections

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-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. Hinweis: Es ist entweder "throughput" oder "autoscaleSettings" erforderlich, aber nicht beides. 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
createMode Enumeration, um den Modus der Ressourcenerstellung anzugeben. "Standard"
"Wiederherstellen"
id Name der MongoDB-Sammlung von Cosmos DB Zeichenfolge (erforderlich)
Indizes Liste der Indexschlüssel MongoIndex[]
restoreParameters Parameter zum Angeben der Informationen zur Wiederherstellung ResourceRestoreParameters
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

ResourceRestoreParameters

Name BESCHREIBUNG Wert
restoreSource Die ID des wiederherstellbaren Datenbankkontos, von dem aus die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts/{restorableDatabaseAccountName} Zeichenfolge
restoreTimestampInUtc Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). Zeichenfolge

ShardKeys

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} Zeichenfolge