Base de données Microsoft.DocumentDBAccounts 01-09-2020
- La plus récente
- 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
- Préversion du 01/03/2023
- 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
- 15-06-2021
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 15-01-2021
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
- 2016-03-31
- 2016-03-19
- 2015-11-06
- 2015-04-08
- 2015-04-01
Définition de ressource Bicep
Le type de ressource databaseAccounts peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir 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 des ressources
Pour créer une ressource Microsoft.DocumentDB/databaseAccounts, ajoutez le Bicep suivant à votre modèle.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2020-09-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
kind: 'string'
properties: {
apiProperties: {
serverVersion: 'string'
}
backupPolicy: {
type: 'string'
// For remaining properties, see BackupPolicy objects
}
capabilities: [
{
name: 'string'
}
]
connectorOffer: 'Small'
consistencyPolicy: {
defaultConsistencyLevel: 'string'
maxIntervalInSeconds: int
maxStalenessPrefix: int
}
cors: [
{
allowedHeaders: 'string'
allowedMethods: 'string'
allowedOrigins: 'string'
exposedHeaders: 'string'
maxAgeInSeconds: int
}
]
databaseAccountOfferType: 'Standard'
disableKeyBasedMetadataWriteAccess: bool
enableAnalyticalStorage: bool
enableAutomaticFailover: bool
enableCassandraConnector: bool
enableFreeTier: bool
enableMultipleWriteLocations: bool
ipRules: [
{
ipAddressOrRange: 'string'
}
]
isVirtualNetworkFilterEnabled: bool
keyVaultKeyUri: 'string'
locations: [
{
failoverPriority: int
isZoneRedundant: bool
locationName: 'string'
}
]
virtualNetworkRules: [
{
id: 'string'
ignoreMissingVNetServiceEndpoint: bool
}
]
}
}
Objets BackupPolicy
Définissez la propriété type pour spécifier le type d’objet.
Pour Continu, utilisez :
type: 'Continuous'
Pour Périodique, utilisez :
type: 'Periodic'
periodicModeProperties: {
backupIntervalInMinutes: int
backupRetentionIntervalInHours: int
}
Valeurs de propriétés
databaseAccounts
| Nom | Description | Valeur |
|---|---|---|
| name | Nom de la ressource | chaîne (obligatoire) Limite de caractères : 3-44 Caractères valides : Lettres minuscules, chiffres et traits d’union. Doit commencer par une lettre minuscule ou un chiffre. Le nom de la ressource doit être unique dans Azure. |
| location | Emplacement du groupe de ressources auquel appartient la ressource. | string |
| tags | Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ». | Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles |
| kind | Indique le type de compte de base de données. Cela ne peut être défini qu’au moment de la création du compte de base de données. | 'GlobalDocumentDB' 'MongoDB' 'Analyse' |
| properties | Propriétés permettant de créer et de mettre à jour des comptes de base de données Azure Cosmos DB. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (obligatoire) |
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...
| Nom | Description | Valeur |
|---|---|---|
| apiProperties | Propriétés spécifiques à l’API. Actuellement, pris en charge uniquement pour l’API MongoDB. | ApiProperties |
| backupPolicy | Objet représentant la stratégie pour effectuer des sauvegardes sur un compte. | BackupPolicy |
| capabilities | Liste des fonctionnalités Cosmos DB pour le compte | Capability[] |
| connectorOffer | Type d’offre de connecteur cassandra pour le compte C* de base de données Cosmos DB. | 'Small' |
| consistencyPolicy | Stratégie de cohérence pour le compte Cosmos DB. | CohérencePolicy |
| cors | Stratégie CORS pour le compte de base de données Cosmos DB. | CorsPolicy[] |
| databaseAccountOfferType | Type d’offre pour la base de données | 'Standard' (obligatoire) |
| disableKeyBasedMetadataWriteAccess | Désactiver les opérations d’écriture sur les ressources de métadonnées (bases de données, conteneurs, débit) via des clés de compte | bool |
| enableAnalyticalStorage | Indicateur pour indiquer s’il faut activer l’analyse du stockage. | bool |
| enableAutomaticFailover | Active le basculement automatique de la région d’écriture dans le cas rare où la région n’est pas disponible en raison d’une panne. Le basculement automatique entraîne une nouvelle région d’écriture pour le compte et est choisi en fonction des priorités de basculement configurées pour le compte. | bool |
| enableCassandraConnector | Active le connecteur cassandra sur le compte C* Cosmos DB | bool |
| enableFreeTier | Indicateur pour indiquer si le niveau gratuit est activé. | bool |
| enableMultipleWriteLocations | Permet au compte d’écrire à plusieurs emplacements | bool |
| ipRules | Liste des ipRules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Indicateur pour indiquer s’il faut activer/désactiver les règles de liste de contrôle d’accès de réseau virtuel. | bool |
| keyVaultKeyUri | URI du coffre de clés | string |
| locations | Tableau qui contient les emplacements de géoréplication activés pour le compte Cosmos DB. | Location[] (obligatoire) |
| virtualNetworkRules | Liste des règles de liste de contrôle d’accès de réseau virtuel configurées pour le compte Cosmos DB. | VirtualNetworkRule[] |
ApiProperties
| Nom | Description | Valeur |
|---|---|---|
| serverVersion | Décrit la serverVersion d’un compte MongoDB. | '3.2' '3.6' |
BackupPolicy
| Nom | Description | Valeur |
|---|---|---|
| type | Définir le type d’objet |
Continue Périodique (obligatoire) |
ContinuousModeBackupPolicy
| Nom | Description | Valeur |
|---|---|---|
| type | Décrit le mode des sauvegardes. | 'Continu' (obligatoire) |
PeriodicModeBackupPolicy
| Nom | Description | Valeur |
|---|---|---|
| type | Décrit le mode des sauvegardes. | 'Périodique' (obligatoire) |
| periodicModeProperties | Valeurs de configuration pour la sauvegarde en mode périodique | PeriodicModeProperties |
PeriodicModeProperties
| Nom | Description | Valeur |
|---|---|---|
| backupIntervalInMinutes | Entier représentant l’intervalle en minutes entre deux sauvegardes | int Contraintes : Valeur minimale = 0 |
| backupRetentionIntervalInHours | Entier représentant l’heure (en heures) pendant laquelle chaque sauvegarde est conservée | int Contraintes : Valeur minimale = 0 |
Fonctionnalité
| Nom | Description | Valeur |
|---|---|---|
| name | Nom de la fonctionnalité Cosmos DB. Par exemple, « name » : « EnableCassandra ». Les valeurs actuelles incluent également « EnableTable » et « EnableGremlin ». | string |
CohérencePolicy
| Nom | Description | Valeur |
|---|---|---|
| defaultConsistencyLevel | Niveau de cohérence et paramètres de configuration par défaut du compte Cosmos DB. | 'BoundedStaleness' 'ConsistentPrefix' 'Éventuel' 'Session' 'Strong' (obligatoire) |
| maxIntervalInSeconds | Lorsqu’elle est utilisée avec le niveau de cohérence Borned Staleness, cette valeur représente la durée d’obsolescence (en secondes) tolérée. La plage acceptée pour cette valeur est comprise entre 5 et 86400. Obligatoire lorsque defaultConsistencyPolicy est défini sur « BoundedStaleness ». | int Contraintes : Valeur minimale = 5 Valeur maximale = 86400 |
| maxStalenessPrefix | Lorsqu’elle est utilisée avec le niveau de cohérence Borned Staleness, cette valeur représente le nombre de demandes obsolètes tolérées. Les valeurs acceptables sont 1-2, 147, 483 et 647. Obligatoire lorsque defaultConsistencyPolicy est défini sur « BoundedStaleness ». | int Contraintes : Valeur minimale = 1 Valeur maximale = 2147483647 |
CorsPolicy
| Nom | Description | Valeur |
|---|---|---|
| allowedHeaders | En-têtes de requête que le domaine d’origine peut spécifier dans la requête CORS. | string |
| allowedMethods | Méthodes (verbes de requête HTTP) que le domaine d’origine peut utiliser pour une requête CORS. | string |
| allowedOrigins | Domaines d’origine autorisés à effectuer une requête auprès du service via CORS. | chaîne (obligatoire) |
| exposedHeaders | En-têtes de réponse qui peuvent être envoyés dans la réponse à la requête CORS et exposés par le navigateur à l’émetteur de la requête. | string |
| maxAgeInSeconds | Durée maximale pendant laquelle un navigateur doit mettre en cache la requête OPTIONS préliminaire. | int Contraintes : Valeur minimale = 1 Valeur maximale = 2147483647 |
IpAddressOrRange
| Nom | Description | Valeur |
|---|---|---|
| ipAddressOrRange | Une seule adresse IPv4 ou une seule plage d’adresses IPv4 au format CIDR. Les adresses IP fournies doivent être correctement mises en forme et ne peuvent pas être contenues dans l’une des plages suivantes : 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, car elles ne sont pas applicables par le filtre d’adresse IP. Exemple d’entrées valides : « 23.40.210.245 » ou « 23.40.210.0/8 ». | string |
Emplacement
| Nom | Description | Valeur |
|---|---|---|
| basculementPriority | Priorité de basculement de la région. Une priorité de basculement de 0 indique une région d’écriture. Valeur maximale d’une priorité de basculement = (nombre total de régions - 1). Les valeurs de priorité de basculement doivent être uniques pour chacune des régions dans lesquelles le compte de base de données existe. | int Contraintes : Valeur minimale = 0 |
| isZoneRedundant | Indicateur indiquant si cette région est ou non une région AvailabilityZone | bool |
| locationName | Nom de la région. | string |
VirtualNetworkRule
| Nom | Description | Valeur |
|---|---|---|
| id | ID de ressource d’un sous-réseau, par exemple : /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | string |
| ignoreMissingVNetServiceEndpoint | Créez une règle de pare-feu avant que le point de terminaison de service de réseau virtuel soit activé sur le réseau virtuel. | bool |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
CI/CD à l’aide de Jenkins sur Azure Container Service (AKS)
|
Les conteneurs facilitent la création et le déploiement continus de vos applications. En orchestrant le déploiement de ces conteneurs à l’aide de Kubernetes dans Azure Container Service, vous pouvez obtenir des clusters de conteneurs réplicables et gérables. En configurant une génération continue pour produire vos images et votre orchestration de conteneurs, vous pouvez augmenter la vitesse et la fiabilité de votre déploiement. |
|
Application web avec une base de données SQL, Azure Cosmos DB, Recherche Azure
|
Ce modèle approvisionne une application web, une base de données SQL, Azure Cosmos DB, Azure Search et Application Insights. |
|
Créer un compte Azure Cosmos DB pour l’API Cassandra
|
Ce modèle crée un compte Azure Cosmos DB pour l’API Cassandra dans deux régions avec un espace de clés et une table avec un débit dédié. |
|
Créer un compte de mise à l’échelle automatique Azure Cosmos DB pour l’API Cassandra
|
Ce modèle crée un compte Azure Cosmos DB pour l’API Cassandra dans deux régions avec un espace de clés et une table avec un débit de mise à l’échelle automatique. |
|
Créer un compte Azure CosmosDB
|
Ce modèle ARM est destiné à créer rapidement un compte CosmosDB avec les valeurs minimales requises |
|
Créer un compte Azure Cosmos DB dans plusieurs régions
|
Ce modèle crée un compte Azure Cosmos DB pour n’importe quel type d’API de base de données avec une région principale et une région secondaire avec le choix du niveau de cohérence et du type de basculement. |
|
Créez un compte Azure Cosmos DB de niveau gratuit
|
Ce modèle crée un compte Azure Cosmos DB de niveau gratuit pour l’API SQL avec une base de données avec un débit et un conteneur partagés. |
|
Créer un compte Azure Cosmos DB pour l’API Gremlin
|
Ce modèle crée un compte Azure Cosmos DB pour l’API Gremlin dans deux régions avec une base de données et un graphique à l’aide d’un débit dédié. |
|
Créer un compte Azure Cosmos DB pour la mise à l’échelle automatique de l’API Gremlin
|
Ce modèle crée un compte Azure Cosmos DB pour l’API Gremlin dans deux régions avec une base de données et un graphique à l’aide du débit de mise à l’échelle automatique. |
|
Créer un compte Azure Cosmos pour 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 d’un débit de mise à l’échelle automatique partagé et dédié. |
|
Créer un compte Azure Cosmos DB avec un point de terminaison privé
|
Ce modèle crée un compte Cosmos, un réseau virtuel et un point de terminaison privé exposant le compte Cosmos au réseau virtuel. |
|
Créer un compte Azure Cosmos DB pour l’API Core (SQL)
|
Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur avec un débit avec plusieurs autres options. |
|
API SQL de compte Azure Cosmos DB avec magasin analytique
|
Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur configurés avec un magasin analytique. |
|
Créer une API SQL de compte Azure Cosmos DB avec mise à l’échelle automatique
|
Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur avec un débit de mise à l’échelle automatique avec plusieurs autres options. |
|
Créer des procédures stockées de l’API Azure Cosmos DB Core (SQL)
|
Ce modèle crée un compte Azure Cosmos DB pour l’API Core (SQL) et un conteneur avec une procédure stockée, un déclencheur et une fonction définie par l’utilisateur. |
|
Créer un compte Azure Cosmos DB minimal pour l’API Core (SQL)
|
Ce modèle crée un compte Azure Cosmos DB pour l’API Core (SQL) tout en spécifiant uniquement les propriétés de ressource minimales requises. |
|
Créer Azure Cosmos avec l’API SQL et plusieurs conteneurs
|
Le modèle crée un conteneur Cosmos avec une API SQL et permet d’ajouter des conteneurs mulitple. |
|
Créer un compte SQL Azure Cosmos DB avec RBAC de plan de données
|
Ce modèle crée un compte SQL Cosmos, une définition de rôle gérée en mode natif et une attribution de rôle gérée en mode natif pour une identité AAD. |
|
Créer un compte Azure Cosmos DB serverless pour l’API SQL
|
Ce modèle crée un compte Azure Cosmos DB serverless pour l’API Core (SQL). |
|
Créer un compte Azure Cosmos pour l’API Table
|
Ce modèle crée un compte Azure Cosmos DB pour l’API Table dans deux régions et une seule table avec un débit provisionné. |
|
Créer un compte Azure Cosmos pour l’API Table avec mise à l’échelle automatique
|
Ce modèle crée un compte Azure Cosmos DB pour l’API Table dans deux régions et une seule table avec débit de mise à l’échelle automatique. |
|
Créer un compte Azure Cosmos sans contact et Une application web Azure
|
Ce modèle crée un compte Azure Cosmos, injecte le point de terminaison et les clés Cosmos DB dans les paramètres Azure Web App, puis déploie une application web ASP MVC à partir de GitHub. |
|
Créer un compte Cosmos DB avec Microsoft Defender activé
|
À l’aide de ce modèle ARM, vous pouvez déployer un compte Azure Cosmos DB avec Microsoft Defender pour Azure Cosmos DB activé. Microsoft Defender pour Azure Cosmos DB est une couche de sécurité native Azure qui détecte les tentatives d’exploitation des bases de données dans vos comptes Azure Cosmos DB. Microsoft Defender pour Azure Cosmos DB détecte les injections SQL potentielles, les acteurs malveillants connus en fonction de Microsoft Threat Intelligence, les modèles d’accès suspects et les exploitations potentielles de votre base de données par le biais d’identités compromises ou d’initiés malveillants. |
|
Déployer Azure Data Explorer DB avec une connexion Cosmos DB
|
Déployez Azure Data Explorer DB avec une connexion Cosmos DB. |
|
Compte Azure Cosmos DB avec application web
|
Ce modèle déploie un compte Azure Cosmos DB, un plan App Service et crée une application web dans le plan App Service. Il ajoute également deux paramètres d’application à l’application web qui référencent le point de terminaison de compte Azure Cosmos DB. De cette façon, les solutions déployées sur l’application web peuvent se connecter au point de terminaison de compte Azure Cosmos DB à l’aide de ces paramètres. |
Définition de ressources de modèle ARM
Le type de ressource databaseAccounts peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir 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 des ressources
Pour créer une ressource Microsoft.DocumentDB/databaseAccounts, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.DocumentDB/databaseAccounts",
"apiVersion": "2020-09-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"kind": "string",
"properties": {
"apiProperties": {
"serverVersion": "string"
},
"backupPolicy": {
"type": "string"
// For remaining properties, see BackupPolicy objects
},
"capabilities": [
{
"name": "string"
}
],
"connectorOffer": "Small",
"consistencyPolicy": {
"defaultConsistencyLevel": "string",
"maxIntervalInSeconds": "int",
"maxStalenessPrefix": "int"
},
"cors": [
{
"allowedHeaders": "string",
"allowedMethods": "string",
"allowedOrigins": "string",
"exposedHeaders": "string",
"maxAgeInSeconds": "int"
}
],
"databaseAccountOfferType": "Standard",
"disableKeyBasedMetadataWriteAccess": "bool",
"enableAnalyticalStorage": "bool",
"enableAutomaticFailover": "bool",
"enableCassandraConnector": "bool",
"enableFreeTier": "bool",
"enableMultipleWriteLocations": "bool",
"ipRules": [
{
"ipAddressOrRange": "string"
}
],
"isVirtualNetworkFilterEnabled": "bool",
"keyVaultKeyUri": "string",
"locations": [
{
"failoverPriority": "int",
"isZoneRedundant": "bool",
"locationName": "string"
}
],
"virtualNetworkRules": [
{
"id": "string",
"ignoreMissingVNetServiceEndpoint": "bool"
}
]
}
}
Objets BackupPolicy
Définissez la propriété type pour spécifier le type d’objet.
Pour Continu, utilisez :
"type": "Continuous"
Pour Périodique, utilisez :
"type": "Periodic",
"periodicModeProperties": {
"backupIntervalInMinutes": "int",
"backupRetentionIntervalInHours": "int"
}
Valeurs de propriétés
databaseAccounts
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | 'Microsoft.DocumentDB/databaseAccounts' |
| apiVersion | Version de l’API de ressource | '2020-09-01' |
| name | Nom de la ressource | string (obligatoire) Limite de caractères : 3-44 Caractères valides : Lettres minuscules, chiffres et traits d’union. Doit commencer par une lettre minuscule ou un chiffre. Le nom de la ressource doit être unique dans Azure. |
| location | Emplacement du groupe de ressources auquel appartient la ressource. | string |
| tags | Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ». | Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles |
| kind | Indique le type de compte de base de données. Cela ne peut être défini qu’au moment de la création du compte de base de données. | 'GlobalDocumentDB' 'MongoDB' 'Analyser' |
| properties | Propriétés permettant de créer et de mettre à jour des comptes de base de données Azure Cosmos DB. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (obligatoire) |
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...
| Nom | Description | Valeur |
|---|---|---|
| apiProperties | Propriétés spécifiques à l’API. Actuellement, pris en charge uniquement pour l’API MongoDB. | ApiProperties |
| backupPolicy | Objet représentant la stratégie pour effectuer des sauvegardes sur un compte. | BackupPolicy |
| capabilities | Liste des fonctionnalités Cosmos DB pour le compte | Capability[] |
| connectorOffer | Type d’offre de connecteur cassandra pour le compte C* de base de données Cosmos DB. | 'Small' |
| consistencyPolicy | Stratégie de cohérence pour le compte Cosmos DB. | ConsistencyPolicy |
| cors | Stratégie CORS pour le compte de base de données Cosmos DB. | CorsPolicy[] |
| databaseAccountOfferType | Type d’offre pour la base de données | 'Standard' (obligatoire) |
| disableKeyBasedMetadataWriteAccess | Désactiver les opérations d’écriture sur les ressources de métadonnées (bases de données, conteneurs, débit) via des clés de compte | bool |
| enableAnalyticalStorage | Indicateur pour indiquer s’il faut activer l’analytique du stockage. | bool |
| enableAutomaticFailover | Active le basculement automatique de la région d’écriture dans les rares cas où la région n’est pas disponible en raison d’une panne. Le basculement automatique génère une nouvelle région d’écriture pour le compte et est choisi en fonction des priorités de basculement configurées pour le compte. | bool |
| enableCassandraConnector | Active le connecteur cassandra sur le compte C* Cosmos DB | bool |
| enableFreeTier | Indicateur pour indiquer si le niveau gratuit est activé. | bool |
| enableMultipleWriteLocations | Permet au compte d’écrire dans plusieurs emplacements | bool |
| ipRules | Liste des iprules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Indicateur pour indiquer s’il faut activer/désactiver les règles ACL de réseau virtuel. | bool |
| keyVaultKeyUri | URI du coffre de clés | string |
| locations | Tableau qui contient les emplacements de géoréplication activés pour le compte Cosmos DB. | Location[] (obligatoire) |
| virtualNetworkRules | Liste des règles de liste de contrôle d’accès de réseau virtuel configurées pour le compte Cosmos DB. | VirtualNetworkRule[] |
ApiProperties
| Nom | Description | Valeur |
|---|---|---|
| serverVersion | Décrit la ServerVersion d’un compte MongoDB. | '3.2' '3.6' |
BackupPolicy
| Nom | Description | Valeur |
|---|---|---|
| type | Définir le type d’objet |
Continue Périodique (obligatoire) |
ContinuousModeBackupPolicy
| Nom | Description | Valeur |
|---|---|---|
| type | Décrit le mode des sauvegardes. | 'Continu' (obligatoire) |
PeriodicModeBackupPolicy
| Nom | Description | Valeur |
|---|---|---|
| type | Décrit le mode des sauvegardes. | 'Périodique' (obligatoire) |
| periodicModeProperties | Valeurs de configuration pour la sauvegarde en mode périodique | PeriodicModeProperties |
PeriodicModeProperties
| Nom | Description | Valeur |
|---|---|---|
| backupIntervalInMinutes | Entier représentant l’intervalle en minutes entre deux sauvegardes | int Contraintes : Valeur minimale = 0 |
| backupRetentionIntervalInHours | Entier représentant la durée (en heures) pendant laquelle chaque sauvegarde est conservée | int Contraintes : Valeur minimale = 0 |
Fonctionnalité
| Nom | Description | Valeur |
|---|---|---|
| name | Nom de la fonctionnalité Cosmos DB. Par exemple, « name » : « EnableCassandra ». Les valeurs actuelles incluent également « EnableTable » et « EnableGremlin ». | string |
ConsistencyPolicy
| Nom | Description | Valeur |
|---|---|---|
| defaultConsistencyLevel | Niveau de cohérence et paramètres de configuration par défaut du compte Cosmos DB. | 'BoundedStaleness' 'ConsistentPrefix' 'Éventuel' 'Session' 'Strong' (obligatoire) |
| maxIntervalInSeconds | Lorsqu’elle est utilisée avec le niveau de cohérence de l’obsolescence limitée, cette valeur représente la durée d’obsolescence (en secondes) tolérée. La plage acceptée pour cette valeur est comprise entre 5 et 86400. Obligatoire lorsque defaultConsistencyPolicy est défini sur « BoundedStaleness ». | int Contraintes : Valeur minimale = 5 Valeur maximale = 86400 |
| maxStalenessPrefix | Lorsqu’elle est utilisée avec le niveau de cohérence de l’obsolescence limitée, cette valeur représente le nombre de demandes obsolètes tolérées. Les valeurs acceptables sont 1-2, 147, 483 et 647. Obligatoire lorsque defaultConsistencyPolicy est défini sur « BoundedStaleness ». | int Contraintes : Valeur minimale = 1 Valeur maximale = 2147483647 |
CorsPolicy
| Nom | Description | Valeur |
|---|---|---|
| allowedHeaders | En-têtes de requête que le domaine d’origine peut spécifier dans la requête CORS. | string |
| allowedMethods | Méthodes (verbes de requête HTTP) que le domaine d’origine peut utiliser pour une requête CORS. | string |
| allowedOrigins | Domaines d’origine autorisés à effectuer une demande auprès du service via CORS. | string (obligatoire) |
| exposedHeaders | En-têtes de réponse qui peuvent être envoyés dans la réponse à la requête CORS et exposés par le navigateur à l’émetteur de la requête. | string |
| maxAgeInSeconds | Durée maximale pendant laquelle un navigateur doit mettre en cache la requête OPTIONS préliminaire. | int Contraintes : Valeur minimale = 1 Valeur maximale = 2147483647 |
IpAddressOrRange
| Nom | Description | Valeur |
|---|---|---|
| ipAddressOrRange | Une seule adresse IPv4 ou une seule plage d’adresses IPv4 au format CIDR. Les adresses IP fournies doivent être bien mises en forme et ne peuvent pas être contenues dans l’une des plages suivantes : 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, car elles ne sont pas applicables par le filtre d’adresse IP. Exemple d’entrées valides : « 23.40.210.245 » ou « 23.40.210.0/8 ». | string |
Emplacement
| Nom | Description | Valeur |
|---|---|---|
| failoverPriority | Priorité de basculement de la région. Une priorité de basculement de 0 indique une région d’écriture. Valeur maximale d’une priorité de basculement = (nombre total de régions - 1). Les valeurs de priorité de basculement doivent être uniques pour chacune des régions dans lesquelles le compte de base de données existe. | int Contraintes : Valeur minimale = 0 |
| isZoneRedundant | Indicateur pour indiquer si cette région est une région AvailabilityZone | bool |
| locationName | Nom de la région. | string |
VirtualNetworkRule
| Nom | Description | Valeur |
|---|---|---|
| id | ID de ressource d’un sous-réseau, par exemple : /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | string |
| ignoreMissingVNetServiceEndpoint | Créez une règle de pare-feu avant que le point de terminaison de service de réseau virtuel soit activé sur le réseau virtuel. | bool |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
|
CI/CD à l’aide de Jenkins sur Azure Container Service (AKS)
|
Les conteneurs facilitent la création et le déploiement continus de vos applications. En orchestrant le déploiement de ces conteneurs à l’aide de Kubernetes dans Azure Container Service, vous pouvez obtenir des clusters de conteneurs réplicables et gérables. En configurant une génération continue pour produire vos images et votre orchestration de conteneurs, vous pouvez augmenter la vitesse et la fiabilité de votre déploiement. |
|
Application web avec une base de données SQL, Azure Cosmos DB, Recherche Azure
|
Ce modèle provisionne une application web, une base de données SQL, Azure Cosmos DB, Azure Search et Application Insights. |
|
Créer un compte Azure Cosmos DB pour l’API Cassandra
|
Ce modèle crée un compte Azure Cosmos DB pour l’API Cassandra dans deux régions avec un espace de clés et une table avec un débit dédié. |
|
Créer un compte de mise à l’échelle automatique Azure Cosmos DB pour l’API Cassandra
|
Ce modèle crée un compte Azure Cosmos DB pour l’API Cassandra dans deux régions avec un espace de clés et une table avec un débit de mise à l’échelle automatique. |
|
Créer un compte Azure CosmosDB
|
Ce modèle ARM est destiné à créer rapidement un compte CosmosDB avec les valeurs minimales requises |
|
Créer un compte Azure Cosmos DB dans plusieurs régions
|
Ce modèle crée un compte Azure Cosmos DB pour n’importe quel type d’API de base de données avec une région primaire et secondaire avec le choix du niveau de cohérence et du type de basculement. |
|
Créez un compte Azure Cosmos DB de niveau gratuit
|
Ce modèle crée un compte Azure Cosmos DB de niveau gratuit pour l’API SQL avec une base de données avec un débit et un conteneur partagés. |
|
Créer un compte Azure Cosmos DB pour l’API Gremlin
|
Ce modèle crée un compte Azure Cosmos DB pour l’API Gremlin dans deux régions avec une base de données et un graphique utilisant un débit dédié. |
|
Créer un compte Azure Cosmos DB pour la mise à l’échelle automatique de l’API Gremlin
|
Ce modèle crée un compte Azure Cosmos DB pour l’API Gremlin dans deux régions avec une base de données et un graphique utilisant le débit de mise à l’échelle automatique. |
|
Créer un compte Azure Cosmos pour 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é. |
|
Créer un compte Azure Cosmos DB avec un point de terminaison privé
|
Ce modèle crée un compte Cosmos, un réseau virtuel et un point de terminaison privé exposant le compte Cosmos au réseau virtuel. |
|
Créer un compte Azure Cosmos DB pour l’API Core (SQL)
|
Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur avec débit avec plusieurs autres options. |
|
API SQL de compte Azure Cosmos DB avec magasin analytique
|
Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur configurés avec un magasin analytique. |
|
Créer une API SQL de compte Azure Cosmos DB avec mise à l’échelle automatique
|
Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur avec un débit de mise à l’échelle automatique avec plusieurs autres options. |
|
Créer des procédures stockées de l’API Azure Cosmos DB Core (SQL)
|
Ce modèle crée un compte Azure Cosmos DB pour l’API Core (SQL) et un conteneur avec une procédure stockée, un déclencheur et une fonction définie par l’utilisateur. |
|
Créer un compte Azure Cosmos DB minimal pour l’API Core (SQL)
|
Ce modèle crée un compte Azure Cosmos DB pour l’API Core (SQL) tout en spécifiant uniquement les propriétés de ressource minimales requises. |
|
Créer Azure Cosmos avec l’API SQL et plusieurs conteneurs
|
Le modèle crée un conteneur Cosmos avec une API SQL et permet d’ajouter des conteneurs mulitple. |
|
Créer un compte SQL Azure Cosmos DB avec RBAC de plan de données
|
Ce modèle crée un compte SQL Cosmos, une définition de rôle gérée en mode natif et une attribution de rôle gérée en mode natif pour une identité AAD. |
|
Créer un compte Azure Cosmos DB serverless pour l’API SQL
|
Ce modèle crée un compte Azure Cosmos DB serverless pour l’API Core (SQL). |
|
Créer un compte Azure Cosmos pour l’API Table
|
Ce modèle crée un compte Azure Cosmos DB pour l’API Table dans deux régions et une seule table avec un débit approvisionné. |
|
Créer un compte Azure Cosmos pour l’API Table avec mise à l’échelle automatique
|
Ce modèle crée un compte Azure Cosmos DB pour l’API Table dans deux régions et une seule table avec débit de mise à l’échelle automatique. |
|
Créer un compte Azure Cosmos sans contact et Une application web Azure
|
Ce modèle crée un compte Azure Cosmos, injecte le point de terminaison et les clés Cosmos DB dans les paramètres Azure Web App, puis déploie une application web ASP MVC à partir de GitHub. |
|
Créer un compte Cosmos DB avec Microsoft Defender activé
|
À l’aide de ce modèle ARM, vous pouvez déployer un compte Azure Cosmos DB avec Microsoft Defender pour Azure Cosmos DB activé. Microsoft Defender pour Azure Cosmos DB est une couche de sécurité native Azure qui détecte les tentatives d’exploitation des bases de données dans vos comptes Azure Cosmos DB. Microsoft Defender pour Azure Cosmos DB détecte les injections SQL potentielles, les acteurs malveillants connus basés sur Microsoft Threat Intelligence, les modèles d’accès suspects et les exploitations potentielles de votre base de données par le biais d’identités compromises ou d’initiés malveillants. |
|
Déployer Azure Data Explorer DB avec une connexion Cosmos DB
|
Déployez Azure Data Explorer DB avec une connexion Cosmos DB. |
|
Compte Azure Cosmos DB avec application web
|
Ce modèle déploie un compte Azure Cosmos DB, un plan App Service et crée une application web dans le plan App Service. Il ajoute également deux paramètres d’application à l’application web qui référencent le point de terminaison de compte Azure Cosmos DB. De cette façon, les solutions déployées sur l’application web peuvent se connecter au point de terminaison de compte Azure Cosmos DB à l’aide de ces paramètres. |
Définition de ressource Terraform (fournisseur AzAPI)
Le type de ressource databaseAccounts 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 d’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.DocumentDB/databaseAccounts, ajoutez le Terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts@2020-09-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
apiProperties = {
serverVersion = "string"
}
backupPolicy = {
type = "string"
// For remaining properties, see BackupPolicy objects
}
capabilities = [
{
name = "string"
}
]
connectorOffer = "Small"
consistencyPolicy = {
defaultConsistencyLevel = "string"
maxIntervalInSeconds = int
maxStalenessPrefix = int
}
cors = [
{
allowedHeaders = "string"
allowedMethods = "string"
allowedOrigins = "string"
exposedHeaders = "string"
maxAgeInSeconds = int
}
]
databaseAccountOfferType = "Standard"
disableKeyBasedMetadataWriteAccess = bool
enableAnalyticalStorage = bool
enableAutomaticFailover = bool
enableCassandraConnector = bool
enableFreeTier = bool
enableMultipleWriteLocations = bool
ipRules = [
{
ipAddressOrRange = "string"
}
]
isVirtualNetworkFilterEnabled = bool
keyVaultKeyUri = "string"
locations = [
{
failoverPriority = int
isZoneRedundant = bool
locationName = "string"
}
]
virtualNetworkRules = [
{
id = "string"
ignoreMissingVNetServiceEndpoint = bool
}
]
}
kind = "string"
})
}
Objets BackupPolicy
Définissez la propriété type pour spécifier le type d’objet.
Pour Continu, utilisez :
type = "Continuous"
Pour Périodique, utilisez :
type = "Periodic"
periodicModeProperties = {
backupIntervalInMinutes = int
backupRetentionIntervalInHours = int
}
Valeurs de propriétés
databaseAccounts
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.DocumentDB/databaseAccounts@2020-09-01 » |
| name | Nom de la ressource | string (obligatoire) Limite de caractères : 3-44 Caractères valides : Lettres minuscules, chiffres et traits d’union. Doit commencer par une lettre minuscule ou un chiffre. Le nom de la ressource doit être unique dans Azure. |
| location | Emplacement du groupe de ressources auquel appartient la ressource. | string |
| parent_id | Pour effectuer un déploiement dans un groupe de ressources, utilisez l’ID de ce groupe de ressources. | string (obligatoire) |
| tags | Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ». | Dictionnaire de noms et de valeurs d’étiquettes. |
| kind | Indique le type de compte de base de données. Cela ne peut être défini qu’au moment de la création du compte de base de données. | « GlobalDocumentDB » « MongoDB » « Analyser » |
| properties | Propriétés permettant de créer et de mettre à jour des comptes de base de données Azure Cosmos DB. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (obligatoire) |
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...
| Nom | Description | Valeur |
|---|---|---|
| apiProperties | Propriétés spécifiques à l’API. Actuellement, pris en charge uniquement pour l’API MongoDB. | ApiProperties |
| backupPolicy | Objet représentant la stratégie pour effectuer des sauvegardes sur un compte. | BackupPolicy |
| capabilities | Liste des fonctionnalités Cosmos DB pour le compte | Capability[] |
| connectorOffer | Type d’offre de connecteur cassandra pour le compte C* de base de données Cosmos DB. | « Petit » |
| consistencyPolicy | Stratégie de cohérence pour le compte Cosmos DB. | ConsistencyPolicy |
| cors | Stratégie CORS pour le compte de base de données Cosmos DB. | CorsPolicy[] |
| databaseAccountOfferType | Type d’offre pour la base de données | « Standard » (obligatoire) |
| disableKeyBasedMetadataWriteAccess | Désactiver les opérations d’écriture sur les ressources de métadonnées (bases de données, conteneurs, débit) via des clés de compte | bool |
| enableAnalyticalStorage | Indicateur pour indiquer s’il faut activer l’analytique du stockage. | bool |
| enableAutomaticFailover | Active le basculement automatique de la région d’écriture dans le cas rare où la région n’est pas disponible en raison d’une panne. Le basculement automatique entraîne une nouvelle région d’écriture pour le compte et est choisi en fonction des priorités de basculement configurées pour le compte. | bool |
| enableCassandraConnector | Active le connecteur cassandra sur le compte C* Cosmos DB | bool |
| enableFreeTier | Indicateur pour indiquer si le niveau gratuit est activé. | bool |
| enableMultipleWriteLocations | Permet au compte d’écrire à plusieurs emplacements | bool |
| ipRules | Liste des ipRules. | IpAddressOrRange[] |
| isVirtualNetworkFilterEnabled | Indicateur pour indiquer s’il faut activer/désactiver les règles de liste de contrôle d’accès de réseau virtuel. | bool |
| keyVaultKeyUri | URI du coffre de clés | string |
| locations | Tableau qui contient les emplacements de géoréplication activés pour le compte Cosmos DB. | Location[] (obligatoire) |
| virtualNetworkRules | Liste des règles de liste de contrôle d’accès de réseau virtuel configurées pour le compte Cosmos DB. | VirtualNetworkRule[] |
ApiProperties
| Nom | Description | Valeur |
|---|---|---|
| serverVersion | Décrit la serverVersion d’un compte MongoDB. | "3.2" "3.6" |
BackupPolicy
| Nom | Description | Valeur |
|---|---|---|
| type | Définir le type d’objet |
Continue Périodique (obligatoire) |
ContinuousModeBackupPolicy
| Nom | Description | Valeur |
|---|---|---|
| type | Décrit le mode des sauvegardes. | « Continu » (obligatoire) |
PeriodicModeBackupPolicy
| Nom | Description | Valeur |
|---|---|---|
| type | Décrit le mode des sauvegardes. | « Périodique » (obligatoire) |
| periodicModeProperties | Valeurs de configuration pour la sauvegarde en mode périodique | PeriodicModeProperties |
PeriodicModeProperties
| Nom | Description | Valeur |
|---|---|---|
| backupIntervalInMinutes | Entier représentant l’intervalle en minutes entre deux sauvegardes | int Contraintes : Valeur minimale = 0 |
| backupRetentionIntervalInHours | Entier représentant l’heure (en heures) pendant laquelle chaque sauvegarde est conservée | int Contraintes : Valeur minimale = 0 |
Fonctionnalité
| Nom | Description | Valeur |
|---|---|---|
| name | Nom de la fonctionnalité Cosmos DB. Par exemple, « name » : « EnableCassandra ». Les valeurs actuelles incluent également « EnableTable » et « EnableGremlin ». | string |
CohérencePolicy
| Nom | Description | Valeur |
|---|---|---|
| defaultConsistencyLevel | Niveau de cohérence et paramètres de configuration par défaut du compte Cosmos DB. | « BoundedStaleness » « ConsistentPrefix » « Éventuel » « Session » « Fort » (obligatoire) |
| maxIntervalInSeconds | Lorsqu’elle est utilisée avec le niveau de cohérence Borned Staleness, cette valeur représente la durée d’obsolescence (en secondes) tolérée. La plage acceptée pour cette valeur est comprise entre 5 et 86400. Obligatoire lorsque defaultConsistencyPolicy est défini sur « BoundedStaleness ». | int Contraintes : Valeur minimale = 5 Valeur maximale = 86400 |
| maxStalenessPrefix | Lorsqu’elle est utilisée avec le niveau de cohérence de l’obsolescence limitée, cette valeur représente le nombre de demandes obsolètes tolérées. Les valeurs acceptables sont 1-2, 147, 483 et 647. Obligatoire lorsque defaultConsistencyPolicy est défini sur « BoundedStaleness ». | int Contraintes : Valeur minimale = 1 Valeur maximale = 2147483647 |
CorsPolicy
| Nom | Description | Valeur |
|---|---|---|
| allowedHeaders | En-têtes de requête que le domaine d’origine peut spécifier dans la requête CORS. | string |
| allowedMethods | Méthodes (verbes de requête HTTP) que le domaine d’origine peut utiliser pour une requête CORS. | string |
| allowedOrigins | Domaines d’origine autorisés à effectuer une demande auprès du service via CORS. | string (obligatoire) |
| exposedHeaders | En-têtes de réponse qui peuvent être envoyés dans la réponse à la requête CORS et exposés par le navigateur à l’émetteur de la requête. | string |
| maxAgeInSeconds | Durée maximale pendant laquelle un navigateur doit mettre en cache la requête OPTIONS préliminaire. | int Contraintes : Valeur minimale = 1 Valeur maximale = 2147483647 |
IpAddressOrRange
| Nom | Description | Valeur |
|---|---|---|
| ipAddressOrRange | Une seule adresse IPv4 ou une seule plage d’adresses IPv4 au format CIDR. Les adresses IP fournies doivent être bien mises en forme et ne peuvent pas être contenues dans l’une des plages suivantes : 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, car elles ne sont pas applicables par le filtre d’adresse IP. Exemple d’entrées valides : « 23.40.210.245 » ou « 23.40.210.0/8 ». | string |
Emplacement
| Nom | Description | Valeur |
|---|---|---|
| failoverPriority | Priorité de basculement de la région. Une priorité de basculement de 0 indique une région d’écriture. Valeur maximale d’une priorité de basculement = (nombre total de régions - 1). Les valeurs de priorité de basculement doivent être uniques pour chacune des régions dans lesquelles le compte de base de données existe. | int Contraintes : Valeur minimale = 0 |
| isZoneRedundant | Indicateur pour indiquer si cette région est une région AvailabilityZone | bool |
| locationName | Nom de la région. | string |
VirtualNetworkRule
| Nom | Description | Valeur |
|---|---|---|
| id | ID de ressource d’un sous-réseau, par exemple : /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | string |
| ignoreMissingVNetServiceEndpoint | Créez une règle de pare-feu avant que le point de terminaison de service de réseau virtuel soit activé sur le réseau virtuel. | bool |