Définition de ressource Bicep
Le type de ressource databaseAccounts/mongodbDatabases 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, ajoutez le bicep suivant à votre modèle.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2025-05-01-preview' = {
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
createMode: 'string'
id: 'string'
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
restoreWithTtlDisabled: bool
}
}
}
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
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions
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
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 |
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 |
Propriétés |
Propriétés permettant de créer et de mettre à jour une base de données MongoDB Azure Cosmos DB. |
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties (obligatoire) |
étiquettes |
Balises de ressource |
Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles |
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource
Nom |
Descriptif |
Valeur |
createMode |
Énumération pour indiquer le mode de création de ressources. |
Valeur par défaut 'Restore' |
pièce d'identité |
Nom de la base de données MongoDB Cosmos DB |
chaîne (obligatoire) |
restoreParameters |
Paramètres pour indiquer les informations relatives à la restauration |
ResourceRestoreParameters |
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 |
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 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, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases",
"apiVersion": "2025-05-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"createMode": "string",
"id": "string",
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string",
"restoreWithTtlDisabled": "bool"
}
}
},
"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
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions
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
Nom |
Descriptif |
Valeur |
apiVersion |
Version de l’API |
'2025-05-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 une base de données MongoDB Azure Cosmos DB. |
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties (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' |
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource
Nom |
Descriptif |
Valeur |
createMode |
Énumération pour indiquer le mode de création de ressources. |
Valeur par défaut 'Restore' |
pièce d'identité |
Nom de la base de données MongoDB Cosmos DB |
chaîne (obligatoire) |
restoreParameters |
Paramètres pour indiquer les informations relatives à la restauration |
ResourceRestoreParameters |
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 |
Exemples d’utilisation
Modèles de démarrage rapide Microsoft Azure
Les modèles de démarrage rapide Azure suivants déployer ce type de ressource.
Le type de ressource databaseAccounts/mongodbDatabases 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, ajoutez la terraform suivante à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2025-05-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 = {
createMode = "string"
id = "string"
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
restoreWithTtlDisabled = bool
}
}
}
}
}
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
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions
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
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 |
Propriétés |
Propriétés permettant de créer et de mettre à jour une base de données MongoDB Azure Cosmos DB. |
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties (obligatoire) |
étiquettes |
Balises de ressource |
Dictionnaire de noms et de valeurs d’étiquettes. |
type |
Type de ressource |
« Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2025-05-01-preview » |
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource
Nom |
Descriptif |
Valeur |
createMode |
Énumération pour indiquer le mode de création de ressources. |
Valeur par défaut 'Restore' |
pièce d'identité |
Nom de la base de données MongoDB Cosmos DB |
chaîne (obligatoire) |
restoreParameters |
Paramètres pour indiquer les informations relatives à la restauration |
ResourceRestoreParameters |
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 |