Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2024-05-15-preview

• dernière
• 2024-12-01-preview
• 2024-11-15
• 2024-09-01-preview
• 2024-08-15
• 2024-05-15
• 2024-05-15-preview
• 2024-02-15-preview
• 2023-11-15
• 2023-11-15-preview
• 2023-09-15
• 2023-09-15-preview
• 2023-04-15
• 2023-03-15
• 2023-03-15-preview
• 2023-03-01-preview
• 2022-11-15
• 2022-11-15-preview
• 2022-08-15
• 2022-08-15-preview
• 2022-05-15
• 2022-05-15-preview
• 2022-02-15-preview
• 2021-11-15-preview
• 2021-10-15
• 2021-10-15-preview
• 2021-07-01-preview
• 2021-06-15
• 2021-05-15
• 2021-04-15
• 2021-04-01-preview
• 2021-03-15
• 2021-03-01-preview
• 2021-01-15
• 2020-09-01
• 2020-06-01-preview
• 2020-04-01
• 2020-03-01
• 2019-12-12
• 2019-08-01

Définition de ressource Bicep

Le type de ressource databaseAccounts/mongodbDatabases/collections peut être déployé avec des opérations qui ciblent :

• groupes de ressources - Consultez commandes de déploiement de groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, ajoutez le bicep suivant à votre modèle.

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

Valeurs de propriété

Mise à l’échelle automatique

Nom	Description	Valeur
maxThroughput	Représente le débit maximal, la ressource peut effectuer un scale-up.	Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nom	Description	Valeur

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Nom	Description	Valeur
autoscaleSettings	Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings est requis, mais pas les deux.	de mise à l’échelle automatique
débit	Unités de requête par seconde. Par exemple, « débit » : 1 0000.	Int

ManagedServiceIdentity

Nom	Description	Valeur
type	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned'
userAssignedIdentities	Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nom	Description	Valeur

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Nom	Description	Valeur
identité	Identité de la ressource.	ManagedServiceIdentity
emplacement	Emplacement du groupe de ressources auquel appartient la ressource.	corde
nom	Nom de la ressource	chaîne (obligatoire)
parent	Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente. Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente.	Nom symbolique de la ressource de type : databaseAccounts/mongodbDatabases
Propriétés	Propriétés permettant de créer et de mettre à jour la collection MongoDB Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (obligatoire)
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Nom	Description	Valeur
Options	Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
ressource	Format JSON standard d’une collection MongoDB	MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (obligatoire)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Nom	Description	Valeur
analyticalStorageTtl	Durée de vie analytique.	Int
createMode	Énumération pour indiquer le mode de création de ressources.	'Default' 'Restore'
id	Nom de la collection MongoDB Cosmos DB	chaîne (obligatoire)
Index	Liste des clés d’index	MongoIndex[]
restoreParameters	Paramètres pour indiquer les informations relatives à la restauration	ResourceRestoreParameters
shardKey	Paire clé-valeur de clés de partition à appliquer pour la requête.	ShardKeys

MongoIndex

Nom	Description	Valeur
clé	Clés d’index de collection MongoDB Cosmos DB	MongoIndexKeys
Options	Options de clé d’index d’index de collection Cosmos DB MongoDB	MongoIndexOptions

MongoIndexKeys

Nom	Description	Valeur
Clés	Liste des clés pour chaque collection MongoDB dans le service Azure Cosmos DB	string[]

MongoIndexOptions

Nom	Description	Valeur
expireAfterSeconds	Expirer après secondes	Int
unique	Est unique ou non	Bool

ResourceRestoreParameters

Nom	Description	Valeur
restoreSource	ID du compte de base de données pouvant être restauré à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts}}	corde
restoreTimestampInUtc	Heure à laquelle le compte doit être restauré (format ISO-8601).	corde
restoreWithTtlDisabled	Spécifie si le compte restauré aura le délai d'To-Live désactivé lors de la restauration réussie.	Bool

ShardKeys

Nom	Description	Valeur

Étiquettes

Nom	Description	Valeur

Exemples de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep	Description
Créer un compte Azure Cosmos pour l' de l’API MongoDB	Ce modèle crée un compte Azure Cosmos DB pour l’API MongoDB 4.2 dans deux régions à l’aide d’un débit partagé et dédié avec deux collections.
Créer un compte Azure Cosmos pour la mise à l’échelle automatique de l’API MongoDB	Ce modèle crée un compte Azure Cosmos DB pour l’API MongoDB 4.2 dans deux régions à l’aide du débit de mise à l’échelle automatique partagé et dédié.

Définition de ressource de modèle ARM

Le type de ressource databaseAccounts/mongodbDatabases/collections peut être déployé avec des opérations qui ciblent :

• groupes de ressources - Consultez commandes de déploiement de groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, ajoutez le code JSON suivant à votre modèle.

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

Valeurs de propriété

Mise à l’échelle automatique

Nom	Description	Valeur
maxThroughput	Représente le débit maximal, la ressource peut effectuer un scale-up.	Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nom	Description	Valeur

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Nom	Description	Valeur
autoscaleSettings	Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings est requis, mais pas les deux.	de mise à l’échelle automatique
débit	Unités de requête par seconde. Par exemple, « débit » : 1 0000.	Int

ManagedServiceIdentity

Nom	Description	Valeur
type	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned'
userAssignedIdentities	Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nom	Description	Valeur

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Nom	Description	Valeur
apiVersion	Version de l’API	'2024-05-15-preview'
identité	Identité de la ressource.	ManagedServiceIdentity
emplacement	Emplacement du groupe de ressources auquel appartient la ressource.	corde
nom	Nom de la ressource	chaîne (obligatoire)
Propriétés	Propriétés permettant de créer et de mettre à jour la collection MongoDB Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (obligatoire)
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type	Type de ressource	'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections'

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Nom	Description	Valeur
Options	Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
ressource	Format JSON standard d’une collection MongoDB	MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (obligatoire)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Nom	Description	Valeur
analyticalStorageTtl	Durée de vie analytique.	Int
createMode	Énumération pour indiquer le mode de création de ressources.	'Default' 'Restore'
id	Nom de la collection MongoDB Cosmos DB	chaîne (obligatoire)
Index	Liste des clés d’index	MongoIndex[]
restoreParameters	Paramètres pour indiquer les informations relatives à la restauration	ResourceRestoreParameters
shardKey	Paire clé-valeur de clés de partition à appliquer pour la requête.	ShardKeys

MongoIndex

Nom	Description	Valeur
clé	Clés d’index de collection MongoDB Cosmos DB	MongoIndexKeys
Options	Options de clé d’index d’index de collection Cosmos DB MongoDB	MongoIndexOptions

MongoIndexKeys

Nom	Description	Valeur
Clés	Liste des clés pour chaque collection MongoDB dans le service Azure Cosmos DB	string[]

MongoIndexOptions

Nom	Description	Valeur
expireAfterSeconds	Expirer après secondes	Int
unique	Est unique ou non	Bool

ResourceRestoreParameters

Nom	Description	Valeur
restoreSource	ID du compte de base de données pouvant être restauré à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts}}	corde
restoreTimestampInUtc	Heure à laquelle le compte doit être restauré (format ISO-8601).	corde
restoreWithTtlDisabled	Spécifie si le compte restauré aura le délai d'To-Live désactivé lors de la restauration réussie.	Bool

ShardKeys

Nom	Description	Valeur

Étiquettes

Nom	Description	Valeur

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle	Description
Créer un compte Azure Cosmos pour l' de l’API MongoDB	Ce modèle crée un compte Azure Cosmos DB pour l’API MongoDB 4.2 dans deux régions à l’aide d’un débit partagé et dédié avec deux collections.
Créer un compte Azure Cosmos pour la mise à l’échelle automatique de l’API MongoDB	Ce modèle crée un compte Azure Cosmos DB pour l’API MongoDB 4.2 dans deux régions à l’aide du débit de mise à l’échelle automatique partagé et dédié.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource databaseAccounts/mongodbDatabases/collections peut être déployé avec des opérations qui ciblent :

• groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, ajoutez terraform suivante à votre modèle.

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

Valeurs de propriété

Mise à l’échelle automatique

Nom	Description	Valeur
maxThroughput	Représente le débit maximal, la ressource peut effectuer un scale-up.	Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nom	Description	Valeur

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Nom	Description	Valeur
autoscaleSettings	Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings est requis, mais pas les deux.	de mise à l’échelle automatique
débit	Unités de requête par seconde. Par exemple, « débit » : 1 0000.	Int

ManagedServiceIdentity

Nom	Description	Valeur
type	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned'
userAssignedIdentities	Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nom	Description	Valeur

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Nom	Description	Valeur
identité	Identité de la ressource.	ManagedServiceIdentity
emplacement	Emplacement du groupe de ressources auquel appartient la ressource.	corde
nom	Nom de la ressource	chaîne (obligatoire)
parent_id	ID de la ressource qui est le parent de cette ressource.	ID de ressource de type : databaseAccounts/mongodbDatabases
Propriétés	Propriétés permettant de créer et de mettre à jour la collection MongoDB Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (obligatoire)
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes.
type	Type de ressource	« Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-05-15-preview »

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Nom	Description	Valeur
Options	Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
ressource	Format JSON standard d’une collection MongoDB	MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (obligatoire)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Nom	Description	Valeur
analyticalStorageTtl	Durée de vie analytique.	Int
createMode	Énumération pour indiquer le mode de création de ressources.	'Default' 'Restore'
id	Nom de la collection MongoDB Cosmos DB	chaîne (obligatoire)
Index	Liste des clés d’index	MongoIndex[]
restoreParameters	Paramètres pour indiquer les informations relatives à la restauration	ResourceRestoreParameters
shardKey	Paire clé-valeur de clés de partition à appliquer pour la requête.	ShardKeys

MongoIndex

Nom	Description	Valeur
clé	Clés d’index de collection MongoDB Cosmos DB	MongoIndexKeys
Options	Options de clé d’index d’index de collection Cosmos DB MongoDB	MongoIndexOptions

MongoIndexKeys

Nom	Description	Valeur
Clés	Liste des clés pour chaque collection MongoDB dans le service Azure Cosmos DB	string[]

MongoIndexOptions

Nom	Description	Valeur
expireAfterSeconds	Expirer après secondes	Int
unique	Est unique ou non	Bool

ResourceRestoreParameters

Nom	Description	Valeur
restoreSource	ID du compte de base de données pouvant être restauré à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts}}	corde
restoreTimestampInUtc	Heure à laquelle le compte doit être restauré (format ISO-8601).	corde
restoreWithTtlDisabled	Spécifie si le compte restauré aura le délai d'To-Live désactivé lors de la restauration réussie.	Bool

ShardKeys

Nom	Description	Valeur

Étiquettes

Nom	Description	Valeur