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@2024-12-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'
}
}
Valeurs de propriété
Mise à l’échelle automatique
| Nom |
Descriptif |
Valeur |
| maxThroughput |
Représente le débit maximal, la ressource peut effectuer un scale-up. |
Int |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
| Nom |
Descriptif |
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 |
Identité de Service Gérée (ManagedServiceIdentity)
| Nom |
Descriptif |
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. |
« Aucun »
'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
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
| Nom |
Descriptif |
Valeur |
| analyticalStorageTtl |
Durée de vie analytique. |
Int |
| createMode |
Énumération pour indiquer le mode de création de ressources. |
Valeur par défaut
« Restaurer » |
| pièce d'identité |
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 |
Descriptif |
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 |
Descriptif |
Valeur |
| Clés |
Liste des clés pour chaque collection MongoDB dans le service Azure Cosmos DB |
chaîne[] |
MongoIndexOptions
| Nom |
Descriptif |
Valeur |
| expireAfterSeconds |
Expirer après secondes |
Int |
| unique |
Est unique ou non |
Bool |
ResourceRestoreParameters
| Nom |
Descriptif |
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
Exemples d’utilisation
Exemples de démarrage rapide Azure
Les modèles de démarrage rapide Azure suivants contiennent des exemples Bicep pour le déploiement de 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": "2024-12-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"
}
}
Valeurs de propriété
Mise à l’échelle automatique
| Nom |
Descriptif |
Valeur |
| maxThroughput |
Représente le débit maximal, la ressource peut effectuer un scale-up. |
Int |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
| Nom |
Descriptif |
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 |
Identité de Service Gérée (ManagedServiceIdentity)
| Nom |
Descriptif |
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. |
« Aucun »
'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
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
| Nom |
Descriptif |
Valeur |
| apiVersion |
Version de l’API |
'2024-12-01-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
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
| Nom |
Descriptif |
Valeur |
| analyticalStorageTtl |
Durée de vie analytique. |
Int |
| createMode |
Énumération pour indiquer le mode de création de ressources. |
Valeur par défaut
« Restaurer » |
| pièce d'identité |
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 |
Descriptif |
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 |
Descriptif |
Valeur |
| Clés |
Liste des clés pour chaque collection MongoDB dans le service Azure Cosmos DB |
chaîne[] |
MongoIndexOptions
| Nom |
Descriptif |
Valeur |
| expireAfterSeconds |
Expirer après secondes |
Int |
| unique |
Est unique ou non |
Bool |
ResourceRestoreParameters
| Nom |
Descriptif |
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
Exemples d’utilisation
Modèles de démarrage rapide Azure
Les modèles de démarrage rapide Azure suivants déployer ce type de ressource.
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@2024-12-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
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 |
Descriptif |
Valeur |
| maxThroughput |
Représente le débit maximal, la ressource peut effectuer un scale-up. |
Int |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
| Nom |
Descriptif |
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 |
Identité de Service Gérée (ManagedServiceIdentity)
| Nom |
Descriptif |
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. |
« Aucun »
'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
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
| Nom |
Descriptif |
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-12-01-preview » |
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
| Nom |
Descriptif |
Valeur |
| analyticalStorageTtl |
Durée de vie analytique. |
Int |
| createMode |
Énumération pour indiquer le mode de création de ressources. |
Valeur par défaut
« Restaurer » |
| pièce d'identité |
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 |
Descriptif |
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 |
Descriptif |
Valeur |
| Clés |
Liste des clés pour chaque collection MongoDB dans le service Azure Cosmos DB |
chaîne[] |
MongoIndexOptions
| Nom |
Descriptif |
Valeur |
| expireAfterSeconds |
Expirer après secondes |
Int |
| unique |
Est unique ou non |
Bool |
ResourceRestoreParameters
| Nom |
Descriptif |
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
