Partager via

Microsoft.DocumentDB databaseAccounts 2023-04-15

  • Article

Définition de ressource Bicep

Le type de ressource databaseAccounts 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.

Format de ressource

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2023-04-15' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    analyticalStorageConfiguration: {
      schemaType: 'string'
    }
    apiProperties: {
      serverVersion: 'string'
    }
    backupPolicy: {
      migrationState: {
        startTime: 'string'
        status: 'string'
        targetType: 'string'
      }
      type: 'string'
      // For remaining properties, see BackupPolicy objects
    }
    capabilities: [
      {
        name: 'string'
      }
    ]
    capacity: {
      totalThroughputLimit: int
    }
    connectorOffer: 'string'
    consistencyPolicy: {
      defaultConsistencyLevel: 'string'
      maxIntervalInSeconds: int
      maxStalenessPrefix: int
    }
    cors: [
      {
        allowedHeaders: 'string'
        allowedMethods: 'string'
        allowedOrigins: 'string'
        exposedHeaders: 'string'
        maxAgeInSeconds: int
      }
    ]
    createMode: 'string'
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'string'
    disableKeyBasedMetadataWriteAccess: bool
    disableLocalAuth: bool
    enableAnalyticalStorage: bool
    enableAutomaticFailover: bool
    enableCassandraConnector: bool
    enableFreeTier: bool
    enableMultipleWriteLocations: bool
    enablePartitionMerge: bool
    ipRules: [
      {
        ipAddressOrRange: 'string'
      }
    ]
    isVirtualNetworkFilterEnabled: bool
    keyVaultKeyUri: 'string'
    locations: [
      {
        failoverPriority: int
        isZoneRedundant: bool
        locationName: 'string'
      }
    ]
    minimalTlsVersion: 'string'
    networkAclBypass: 'string'
    networkAclBypassResourceIds: [
      'string'
    ]
    publicNetworkAccess: 'string'
    restoreParameters: {
      databasesToRestore: [
        {
          collectionNames: [
            'string'
          ]
          databaseName: 'string'
        }
      ]
      gremlinDatabasesToRestore: [
        {
          databaseName: 'string'
          graphNames: [
            'string'
          ]
        }
      ]
      restoreMode: 'string'
      restoreSource: 'string'
      restoreTimestampInUtc: 'string'
      tablesToRestore: [
        'string'
      ]
    }
    virtualNetworkRules: [
      {
        id: 'string'
        ignoreMissingVNetServiceEndpoint: bool
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Objets BackupPolicy

Définissez le type propriété pour spécifier le type d’objet.

Pour continu, utilisez :

{
  continuousModeProperties: {
    tier: 'string'
  }
  type: 'Continuous'
}

Pour périodique, utilisez :

{
  periodicModeProperties: {
    backupIntervalInMinutes: int
    backupRetentionIntervalInHours: int
    backupStorageRedundancy: 'string'
  }
  type: 'Periodic'
}

Valeurs de propriété

AnalyticalStorageConfiguration

Nom Description Valeur
schemaType Décrit les types de schémas pour le stockage analytique. 'FullFidelity'
'WellDefined'

ApiProperties

Nom Description Valeur
serverVersion Décrit serverVersion d’un compte MongoDB. '3.2'
'3.6'
'4.0'
'4.2'

BackupPolicy

Nom Description Valeur
migrationState Objet représentant l’état de la migration entre les stratégies de sauvegarde. BackupPolicyMigrationState
type Défini sur « Continuous » pour le type ContinuousModeBackupPolicy. Défini sur « Periodic » pour le type PeriodicModeBackupPolicy. 'Continu'
'Périodique' (obligatoire)

BackupPolicyMigrationState

Nom Description Valeur
startTime Heure à laquelle la migration de la stratégie de sauvegarde a démarré (format ISO-8601). corde
statut Décrit l’état de la migration entre les types de stratégie de sauvegarde. 'Terminé'
'Échec'
'InProgress'
'Invalid'
targetType Décrit le type de stratégie de sauvegarde cible de la migration de la stratégie de sauvegarde. 'Continu'
'Périodique'

Capacité

Nom Description Valeur
nom Nom de la fonctionnalité Cosmos DB. Par exemple, « name » : « EnableCassandra ». Les valeurs actuelles incluent également « EnableTable » et « EnableGremlin ». corde

Capacité

Nom Description Valeur
totalThroughputLimit Limite de débit totale imposée au compte. Un totalThroughputLimit de 2000 impose une limite stricte de débit maximal pouvant être provisionné sur ce compte pour être 2000. Un totalThroughputLimit de -1 indique aucune limite de provisionnement du débit. Int

Contraintes:
Valeur minimale = -1

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nom Description Valeur

ConsistencyPolicy

Nom Description Valeur
defaultConsistencyLevel Niveau de cohérence et paramètres de configuration par défaut du compte Cosmos DB. 'BoundedStaleness'
'ConsistentPrefix'
'Final'
'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 5 à 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. La plage acceptée pour cette valeur est de 1 à 2 147 483 647. Obligatoire lorsque defaultConsistencyPolicy est défini sur « BoundedStaleness ». Int

Contraintes:
Valeur minimale = 1
Valeur maximale = 2147483647

ContinuousModeBackupPolicy

Nom Description Valeur
continuousModeProperties Valeurs de configuration pour la sauvegarde en mode continu ContinuousModeProperties
type Décrit le mode de sauvegarde. 'Continu' (obligatoire)

ContinuousModeProperties

Nom Description Valeur
niveau Énumération pour indiquer le type de mode de sauvegarde continue 'Continuous30Days'
'Continuous7Days'

CorsPolicy

Nom Description Valeur
allowedHeaders En-têtes de requête que le domaine d’origine peut spécifier sur la requête CORS. corde
allowedMethods Méthodes (verbes de requête HTTP) que le domaine d’origine peut utiliser pour une requête CORS. corde
allowedOrigins Domaines d’origine autorisés à effectuer une demande 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 demande CORS et exposés par le navigateur à l’émetteur de la requête. corde
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

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Nom Description Valeur
analyticalStorageConfiguration Propriétés spécifiques du stockage analytique. analyticalStorageConfiguration
apiProperties Propriétés spécifiques de 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
Capacités Liste des fonctionnalités de Cosmos DB pour le compte fonctionnalité[]
capacité Objet qui représente toutes les propriétés liées à l’application de la capacité sur un compte. capacité
connectorOffer Type d’offre du 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[]
createMode Énumération pour indiquer le mode de création de compte. 'Default'
'Restore'
databaseAccountOfferType Type d’offre pour la base de données 'Standard' (obligatoire)
defaultIdentity Identité par défaut pour accéder au coffre de clés utilisé dans les fonctionnalités telles que les clés gérées par le client. L’identité par défaut doit être définie explicitement par les utilisateurs. Il peut s’agir de « FirstPartyIdentity », « SystemAssignedIdentity » et bien plus encore. corde
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
disableLocalAuth Désactivez l’authentification locale et assurez-vous que seul MSI et AAD peuvent être utilisés exclusivement pour l’authentification. Bool
enableAnalyticalStorage Indicateur pour indiquer s’il faut activer l’analytique de 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 dans plusieurs emplacements Bool
enablePartitionMerge Indicateur pour indiquer l’activation/désactivation de la fonctionnalité de fusion de partition sur le compte Bool
ipRules Liste d’IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Indicateur pour indiquer s’il faut activer/désactiver des règles de liste de contrôle d’accès de réseau virtuel. Bool
keyVaultKeyUri URI du coffre de clés corde
Lieux Tableau qui contient les emplacements de géoréplication activés pour le compte Cosmos DB. Emplacement[] (obligatoire)
minimalTlsVersion Indique la version minimale autorisée de Tls. La valeur par défaut est Tls 1.2. Les API Cassandra et Mongo fonctionnent uniquement avec Tls 1.2. 'Tls'
'Tls11'
'Tls12'
networkAclBypass Indique quels services sont autorisés à contourner les vérifications de pare-feu. 'AzureServices'
'None'
networkAclBypassResourceIds Tableau qui contient les ID de ressource pour le contournement Acl réseau pour le compte Cosmos DB. string[]
publicNetworkAccess Indique si les demandes du réseau public sont autorisées 'Désactivé'
'Activé'
'SecuredByPerimeter'
restoreParameters Paramètres pour indiquer les informations relatives à la restauration. RestoreParameters
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[]

DatabaseRestoreResource

Nom Description Valeur
collectionNames Noms des collections disponibles pour la restauration. string[]
databaseName Nom de la base de données disponible pour la restauration. corde

GremlinDatabaseRestoreResource

Nom Description Valeur
databaseName Nom de la base de données gremlin disponible pour la restauration. corde
graphNames Noms des graphiques disponibles pour la restauration. string[]

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 peuvent pas être appliquées par le filtre d’adresse IP. Exemple d’entrées valides : « 23.40.210.245 » ou « 23.40.210.0/8 ». corde

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. corde

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

Nom Description Valeur
identité Identité de la ressource. ManagedServiceIdentity
gentil 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'
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 3
Modèle = ^[a-z0-9]+(-[a-z0-9]+)* (obligatoire)
Propriétés Propriétés permettant de créer et de mettre à jour des comptes de base de données Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

PeriodicModeBackupPolicy

Nom Description Valeur
periodicModeProperties Valeurs de configuration pour la sauvegarde en mode périodique PeriodicModeProperties
type Décrit le mode de sauvegarde. 'Périodique' (obligatoire)

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) de conservation de chaque sauvegarde Int

Contraintes:
Valeur minimale = 0
backupStorageRedundancy Énumération pour indiquer le type de résidence de sauvegarde 'Geo'
'Local'
'Zone'

RestoreParameters

Nom Description Valeur
databasesToRestore Liste des bases de données spécifiques disponibles pour la restauration. DatabaseRestoreResource[]
gremlinDatabasesToRestore Liste des bases de données gremlin spécifiques disponibles pour la restauration. GremlinDatabaseRestoreResource[]
restoreMode Décrit le mode de restauration. 'PointInTime'
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
tablesToRestore Liste des tables spécifiques disponibles pour la restauration. string[]

Étiquettes

Nom Description Valeur

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}. corde
ignoreMissingVNetServiceEndpoint Créez une règle de pare-feu avant que le point de terminaison de service de réseau virtuel soit activé. Bool

Exemples de démarrage rapide

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

Fichier Bicep Description
API SQL du compte Azure Cosmos DB avec de 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 le magasin analytique.
compte Azure Cosmos DB avec d’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 du 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.
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 des injections SQL potentielles, des acteurs malveillants connus basés sur Microsoft Threat Intelligence, des modèles d’accès suspects et des exploitations potentielles de votre base de données via des identités compromises ou des insiders malveillants.
Créer 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 partagé et un conteneur.
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 ressources minimales requises.
créer un compte Azure Cosmos DB serverless pour l' de 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 tactile et un Azure Web App Ce modèle crée un compte Azure Cosmos, injecte le point de terminaison et les clés Cosmos DB dans les paramètres d’application web Azure, puis déploie une application web ASP MVC à partir de GitHub.
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é.
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 table unique 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 table unique avec un débit de mise à l’échelle automatique.
Créer un compte Azure Cosmos DB pour l' de 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 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.
créer un compte Azure Cosmos DB pour l' 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 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 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é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 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 SQL Azure Cosmos DB avec RBAC du 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 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 de mise à l’échelle automatique pour les de 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 des procédures stockées d’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ée une application de microservices Dapr à l’aide de Container Apps Créez une application de microservices Dapr à l’aide de Container Apps.
Crée une application Dapr pub-sub servicebus à l’aide de Container Apps Créez une application Dapr pub-sub servicebus à l’aide de Container Apps.
Déployer Azure Data Explorer DB avec de connexion Cosmos DB Déployez Azure Data Explorer DB avec la connexion Cosmos DB.

Définition de ressource de modèle ARM

Le type de ressource databaseAccounts 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.

Format de ressource

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "apiVersion": "2023-04-15",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "analyticalStorageConfiguration": {
      "schemaType": "string"
    },
    "apiProperties": {
      "serverVersion": "string"
    },
    "backupPolicy": {
      "migrationState": {
        "startTime": "string",
        "status": "string",
        "targetType": "string"
      },
      "type": "string"
      // For remaining properties, see BackupPolicy objects
    },
    "capabilities": [
      {
        "name": "string"
      }
    ],
    "capacity": {
      "totalThroughputLimit": "int"
    },
    "connectorOffer": "string",
    "consistencyPolicy": {
      "defaultConsistencyLevel": "string",
      "maxIntervalInSeconds": "int",
      "maxStalenessPrefix": "int"
    },
    "cors": [
      {
        "allowedHeaders": "string",
        "allowedMethods": "string",
        "allowedOrigins": "string",
        "exposedHeaders": "string",
        "maxAgeInSeconds": "int"
      }
    ],
    "createMode": "string",
    "databaseAccountOfferType": "Standard",
    "defaultIdentity": "string",
    "disableKeyBasedMetadataWriteAccess": "bool",
    "disableLocalAuth": "bool",
    "enableAnalyticalStorage": "bool",
    "enableAutomaticFailover": "bool",
    "enableCassandraConnector": "bool",
    "enableFreeTier": "bool",
    "enableMultipleWriteLocations": "bool",
    "enablePartitionMerge": "bool",
    "ipRules": [
      {
        "ipAddressOrRange": "string"
      }
    ],
    "isVirtualNetworkFilterEnabled": "bool",
    "keyVaultKeyUri": "string",
    "locations": [
      {
        "failoverPriority": "int",
        "isZoneRedundant": "bool",
        "locationName": "string"
      }
    ],
    "minimalTlsVersion": "string",
    "networkAclBypass": "string",
    "networkAclBypassResourceIds": [ "string" ],
    "publicNetworkAccess": "string",
    "restoreParameters": {
      "databasesToRestore": [
        {
          "collectionNames": [ "string" ],
          "databaseName": "string"
        }
      ],
      "gremlinDatabasesToRestore": [
        {
          "databaseName": "string",
          "graphNames": [ "string" ]
        }
      ],
      "restoreMode": "string",
      "restoreSource": "string",
      "restoreTimestampInUtc": "string",
      "tablesToRestore": [ "string" ]
    },
    "virtualNetworkRules": [
      {
        "id": "string",
        "ignoreMissingVNetServiceEndpoint": "bool"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Objets BackupPolicy

Définissez le type propriété pour spécifier le type d’objet.

Pour continu, utilisez :

{
  "continuousModeProperties": {
    "tier": "string"
  },
  "type": "Continuous"
}

Pour périodique, utilisez :

{
  "periodicModeProperties": {
    "backupIntervalInMinutes": "int",
    "backupRetentionIntervalInHours": "int",
    "backupStorageRedundancy": "string"
  },
  "type": "Periodic"
}

Valeurs de propriété

AnalyticalStorageConfiguration

Nom Description Valeur
schemaType Décrit les types de schémas pour le stockage analytique. 'FullFidelity'
'WellDefined'

ApiProperties

Nom Description Valeur
serverVersion Décrit serverVersion d’un compte MongoDB. '3.2'
'3.6'
'4.0'
'4.2'

BackupPolicy

Nom Description Valeur
migrationState Objet représentant l’état de la migration entre les stratégies de sauvegarde. BackupPolicyMigrationState
type Défini sur « Continuous » pour le type ContinuousModeBackupPolicy. Défini sur « Periodic » pour le type PeriodicModeBackupPolicy. 'Continu'
'Périodique' (obligatoire)

BackupPolicyMigrationState

Nom Description Valeur
startTime Heure à laquelle la migration de la stratégie de sauvegarde a démarré (format ISO-8601). corde
statut Décrit l’état de la migration entre les types de stratégie de sauvegarde. 'Terminé'
'Échec'
'InProgress'
'Invalid'
targetType Décrit le type de stratégie de sauvegarde cible de la migration de la stratégie de sauvegarde. 'Continu'
'Périodique'

Capacité

Nom Description Valeur
nom Nom de la fonctionnalité Cosmos DB. Par exemple, « name » : « EnableCassandra ». Les valeurs actuelles incluent également « EnableTable » et « EnableGremlin ». corde

Capacité

Nom Description Valeur
totalThroughputLimit Limite de débit totale imposée au compte. Un totalThroughputLimit de 2000 impose une limite stricte de débit maximal pouvant être provisionné sur ce compte pour être 2000. Un totalThroughputLimit de -1 indique aucune limite de provisionnement du débit. Int

Contraintes:
Valeur minimale = -1

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nom Description Valeur

ConsistencyPolicy

Nom Description Valeur
defaultConsistencyLevel Niveau de cohérence et paramètres de configuration par défaut du compte Cosmos DB. 'BoundedStaleness'
'ConsistentPrefix'
'Final'
'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 5 à 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. La plage acceptée pour cette valeur est de 1 à 2 147 483 647. Obligatoire lorsque defaultConsistencyPolicy est défini sur « BoundedStaleness ». Int

Contraintes:
Valeur minimale = 1
Valeur maximale = 2147483647

ContinuousModeBackupPolicy

Nom Description Valeur
continuousModeProperties Valeurs de configuration pour la sauvegarde en mode continu ContinuousModeProperties
type Décrit le mode de sauvegarde. 'Continu' (obligatoire)

ContinuousModeProperties

Nom Description Valeur
niveau Énumération pour indiquer le type de mode de sauvegarde continue 'Continuous30Days'
'Continuous7Days'

CorsPolicy

Nom Description Valeur
allowedHeaders En-têtes de requête que le domaine d’origine peut spécifier sur la requête CORS. corde
allowedMethods Méthodes (verbes de requête HTTP) que le domaine d’origine peut utiliser pour une requête CORS. corde
allowedOrigins Domaines d’origine autorisés à effectuer une demande 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 demande CORS et exposés par le navigateur à l’émetteur de la requête. corde
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

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Nom Description Valeur
analyticalStorageConfiguration Propriétés spécifiques du stockage analytique. analyticalStorageConfiguration
apiProperties Propriétés spécifiques de 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
Capacités Liste des fonctionnalités de Cosmos DB pour le compte fonctionnalité[]
capacité Objet qui représente toutes les propriétés liées à l’application de la capacité sur un compte. capacité
connectorOffer Type d’offre du 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[]
createMode Énumération pour indiquer le mode de création de compte. 'Default'
'Restore'
databaseAccountOfferType Type d’offre pour la base de données 'Standard' (obligatoire)
defaultIdentity Identité par défaut pour accéder au coffre de clés utilisé dans les fonctionnalités telles que les clés gérées par le client. L’identité par défaut doit être définie explicitement par les utilisateurs. Il peut s’agir de « FirstPartyIdentity », « SystemAssignedIdentity » et bien plus encore. corde
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
disableLocalAuth Désactivez l’authentification locale et assurez-vous que seul MSI et AAD peuvent être utilisés exclusivement pour l’authentification. Bool
enableAnalyticalStorage Indicateur pour indiquer s’il faut activer l’analytique de 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 dans plusieurs emplacements Bool
enablePartitionMerge Indicateur pour indiquer l’activation/désactivation de la fonctionnalité de fusion de partition sur le compte Bool
ipRules Liste d’IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Indicateur pour indiquer s’il faut activer/désactiver des règles de liste de contrôle d’accès de réseau virtuel. Bool
keyVaultKeyUri URI du coffre de clés corde
Lieux Tableau qui contient les emplacements de géoréplication activés pour le compte Cosmos DB. Emplacement[] (obligatoire)
minimalTlsVersion Indique la version minimale autorisée de Tls. La valeur par défaut est Tls 1.2. Les API Cassandra et Mongo fonctionnent uniquement avec Tls 1.2. 'Tls'
'Tls11'
'Tls12'
networkAclBypass Indique quels services sont autorisés à contourner les vérifications de pare-feu. 'AzureServices'
'None'
networkAclBypassResourceIds Tableau qui contient les ID de ressource pour le contournement Acl réseau pour le compte Cosmos DB. string[]
publicNetworkAccess Indique si les demandes du réseau public sont autorisées 'Désactivé'
'Activé'
'SecuredByPerimeter'
restoreParameters Paramètres pour indiquer les informations relatives à la restauration. RestoreParameters
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[]

DatabaseRestoreResource

Nom Description Valeur
collectionNames Noms des collections disponibles pour la restauration. string[]
databaseName Nom de la base de données disponible pour la restauration. corde

GremlinDatabaseRestoreResource

Nom Description Valeur
databaseName Nom de la base de données gremlin disponible pour la restauration. corde
graphNames Noms des graphiques disponibles pour la restauration. string[]

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 peuvent pas être appliquées par le filtre d’adresse IP. Exemple d’entrées valides : « 23.40.210.245 » ou « 23.40.210.0/8 ». corde

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. corde

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

Nom Description Valeur
apiVersion Version de l’API '2023-04-15'
identité Identité de la ressource. ManagedServiceIdentity
gentil 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'
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 3
Modèle = ^[a-z0-9]+(-[a-z0-9]+)* (obligatoire)
Propriétés Propriétés permettant de créer et de mettre à jour des comptes de base de données Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (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'

PeriodicModeBackupPolicy

Nom Description Valeur
periodicModeProperties Valeurs de configuration pour la sauvegarde en mode périodique PeriodicModeProperties
type Décrit le mode de sauvegarde. 'Périodique' (obligatoire)

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) de conservation de chaque sauvegarde Int

Contraintes:
Valeur minimale = 0
backupStorageRedundancy Énumération pour indiquer le type de résidence de sauvegarde 'Geo'
'Local'
'Zone'

RestoreParameters

Nom Description Valeur
databasesToRestore Liste des bases de données spécifiques disponibles pour la restauration. DatabaseRestoreResource[]
gremlinDatabasesToRestore Liste des bases de données gremlin spécifiques disponibles pour la restauration. GremlinDatabaseRestoreResource[]
restoreMode Décrit le mode de restauration. 'PointInTime'
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
tablesToRestore Liste des tables spécifiques disponibles pour la restauration. string[]

Étiquettes

Nom Description Valeur

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}. corde
ignoreMissingVNetServiceEndpoint Créez une règle de pare-feu avant que le point de terminaison de service de réseau virtuel soit activé. Bool

Modèles de démarrage rapide

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

Modèle Description
API SQL du compte Azure Cosmos DB avec de magasin analytique

Déployer sur Azure 		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 le magasin analytique.
compte Azure Cosmos DB avec d’application web

Déployer sur Azure 		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 du 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.
CI/CD à l’aide de Jenkins sur azure Container Service (AKS)

Déployer sur Azure 		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 réplicables et gérables de conteneurs. En configurant une build continue pour produire vos images conteneur et l’orchestration, vous pouvez augmenter la vitesse et la fiabilité de votre déploiement.
Créer un compte Cosmos DB avec microsoft Defender activé

Déployer sur Azure 		À 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 des injections SQL potentielles, des acteurs malveillants connus basés sur Microsoft Threat Intelligence, des modèles d’accès suspects et des exploitations potentielles de votre base de données via des identités compromises ou des insiders malveillants.
Créer un compte Azure Cosmos DB de niveau gratuit

Déployer sur Azure 		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 partagé et un conteneur.
Créer un compte Azure Cosmos DB minimal pour l’API Core (SQL)

Déployer sur Azure 		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 ressources minimales requises.
créer un compte Azure Cosmos DB serverless pour l' de l’API SQL

Déployer sur Azure 		Ce modèle crée un compte Azure Cosmos DB serverless pour l’API Core (SQL).
Créer un compte Azure Cosmos tactile et un Azure Web App

Déployer sur 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 d’application web Azure, puis déploie une application web ASP MVC à partir de GitHub.
Créer un compte Azure Cosmos pour l' de l’API MongoDB

Déployer sur Azure 		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

Déployer sur Azure 		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 pour l’API Table

Déployer sur Azure 		Ce modèle crée un compte Azure Cosmos DB pour l’API Table dans deux régions et une table unique avec un débit provisionné.
Créer un compte Azure Cosmos pour l’API Table avec mise à l’échelle automatique

Déployer sur Azure 		Ce modèle crée un compte Azure Cosmos DB pour l’API Table dans deux régions et une table unique avec un débit de mise à l’échelle automatique.
Créer un compte Azure Cosmos DB pour l' de l’API Cassandra

Déployer sur Azure 		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 Azure Cosmos DB pour l’API Core (SQL)

Déployer sur Azure 		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.
créer un compte Azure Cosmos DB pour l' de l’API Gremlin

Déployer sur Azure 		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

Déployer sur Azure 		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 DB dans plusieurs régions

Déployer sur Azure 		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éer une API SQL de compte Azure Cosmos DB avec mise à l’échelle automatique

Déployer sur Azure 		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 un compte Azure Cosmos DB avec un point de terminaison privé

Déployer sur Azure 		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 SQL Azure Cosmos DB avec RBAC du plan de données

Déployer sur Azure 		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 CosmosDB

Déployer sur Azure 		Ce modèle ARM est destiné à créer rapidement un compte CosmosDB avec les valeurs minimales requises
Créer un compte Azure Cosmos DB de mise à l’échelle automatique pour les de l’API Cassandra

Déployer sur Azure 		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 des procédures stockées d’API Azure Cosmos DB Core (SQL)

Déployer sur Azure 		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 Azure Cosmos avec l’API SQL et plusieurs conteneurs

Déployer sur Azure 		Le modèle crée un conteneur Cosmos avec une API SQL et permet d’ajouter des conteneurs mulitple.
crée une application de microservices Dapr à l’aide de Container Apps

Déployer sur Azure 		Créez une application de microservices Dapr à l’aide de Container Apps.
Crée une application Dapr pub-sub servicebus à l’aide de Container Apps

Déployer sur Azure 		Créez une application Dapr pub-sub servicebus à l’aide de Container Apps.
Déployer Azure Data Explorer DB avec de connexion Cosmos DB

Déployer sur Azure 		Déployez Azure Data Explorer DB avec la connexion Cosmos DB.
Application web avec une base de données SQL, Azure Cosmos DB, azure Search

Déployer sur Azure 		Ce modèle provisionne une application web, une base de données SQL, Azure Cosmos DB, Azure Search et Application Insights.

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 de l’API, consultez journal des modifications.

Format de ressource

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts@2023-04-15"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  kind = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      analyticalStorageConfiguration = {
        schemaType = "string"
      }
      apiProperties = {
        serverVersion = "string"
      }
      backupPolicy = {
        migrationState = {
          startTime = "string"
          status = "string"
          targetType = "string"
        }
        type = "string"
        // For remaining properties, see BackupPolicy objects
      }
      capabilities = [
        {
          name = "string"
        }
      ]
      capacity = {
        totalThroughputLimit = int
      }
      connectorOffer = "string"
      consistencyPolicy = {
        defaultConsistencyLevel = "string"
        maxIntervalInSeconds = int
        maxStalenessPrefix = int
      }
      cors = [
        {
          allowedHeaders = "string"
          allowedMethods = "string"
          allowedOrigins = "string"
          exposedHeaders = "string"
          maxAgeInSeconds = int
        }
      ]
      createMode = "string"
      databaseAccountOfferType = "Standard"
      defaultIdentity = "string"
      disableKeyBasedMetadataWriteAccess = bool
      disableLocalAuth = bool
      enableAnalyticalStorage = bool
      enableAutomaticFailover = bool
      enableCassandraConnector = bool
      enableFreeTier = bool
      enableMultipleWriteLocations = bool
      enablePartitionMerge = bool
      ipRules = [
        {
          ipAddressOrRange = "string"
        }
      ]
      isVirtualNetworkFilterEnabled = bool
      keyVaultKeyUri = "string"
      locations = [
        {
          failoverPriority = int
          isZoneRedundant = bool
          locationName = "string"
        }
      ]
      minimalTlsVersion = "string"
      networkAclBypass = "string"
      networkAclBypassResourceIds = [
        "string"
      ]
      publicNetworkAccess = "string"
      restoreParameters = {
        databasesToRestore = [
          {
            collectionNames = [
              "string"
            ]
            databaseName = "string"
          }
        ]
        gremlinDatabasesToRestore = [
          {
            databaseName = "string"
            graphNames = [
              "string"
            ]
          }
        ]
        restoreMode = "string"
        restoreSource = "string"
        restoreTimestampInUtc = "string"
        tablesToRestore = [
          "string"
        ]
      }
      virtualNetworkRules = [
        {
          id = "string"
          ignoreMissingVNetServiceEndpoint = bool
        }
      ]
    }
  })
}

Objets BackupPolicy

Définissez le type propriété pour spécifier le type d’objet.

Pour continu, utilisez :

{
  continuousModeProperties = {
    tier = "string"
  }
  type = "Continuous"
}

Pour périodique, utilisez :

{
  periodicModeProperties = {
    backupIntervalInMinutes = int
    backupRetentionIntervalInHours = int
    backupStorageRedundancy = "string"
  }
  type = "Periodic"
}

Valeurs de propriété

AnalyticalStorageConfiguration

Nom Description Valeur
schemaType Décrit les types de schémas pour le stockage analytique. 'FullFidelity'
'WellDefined'

ApiProperties

Nom Description Valeur
serverVersion Décrit serverVersion d’un compte MongoDB. '3.2'
'3.6'
'4.0'
'4.2'

BackupPolicy

Nom Description Valeur
migrationState Objet représentant l’état de la migration entre les stratégies de sauvegarde. BackupPolicyMigrationState
type Défini sur « Continuous » pour le type ContinuousModeBackupPolicy. Défini sur « Periodic » pour le type PeriodicModeBackupPolicy. 'Continu'
'Périodique' (obligatoire)

BackupPolicyMigrationState

Nom Description Valeur
startTime Heure à laquelle la migration de la stratégie de sauvegarde a démarré (format ISO-8601). corde
statut Décrit l’état de la migration entre les types de stratégie de sauvegarde. 'Terminé'
'Échec'
'InProgress'
'Invalid'
targetType Décrit le type de stratégie de sauvegarde cible de la migration de la stratégie de sauvegarde. 'Continu'
'Périodique'

Capacité

Nom Description Valeur
nom Nom de la fonctionnalité Cosmos DB. Par exemple, « name » : « EnableCassandra ». Les valeurs actuelles incluent également « EnableTable » et « EnableGremlin ». corde

Capacité

Nom Description Valeur
totalThroughputLimit Limite de débit totale imposée au compte. Un totalThroughputLimit de 2000 impose une limite stricte de débit maximal pouvant être provisionné sur ce compte pour être 2000. Un totalThroughputLimit de -1 indique aucune limite de provisionnement du débit. Int

Contraintes:
Valeur minimale = -1

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nom Description Valeur

ConsistencyPolicy

Nom Description Valeur
defaultConsistencyLevel Niveau de cohérence et paramètres de configuration par défaut du compte Cosmos DB. 'BoundedStaleness'
'ConsistentPrefix'
'Final'
'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 5 à 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. La plage acceptée pour cette valeur est de 1 à 2 147 483 647. Obligatoire lorsque defaultConsistencyPolicy est défini sur « BoundedStaleness ». Int

Contraintes:
Valeur minimale = 1
Valeur maximale = 2147483647

ContinuousModeBackupPolicy

Nom Description Valeur
continuousModeProperties Valeurs de configuration pour la sauvegarde en mode continu ContinuousModeProperties
type Décrit le mode de sauvegarde. 'Continu' (obligatoire)

ContinuousModeProperties

Nom Description Valeur
niveau Énumération pour indiquer le type de mode de sauvegarde continue 'Continuous30Days'
'Continuous7Days'

CorsPolicy

Nom Description Valeur
allowedHeaders En-têtes de requête que le domaine d’origine peut spécifier sur la requête CORS. corde
allowedMethods Méthodes (verbes de requête HTTP) que le domaine d’origine peut utiliser pour une requête CORS. corde
allowedOrigins Domaines d’origine autorisés à effectuer une demande 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 demande CORS et exposés par le navigateur à l’émetteur de la requête. corde
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

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Nom Description Valeur
analyticalStorageConfiguration Propriétés spécifiques du stockage analytique. analyticalStorageConfiguration
apiProperties Propriétés spécifiques de 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
Capacités Liste des fonctionnalités de Cosmos DB pour le compte fonctionnalité[]
capacité Objet qui représente toutes les propriétés liées à l’application de la capacité sur un compte. capacité
connectorOffer Type d’offre du 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[]
createMode Énumération pour indiquer le mode de création de compte. 'Default'
'Restore'
databaseAccountOfferType Type d’offre pour la base de données 'Standard' (obligatoire)
defaultIdentity Identité par défaut pour accéder au coffre de clés utilisé dans les fonctionnalités telles que les clés gérées par le client. L’identité par défaut doit être définie explicitement par les utilisateurs. Il peut s’agir de « FirstPartyIdentity », « SystemAssignedIdentity » et bien plus encore. corde
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
disableLocalAuth Désactivez l’authentification locale et assurez-vous que seul MSI et AAD peuvent être utilisés exclusivement pour l’authentification. Bool
enableAnalyticalStorage Indicateur pour indiquer s’il faut activer l’analytique de 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 dans plusieurs emplacements Bool
enablePartitionMerge Indicateur pour indiquer l’activation/désactivation de la fonctionnalité de fusion de partition sur le compte Bool
ipRules Liste d’IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Indicateur pour indiquer s’il faut activer/désactiver des règles de liste de contrôle d’accès de réseau virtuel. Bool
keyVaultKeyUri URI du coffre de clés corde
Lieux Tableau qui contient les emplacements de géoréplication activés pour le compte Cosmos DB. Emplacement[] (obligatoire)
minimalTlsVersion Indique la version minimale autorisée de Tls. La valeur par défaut est Tls 1.2. Les API Cassandra et Mongo fonctionnent uniquement avec Tls 1.2. 'Tls'
'Tls11'
'Tls12'
networkAclBypass Indique quels services sont autorisés à contourner les vérifications de pare-feu. 'AzureServices'
'None'
networkAclBypassResourceIds Tableau qui contient les ID de ressource pour le contournement Acl réseau pour le compte Cosmos DB. string[]
publicNetworkAccess Indique si les demandes du réseau public sont autorisées 'Désactivé'
'Activé'
'SecuredByPerimeter'
restoreParameters Paramètres pour indiquer les informations relatives à la restauration. RestoreParameters
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[]

DatabaseRestoreResource

Nom Description Valeur
collectionNames Noms des collections disponibles pour la restauration. string[]
databaseName Nom de la base de données disponible pour la restauration. corde

GremlinDatabaseRestoreResource

Nom Description Valeur
databaseName Nom de la base de données gremlin disponible pour la restauration. corde
graphNames Noms des graphiques disponibles pour la restauration. string[]

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 peuvent pas être appliquées par le filtre d’adresse IP. Exemple d’entrées valides : « 23.40.210.245 » ou « 23.40.210.0/8 ». corde

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. corde

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

Nom Description Valeur
identité Identité de la ressource. ManagedServiceIdentity
gentil 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'
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 3
Modèle = ^[a-z0-9]+(-[a-z0-9]+)* (obligatoire)
Propriétés Propriétés permettant de créer et de mettre à jour des comptes de base de données Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.DocumentDB/databaseAccounts@2023-04-15 »

PeriodicModeBackupPolicy

Nom Description Valeur
periodicModeProperties Valeurs de configuration pour la sauvegarde en mode périodique PeriodicModeProperties
type Décrit le mode de sauvegarde. 'Périodique' (obligatoire)

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) de conservation de chaque sauvegarde Int

Contraintes:
Valeur minimale = 0
backupStorageRedundancy Énumération pour indiquer le type de résidence de sauvegarde 'Geo'
'Local'
'Zone'

RestoreParameters

Nom Description Valeur
databasesToRestore Liste des bases de données spécifiques disponibles pour la restauration. DatabaseRestoreResource[]
gremlinDatabasesToRestore Liste des bases de données gremlin spécifiques disponibles pour la restauration. GremlinDatabaseRestoreResource[]
restoreMode Décrit le mode de restauration. 'PointInTime'
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
tablesToRestore Liste des tables spécifiques disponibles pour la restauration. string[]

Étiquettes

Nom Description Valeur

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}. corde
ignoreMissingVNetServiceEndpoint Créez une règle de pare-feu avant que le point de terminaison de service de réseau virtuel soit activé. Bool