Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2023-11-15
Article 21/12/2024
2 contributeurs
Commentaires
Dans cet article
Définition de ressource Bicep
Format de ressource
Valeurs de propriété
Exemples de démarrage rapide
API Versions:
2023-11-15
Définition de ressource Bicep
Le type de ressource databaseAccounts/mongodbDatabases/collections peut être déployé avec des opérations qui ciblent :
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications .
Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, ajoutez le bicep suivant à votre modèle.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-11-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'
}
}
Mise à l’échelle automatique
Agrandir le tableau
Nom
Description
Valeur
maxThroughput
Représente le débit maximal, la ressource peut effectuer un scale-up.
Int
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
Agrandir le tableau
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
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
Agrandir le tableau
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
Agrandir le tableau
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
Agrandir le tableau
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
Agrandir le tableau
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
Agrandir le tableau
Nom
Description
Valeur
Clés
Liste des clés pour chaque collection MongoDB dans le service Azure Cosmos DB
string[]
Agrandir le tableau
Nom
Description
Valeur
expireAfterSeconds
Expirer après secondes
Int
unique
Est unique ou non
Bool
ResourceRestoreParameters
Agrandir le tableau
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
Agrandir le tableau
Agrandir le tableau
Exemples de démarrage rapide
Les exemples de démarrage rapide suivants déploient ce type de ressource.
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 :
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications .
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": "2023-11-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"
}
}
Mise à l’échelle automatique
Agrandir le tableau
Nom
Description
Valeur
maxThroughput
Représente le débit maximal, la ressource peut effectuer un scale-up.
Int
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
Agrandir le tableau
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
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
Agrandir le tableau
Nom
Description
Valeur
apiVersion
Version de l’API
'2023-11-15'
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
Agrandir le tableau
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
Agrandir le tableau
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
Agrandir le tableau
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
Agrandir le tableau
Nom
Description
Valeur
Clés
Liste des clés pour chaque collection MongoDB dans le service Azure Cosmos DB
string[]
Agrandir le tableau
Nom
Description
Valeur
expireAfterSeconds
Expirer après secondes
Int
unique
Est unique ou non
Bool
ResourceRestoreParameters
Agrandir le tableau
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
Agrandir le tableau
Agrandir le tableau
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
Définition de ressource Terraform (fournisseur AzAPI)
Le type de ressource databaseAccounts/mongodbDatabases/collections peut être déployé avec des opérations qui ciblent :
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications .
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@2023-11-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"
}
}
}
})
}
Mise à l’échelle automatique
Agrandir le tableau
Nom
Description
Valeur
maxThroughput
Représente le débit maximal, la ressource peut effectuer un scale-up.
Int
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
Agrandir le tableau
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
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
Agrandir le tableau
Nom
Description
Valeur
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@2023-11-15 »
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
Agrandir le tableau
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
Agrandir le tableau
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
Agrandir le tableau
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
Agrandir le tableau
Nom
Description
Valeur
Clés
Liste des clés pour chaque collection MongoDB dans le service Azure Cosmos DB
string[]
Agrandir le tableau
Nom
Description
Valeur
expireAfterSeconds
Expirer après secondes
Int
unique
Est unique ou non
Bool
ResourceRestoreParameters
Agrandir le tableau
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
Agrandir le tableau
Agrandir le tableau