Database Microsoft.DocumentDBAccounts/mongodbDatabases/collections 2024-05-15

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa databaseAccounts/mongodbDatabases/collections può essere distribuito con operazioni destinate:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, aggiungere il bicep seguente al modello.

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

Valori delle proprietà

databaseAccounts/mongodbDatabases/collections

Nome Descrizione valore
name Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio in Bicep.		 stringa (obbligatorio)
posizione Posizione del gruppo di risorse a cui appartiene la risorsa. string
tags I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB". Dizionario di nomi e valori di tag. Vedere Tag nei modelli
padre In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere Risorsa figlio esterna alla risorsa padre.		 Nome simbolico per la risorsa di tipo: mongodbDatabases
properties Proprietà per creare e aggiornare la raccolta MongoDB di Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obbligatorio)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Nome Descrizione Valore
opzioni Coppia chiave-valore di opzioni da applicare per la richiesta. Corrisponde alle intestazioni inviate con la richiesta. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
Risorsa Formato JSON standard di una raccolta MongoDB MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (obbligatorio)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Nome Descrizione Valore
autoscaleSettings Specifica le impostazioni di scalabilità automatica. Nota: la velocità effettiva o la funzionalità autoscaleSettings è obbligatoria, ma non entrambe. Impostazioni di scalabilità automatica
throughput Unità richiesta al secondo. Ad esempio, "velocità effettiva": 10000. INT

Impostazioni di scalabilità automatica

Nome Descrizione Valore
maxThroughput Rappresenta la velocità effettiva massima, la risorsa può aumentare le prestazioni. INT

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Nome Descrizione Valore
analyticalStorageTtl TTL analitico. INT
createMode Enumerazione per indicare la modalità di creazione delle risorse. Impostazione predefinita
'Restore'
id Nome della raccolta MongoDB di Cosmos DB stringa (obbligatorio)
indici Elenco di chiavi di indice MongoIndex[]
restoreParameters Parametri per indicare le informazioni sul ripristino ResourceRestoreParameters
shardKey Coppia chiave-valore di chiavi di partizione da applicare per la richiesta. ShardKeys

MongoIndex

Nome Descrizione Valore
chiave Chiavi di indice della raccolta MongoDB di Cosmos DB MongoIndexKeys
opzioni Opzioni chiave dell'indice della raccolta MongoDB di Cosmos DB MongoIndexOptions

MongoIndexKeys

Nome Descrizione Valore
chiavi Elenco di chiavi per ogni raccolta MongoDB nel servizio Azure Cosmos DB string[]

MongoIndexOptions

Nome Descrizione Valore
expireAfterSeconds Scadenza dopo secondi INT
unique Univoco o meno bool

ResourceRestoreParameters

Nome Descrizione Valore
restoreSource ID dell'account del database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Ora in cui è necessario ripristinare l'account (formato ISO-8601). string

ShardKeys

Nome Descrizione Valore
{proprietà personalizzata} string

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Modello Descrizione
Creare un account Azure Cosmos per l'API MongoDB

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API MongoDB 4.2 in due aree usando la velocità effettiva condivisa e dedicata con due raccolte.
Creare un account Azure Cosmos per la scalabilità automatica dell'API MongoDB

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API MongoDB 4.2 in due aree usando la velocità effettiva di scalabilità automatica condivisa e dedicata.

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa databaseAccounts/mongodbDatabases/collections può essere distribuito con operazioni destinate:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
  "apiVersion": "2024-05-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"
      }
    }
  }
}

Valori delle proprietà

databaseAccounts/mongodbDatabases/collections

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections'
apiVersion Versione dell'API della risorsa '2024-05-15'
name Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio nei modelli di RESOURCE JSON.		 stringa (obbligatoria)
posizione Posizione del gruppo di risorse a cui appartiene la risorsa. string
tags I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori "defaultExperience" correnti includono anche "Table", "Graph", "DocumentDB" e "MongoDB". Dizionario dei nomi e dei valori dei tag. Vedere Tag nei modelli
properties Proprietà per creare e aggiornare la raccolta MongoDB di Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obbligatorio)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Nome Descrizione Valore
opzioni Coppia chiave-valore delle opzioni da applicare per la richiesta. Corrisponde alle intestazioni inviate con la richiesta. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
Risorsa Formato JSON standard di una raccolta MongoDB MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (obbligatorio)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Nome Descrizione Valore
autoscaleSettings Specifica le impostazioni di scalabilità automatica. Nota: è necessaria la velocità effettiva o la scalabilità automaticaSettings, ma non entrambe. Scalabilità automaticaSettings
throughput Unità richiesta al secondo. Ad esempio, "velocità effettiva": 10000. INT

Scalabilità automaticaSettings

Nome Descrizione Valore
maxThroughput Rappresenta la velocità effettiva massima, la risorsa può aumentare fino a. INT

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Nome Descrizione Valore
analyticsStorageTtl TTL analitico. INT
createMode Enumerazione per indicare la modalità di creazione delle risorse. Impostazione predefinita
'Restore'
id Nome dell'insieme MongoDB cosmos DB stringa (obbligatoria)
indici Elenco delle chiavi di indice MongoIndex[]
restoreParameters Parametri per indicare le informazioni sul ripristino ResourceRestoreParameters
shardKey Coppia chiave-valore di chiavi da applicare per la richiesta. ShardKeys

MongoIndex

Nome Descrizione Valore
chiave Chiavi di indice dell'insieme MongoDB di Cosmos DB MongoIndexKeys
opzioni Opzioni della chiave di indice dell'insieme MongoDB di Cosmos DB MongoIndexOptions

MongoIndexKeys

Nome Descrizione Valore
chiavi Elenco di chiavi per ogni raccolta MongoDB nel servizio Azure Cosmos DB string[]

MongoIndexOptions

Nome Descrizione Valore
expireAfterSeconds Scadenza dopo secondi INT
unique È univoco o non bool

ResourceRestoreParameters

Nome Descrizione Valore
restoreSource ID dell'account del database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Ora in cui è necessario ripristinare l'account (formato ISO-8601). string

ShardKeys

Nome Descrizione Valore
{proprietà personalizzata} string

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Modello Descrizione
Creare un account Azure Cosmos per l'API MongoDB

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API MongoDB 4.2 in due aree usando la velocità effettiva condivisa e dedicata con due raccolte.
Creare un account Azure Cosmos per la scalabilità automatica dell'API MongoDB

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API MongoDB 4.2 in due aree usando la velocità effettiva di scalabilità automatica condivisa e dedicata.

Definizione della risorsa Terraform (provider AzAPI)

Il tipo di risorsa databaseAccounts/mongodbDatabases/collections può essere distribuito con operazioni destinate:

  • Gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, aggiungere il codice Terraform seguente al modello.

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

Valori delle proprietà

databaseAccounts/mongodbDatabases/collections

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-05-15"
name Nome della risorsa stringa (obbligatorio)
posizione Posizione del gruppo di risorse a cui appartiene la risorsa. string
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: mongodbDatabases
tags I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB". Dizionario di nomi e valori di tag.
properties Proprietà per creare e aggiornare la raccolta MongoDB di Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obbligatorio)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Nome Descrizione Valore
opzioni Coppia chiave-valore di opzioni da applicare per la richiesta. Corrisponde alle intestazioni inviate con la richiesta. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
Risorsa Formato JSON standard di una raccolta MongoDB MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (obbligatorio)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Nome Descrizione Valore
autoscaleSettings Specifica le impostazioni di scalabilità automatica. Nota: la velocità effettiva o la funzionalità autoscaleSettings è obbligatoria, ma non entrambe. Impostazioni di scalabilità automatica
throughput Unità richiesta al secondo. Ad esempio, "velocità effettiva": 10000. INT

Impostazioni di scalabilità automatica

Nome Descrizione Valore
maxThroughput Rappresenta la velocità effettiva massima, la risorsa può aumentare le prestazioni. INT

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Nome Descrizione Valore
analyticalStorageTtl TTL analitico. INT
createMode Enumerazione per indicare la modalità di creazione delle risorse. "Default"
"Ripristina"
id Nome della raccolta MongoDB di Cosmos DB stringa (obbligatorio)
indici Elenco di chiavi di indice MongoIndex[]
restoreParameters Parametri per indicare le informazioni sul ripristino ResourceRestoreParameters
shardKey Coppia chiave-valore di chiavi di partizione da applicare per la richiesta. ShardKeys

MongoIndex

Nome Descrizione Valore
chiave Chiavi di indice della raccolta MongoDB di Cosmos DB MongoIndexKeys
opzioni Opzioni chiave dell'indice della raccolta MongoDB di Cosmos DB MongoIndexOptions

MongoIndexKeys

Nome Descrizione Valore
chiavi Elenco di chiavi per ogni raccolta MongoDB nel servizio Azure Cosmos DB string[]

MongoIndexOptions

Nome Descrizione Valore
expireAfterSeconds Scadenza dopo secondi INT
unique Univoco o meno bool

ResourceRestoreParameters

Nome Descrizione Valore
restoreSource ID dell'account del database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Ora in cui è necessario ripristinare l'account (formato ISO-8601). string

ShardKeys

Nome Descrizione Valore
{proprietà personalizzata} string