Condividi tramite

Database Microsoft.DocumentDBAccounts/mongodbDatabases/collections 2024-09-01-preview

  • Articolo

Definizione di risorsa Bicep

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

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

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

Formato risorsa

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-09-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  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'
        restoreWithTtlDisabled: bool
      }
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valori delle proprietà

Impostazioni di scalabilità automatica

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nome Descrizione Valore

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

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

ManagedServiceIdentity

Nome Descrizione Valore
digitare Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'None' rimuoverà tutte le identità dal servizio. 'Nessuno'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Elenco delle identità utente associate alla risorsa. I riferimenti alla chiave del dizionario delle identità utente saranno id risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nome Descrizione Valore

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Nome Descrizione Valore
identità Identità per la risorsa. ManagedServiceIdentity
ubicazione Posizione del gruppo di risorse a cui appartiene la risorsa. corda
nome Nome della risorsa stringa (obbligatorio)
genitore 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 all'esterno della risorsa padre.		 Nome simbolico per la risorsa di tipo: databaseAccounts/mongodbDatabases
proprietà Proprietà per creare e aggiornare la raccolta MongoDB di Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (obbligatorio)
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

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

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Nome Descrizione Valore
analyticalStorageTtl TTL analitico. Int
createMode Enumerazione per indicare la modalità di creazione della risorsa. 'Default'
'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
unico Univoco o non è univoco Bool

ResourceRestoreParameters

Nome Descrizione Valore
restoreSource ID dell'account di database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} corda
restoreTimestampInUtc Ora di ripristino dell'account (formato ISO-8601). corda
restoreWithTtlDisabled Specifica se l'account ripristinato avrà time-To-Live disabilitato al termine del ripristino. Bool

ShardKeys

Nome Descrizione Valore

Tag

Nome Descrizione Valore

Esempi di avvio rapido

Gli esempi di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Bicep File Descrizione
Creare un account Azure Cosmos per l'API MongoDB 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 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 a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

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

Formato 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-09-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "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",
        "restoreWithTtlDisabled": "bool"
      },
      "shardKey": {
        "{customized property}": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valori delle proprietà

Impostazioni di scalabilità automatica

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nome Descrizione Valore

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

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

ManagedServiceIdentity

Nome Descrizione Valore
digitare Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'None' rimuoverà tutte le identità dal servizio. 'Nessuno'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Elenco delle identità utente associate alla risorsa. I riferimenti alla chiave del dizionario delle identità utente saranno id risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nome Descrizione Valore

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Nome Descrizione Valore
apiVersion Versione dell'API '2024-09-01-preview'
identità Identità per la risorsa. ManagedServiceIdentity
ubicazione Posizione del gruppo di risorse a cui appartiene la risorsa. corda
nome Nome della risorsa stringa (obbligatorio)
proprietà Proprietà per creare e aggiornare la raccolta MongoDB di Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (obbligatorio)
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli
digitare Tipo di risorsa 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections'

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

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

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Nome Descrizione Valore
analyticalStorageTtl TTL analitico. Int
createMode Enumerazione per indicare la modalità di creazione della risorsa. 'Default'
'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
unico Univoco o non è univoco Bool

ResourceRestoreParameters

Nome Descrizione Valore
restoreSource ID dell'account di database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} corda
restoreTimestampInUtc Ora di ripristino dell'account (formato ISO-8601). corda
restoreWithTtlDisabled Specifica se l'account ripristinato avrà time-To-Live disabilitato al termine del ripristino. Bool

ShardKeys

Nome Descrizione Valore

Tag

Nome Descrizione Valore

Modelli di avvio rapido

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

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

Distribuire 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

Distribuire 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 Terraform (provider AzAPI)

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

  • gruppi di risorse

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

Formato 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-09-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  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"
          restoreWithTtlDisabled = bool
        }
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

Valori delle proprietà

Impostazioni di scalabilità automatica

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nome Descrizione Valore

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

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

ManagedServiceIdentity

Nome Descrizione Valore
digitare Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'None' rimuoverà tutte le identità dal servizio. 'Nessuno'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Elenco delle identità utente associate alla risorsa. I riferimenti alla chiave del dizionario delle identità utente saranno id risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nome Descrizione Valore

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Nome Descrizione Valore
identità Identità per la risorsa. ManagedServiceIdentity
ubicazione Posizione del gruppo di risorse a cui appartiene la risorsa. corda
nome Nome della risorsa stringa (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: databaseAccounts/mongodbDatabases
proprietà Proprietà per creare e aggiornare la raccolta MongoDB di Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (obbligatorio)
Tag Tag delle risorse Dizionario di nomi e valori di tag.
digitare Tipo di risorsa "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-09-01-preview"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

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

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Nome Descrizione Valore
analyticalStorageTtl TTL analitico. Int
createMode Enumerazione per indicare la modalità di creazione della risorsa. 'Default'
'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
unico Univoco o non è univoco Bool

ResourceRestoreParameters

Nome Descrizione Valore
restoreSource ID dell'account di database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} corda
restoreTimestampInUtc Ora di ripristino dell'account (formato ISO-8601). corda
restoreWithTtlDisabled Specifica se l'account ripristinato avrà time-To-Live disabilitato al termine del ripristino. Bool

ShardKeys

Nome Descrizione Valore

Tag

Nome Descrizione Valore