Freigeben über

Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2024-05-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 unter Änderungsprotokoll.

Ressourcenformat

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-05-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'
  }
}

Eigenschaftswerte

AutoscaleSettings

Name Beschreibung Wert
maxThroughput Stellt den maximalen Durchsatz dar, auf den die Ressource skaliert werden kann. Int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Name Beschreibung Wert
autoscaleSettings Gibt die Einstellungen für die Autoskalen an. Hinweis: Entweder Durchsatz oder AutoscaleSettings ist erforderlich, aber nicht beides. AutoscaleSettings-
Durchsatz Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. Int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Name Beschreibung Wert
Ort Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Schnur
Name Der Ressourcenname Zeichenfolge (erforderlich)
Elternteil 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 des Typs: databaseAccounts/mongodbDatabases
Eigenschaften Eigenschaften zum Erstellen und Aktualisieren der Azure Cosmos DB MongoDB-Auflistung. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Name Beschreibung Wert
Optionen Ein Schlüssel-Wert-Optionspaar, das für die Anforderung angewendet werden soll. Dies entspricht den Kopfzeilen, die mit der Anforderung gesendet werden. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
Ressource Das standardmäßige JSON-Format einer MongoDB-Auflistung MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (erforderlich)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Name Beschreibung Wert
analyticalStorageTtl Analytische tTL. Int
createMode Aufzählung, um den Modus der Ressourcenerstellung anzugeben. 'Standard'
"Wiederherstellen"
id Name der Cosmos DB MongoDB-Sammlung Zeichenfolge (erforderlich)
indexe Liste der Indexschlüssel MongoIndex[]
restoreParameters Parameter, die die Informationen zur Wiederherstellung angeben sollen ResourceRestoreParameters-
shardKey Ein Schlüssel-Wert-Paar von Schlüsseln, die für die Anforderung angewendet werden sollen. ShardKeys

MongoIndex

Name Beschreibung Wert
Schlüssel Cosmos DB MongoDB-Sammlungsindexschlüssel MongoIndexKeys
Optionen Schlüsseloptionen für Cosmos DB MongoDB-Auflistung MongoIndexOptions

MongoIndexKeys

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

MongoIndexOptions

Name Beschreibung Wert
expireAfterSeconds Ablauf nach Sekunden Int
einzigartig Ist eindeutig oder nicht Bool

ResourceRestoreParameters

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

ShardKeys

Name Beschreibung Wert

Schilder

Name Beschreibung Wert

Schnellstartbeispiele

Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.

Bicep-Datei Beschreibung
Erstellen eines Azure Cosmos-Kontos für mongoDB-API- Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die MongoDB-API 4.2 in zwei Regionen, wobei der gemeinsame und dedizierte Durchsatz mit zwei Sammlungen verwendet wird.
Erstellen eines Azure Cosmos-Kontos für die autoskalen der MongoDB-API Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die MongoDB-API 4.2 in zwei Regionen, die sowohl den gemeinsam genutzten als auch den dedizierten Autoskalendurchsatz verwenden.

ARM-Vorlagenressourcendefinition

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 unter Ä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": "2024-05-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"
  }
}

Eigenschaftswerte

AutoscaleSettings

Name Beschreibung Wert
maxThroughput Stellt den maximalen Durchsatz dar, auf den die Ressource skaliert werden kann. Int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Name Beschreibung Wert
autoscaleSettings Gibt die Einstellungen für die Autoskalen an. Hinweis: Entweder Durchsatz oder AutoscaleSettings ist erforderlich, aber nicht beides. AutoscaleSettings-
Durchsatz Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. Int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Name Beschreibung Wert
apiVersion Die API-Version '2024-05-15'
Ort Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Schnur
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Eigenschaften zum Erstellen und Aktualisieren der Azure Cosmos DB MongoDB-Auflistung. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art Der Ressourcentyp 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections'

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Name Beschreibung Wert
Optionen Ein Schlüssel-Wert-Optionspaar, das für die Anforderung angewendet werden soll. Dies entspricht den Kopfzeilen, die mit der Anforderung gesendet werden. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
Ressource Das standardmäßige JSON-Format einer MongoDB-Auflistung MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (erforderlich)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Name Beschreibung Wert
analyticalStorageTtl Analytische tTL. Int
createMode Aufzählung, um den Modus der Ressourcenerstellung anzugeben. 'Standard'
"Wiederherstellen"
id Name der Cosmos DB MongoDB-Sammlung Zeichenfolge (erforderlich)
indexe Liste der Indexschlüssel MongoIndex[]
restoreParameters Parameter, die die Informationen zur Wiederherstellung angeben sollen ResourceRestoreParameters-
shardKey Ein Schlüssel-Wert-Paar von Schlüsseln, die für die Anforderung angewendet werden sollen. ShardKeys

MongoIndex

Name Beschreibung Wert
Schlüssel Cosmos DB MongoDB-Sammlungsindexschlüssel MongoIndexKeys
Optionen Schlüsseloptionen für Cosmos DB MongoDB-Auflistung MongoIndexOptions

MongoIndexKeys

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

MongoIndexOptions

Name Beschreibung Wert
expireAfterSeconds Ablauf nach Sekunden Int
einzigartig Ist eindeutig oder nicht Bool

ResourceRestoreParameters

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

ShardKeys

Name Beschreibung Wert

Schilder

Name Beschreibung Wert

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone Beschreibung
Erstellen eines Azure Cosmos-Kontos für mongoDB-API-

Bereitstellen in Azure 		Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die MongoDB-API 4.2 in zwei Regionen, wobei der gemeinsame und dedizierte Durchsatz mit zwei Sammlungen verwendet wird.
Erstellen eines Azure Cosmos-Kontos für die autoskalen der MongoDB-API

Bereitstellen in Azure 		Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die MongoDB-API 4.2 in zwei Regionen, die sowohl den gemeinsam genutzten als auch den dedizierten Autoskalendurchsatz verwenden.

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 unter Änderungsprotokoll.

Ressourcenformat

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-05-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"
        }
      }
    }
  })
}

Eigenschaftswerte

AutoscaleSettings

Name Beschreibung Wert
maxThroughput Stellt den maximalen Durchsatz dar, auf den die Ressource skaliert werden kann. Int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Name Beschreibung Wert
autoscaleSettings Gibt die Einstellungen für die Autoskalen an. Hinweis: Entweder Durchsatz oder AutoscaleSettings ist erforderlich, aber nicht beides. AutoscaleSettings-
Durchsatz Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. Int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Name Beschreibung Wert
Ort Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Schnur
Name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource des Typs: databaseAccounts/mongodbDatabases
Eigenschaften Eigenschaften zum Erstellen und Aktualisieren der Azure Cosmos DB MongoDB-Auflistung. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte.
Art Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-05-15"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Name Beschreibung Wert
Optionen Ein Schlüssel-Wert-Optionspaar, das für die Anforderung angewendet werden soll. Dies entspricht den Kopfzeilen, die mit der Anforderung gesendet werden. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
Ressource Das standardmäßige JSON-Format einer MongoDB-Auflistung MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (erforderlich)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Name Beschreibung Wert
analyticalStorageTtl Analytische tTL. Int
createMode Aufzählung, um den Modus der Ressourcenerstellung anzugeben. 'Standard'
"Wiederherstellen"
id Name der Cosmos DB MongoDB-Sammlung Zeichenfolge (erforderlich)
indexe Liste der Indexschlüssel MongoIndex[]
restoreParameters Parameter, die die Informationen zur Wiederherstellung angeben sollen ResourceRestoreParameters-
shardKey Ein Schlüssel-Wert-Paar von Schlüsseln, die für die Anforderung angewendet werden sollen. ShardKeys

MongoIndex

Name Beschreibung Wert
Schlüssel Cosmos DB MongoDB-Sammlungsindexschlüssel MongoIndexKeys
Optionen Schlüsseloptionen für Cosmos DB MongoDB-Auflistung MongoIndexOptions

MongoIndexKeys

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

MongoIndexOptions

Name Beschreibung Wert
expireAfterSeconds Ablauf nach Sekunden Int
einzigartig Ist eindeutig oder nicht Bool

ResourceRestoreParameters

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

ShardKeys

Name Beschreibung Wert

Schilder

Name Beschreibung Wert