Modèle de ressource pour la fonctionnalité Azure Cosmos DB de restauration à un instant dans le passé

S’APPLIQUE À : NoSQL MongoDB Gremlin Table

Cet article explique le modèle de ressource pour la fonctionnalité Azure Cosmos DB de restauration à un instant dans le passé. Il explique les paramètres qui prennent en charge la sauvegarde continue et les ressources qui peuvent être restaurées. Cette fonctionnalité est prise en charge dans les API Azure Cosmos DB pour SQL, Azure Cosmos DB pour Gremlin, Table et Azure Cosmos DB pour MongoDB.

Modèle de ressource du compte de base de données

Le modèle de ressource du compte de base de données est mis à jour avec quelques propriétés supplémentaires pour prendre en charge les nouveaux scénarios de restauration. Ces propriétés sont BackupPolicy, CreateMode et RestoreParameters.

BackupPolicy

Une nouvelle propriété dans la stratégie de sauvegarde au niveau du compte nommée Type sous le paramètre backuppolicy active les fonctionnalités de sauvegarde continue et de restauration à un instant dans le passé. Ce mode est appelé sauvegarde continue. Vous pouvez définir ce mode lors de la création du compte ou lors de la migration d’un compte du mode périodique vers le mode continu. Une fois que le mode continu est activé, les fonctionnalités de sauvegarde continue et de restauration à un instant dans le passé seront activées par défaut sur tous les conteneurs et toutes les bases de données créés dans ce compte. Le niveau de sauvegarde continue peut être défini sur Continuous7Days ou Continuous30Days. Par défaut, si aucun niveau n’est fourni, Continuous30Days est appliqué au compte.

Notes

Actuellement, la fonctionnalité de restauration à un instant dans le passé est disponible pour les comptes Azure Cosmos DB pour NoSQL, API pour MongoDB, Table et Gremlin. Après avoir créé un compte en mode continu, vous ne pouvez pas le basculer en mode périodique. Le niveau Continuous7Days est en préversion.

CreateMode

Cette propriété indique la façon dont le compte a été créé. Les valeurs possibles sont Default et Restore. Pour effectuer une restauration, définissez cette valeur sur Restore et fournissez les valeurs appropriées dans la propriété RestoreParameters.

publicNetworkAccess

Cette propriété doit être définie sur « Désactivé » pour restaurer le compte sans accès au réseau public. Si cette propriété n’est pas fournie, la restauration du compte se poursuit avec publicNetworkAccess en tant que Enabled.

RestoreParameters

La ressource RestoreParameters contient les détails de l’opération de restauration, notamment l’ID de compte, l’heure de restauration et les ressources qui doivent être restaurées.

Nom de la propriété Description
restoreMode Le mode de restauration doit être PointInTime.
restoreSource L’instanceId du compte source à partir duquel la restauration sera initiée.
restoreTimestampInUtc Point dans le temps en UTC auquel restaurer le compte.
databasesToRestore Liste d’objets DatabaseRestoreResource pour spécifier les bases de données et les conteneurs qui doivent être restaurés. Chaque ressource représente une base de données unique et toutes les collections sous cette base de données. Pour plus d’informations, consultez ressources SQL pouvant être restaurées. Si cette valeur est vide, le compte entier est restauré.
gremlinDatabasesToRestore Liste d’objets GremlinDatabaseRestoreResource pour spécifier les bases de données et les graphes qui doivent être restaurés. Chaque ressource représente une base de données unique et tous les graphes sous cette base de données. Pour plus d’informations, consultez ressources Gremlin pouvant être restaurées. Si cette valeur est vide, le compte entier est restauré.
restoreWithTtlDisabled valeurs d’indicateur booléennes (true/false) pour désactiver Durée de vie dans le compte restauré une fois la restauration terminée. (préversion)
tablesToRestore Liste d’objets TableRestoreResource pour spécifier les tables qui doivent être restaurées. Chaque ressource représente une table dans cette base de données. Pour plus d’informations, consultez ressources Table pouvant être restaurées. Si cette valeur est vide, le compte entier est restauré.

Exemple de ressource

Le code JSON suivant est un exemple de ressource de compte de base de données où la sauvegarde continue est activée :

{
  "location": "westus",
  "properties": {
    "databaseAccountOfferType": "Standard",
    "locations": [
      {
        "failoverPriority": "0",
        "locationName": "southcentralus",
        "isZoneRedundant": "false"
      }
    ],
    "createMode": "Restore",
    "publicNetworkAccess":"Disabled",
    "restoreParameters": {
      "restoreMode": "PointInTime",
      "restoreWithTtlDisabled" : "true",
      "restoreSource": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
      "restoreTimestampInUtc": "2020-06-11T22:05:09Z",
      "databasesToRestore": [
        {
          "databaseName": "db1",
          "collectionNames": [
            "collection1",
            "collection2"
          ]
        },
        {
          "databaseName": "db2",
          "collectionNames": [
            "collection3",
            "collection4"
          ]
        }
      ]
    },
    "backupPolicy": {
      "type": "Continuous"
      ...
    }
  }
}

Ressources restaurables

Un ensemble de nouvelles ressources et d’API est disponible pour vous aider à découvrir des informations essentielles sur les ressources, notamment :

  • Où les ressources peuvent être restaurées
  • Emplacements depuis lesquels les ressources peuvent être restaurées
  • Timestamps lorsque des opérations de clé ont été effectuées sur ces ressources.

Notes

Toutes les API utilisées pour énumérer ces ressources nécessitent les autorisations suivantes :

  • Microsoft.DocumentDB/locations/restorableDatabaseAccounts/*/read
  • Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read

Compte de base de données restaurable

Cette ressource contient une instance de compte de base de données qui peut être restaurée. Le compte de base de données peut être soit un compte supprimé, soit un compte actif. Il contient des informations qui vous permettent de trouver le compte de base de données source que vous souhaitez restaurer.

Nom de la propriété Description
ID Identificateur unique de la ressource.
accountName Nom du compte de base de données global.
creationTime Heure UTC de la création ou migration du compte.
deletionTime Heure UTC de la suppression du compte. Cette valeur est vide si le compte est actif.
apiType Type d’API du compte Azure Cosmos DB.
restorableLocations Liste des emplacements où le compte existait.
restorableLocations: locationName Nom de la région du compte régional.
restorableLocations: regionalDatabaseAccountInstanceId GUID du compte régional.
restorableLocations: creationTime Heure UTC de la création ou migration du compte régional.
restorableLocations: deletionTime Heure UTC de la suppression du compte régional. Cette valeur est vide si le compte régional est actif.
OldestRestorableTimeStamp Heure UTC la plus ancienne dans laquelle la restauration peut être effectuée. Pour le niveau 30 jours, ce délai peut être de 30 jours maximum à partir de maintenant, pour le niveau Sept jours, ce délai peut être de sept jours maximum à partir de maintenant.

Pour obtenir la liste de tous les comptes pouvant être restaurés, consultez les articles Comptes de base de données restaurables – Liste ou Comptes de base de données restaurables – Liste par emplacement.

Base de données SQL restaurable

Chaque ressource contient des informations sur un événement de mutation, tel que la création et la suppression, qui s’est produit sur la base de données SQL. Ces informations peuvent être utiles dans les cas où la base de données a été supprimée par erreur et si vous avez besoin de savoir à quel moment cet événement s’est produit.

Nom de la propriété Description
eventTimestamp Heure UTC de création ou de suppression de la base de données.
ownerId Nom de la base de données SQL.
ownerResourceId ID de ressource de la base de données SQL,
operationType Type d’opération de cet événement de base de données.
database Propriétés de la base de données SQL au moment de l’événement,

Notes

Les valeurs possibles pour operationType comprennent :

  • Create : événement de création de base de données
  • Delete : événement de suppression de base de données
  • Replace : événement de modification de base de données
  • SystemOperation : événement de modification de la base de données déclenché par le système. Cet événement n’est pas initié par l’utilisateur

Pour obtenir la liste de toutes les mutations de base de données, consultez l’article Bases de données NoSQL restaurables – Liste.

Conteneur SQL restaurable

Chaque ressource contient des informations sur un événement de mutation, tel que la création et la suppression, qui s’est produit sur le conteneur SQL. Ces informations peuvent être utiles dans les cas où le conteneur a été modifié ou supprimé et si vous avez besoin de savoir à quel moment cet événement s’est produit.

Nom de la propriété Description
eventTimestamp Heure UTC à laquelle cet événement de conteneur s’est produit.
ownerId Nom du conteneur SQL.
ownerResourceId ID de ressource du conteneur SQL.
operationType Type d’opération de cet événement de conteneur.
container Propriétés du conteneur SQL au moment de l’événement.

Notes

Les valeurs possibles pour operationType comprennent :

  • Create : événement de création de conteneur
  • Delete : événement de suppression de conteneur
  • Replace : événement de modification de conteneur
  • SystemOperation : événement de modification du conteneur déclenché par le système. Cet événement n’est pas initié par l’utilisateur

Pour obtenir la liste de toutes les mutations de conteneur sous la même base de données, consultez l’article Conteneurs NoSQL récupérables– Liste.

Ressources SQL restaurables

Chaque ressource représente une base de données unique et tous les conteneurs sous cette base de données.

Nom de la propriété Description
databaseName Nom de la base de données SQL.
collectionNames Liste des conteneurs SQL sous cette base de données.

Pour obtenir la liste de toutes les combinaisons de bases de données et conteneur SQL qui existent sur le compte à l’heure et à l’emplacement donnés, consultez l’article Ressources NoSQL récupérables – Liste.

Base de données MongoDB restaurable

Chaque ressource contient des informations sur un événement de mutation, tel que la création et la suppression, qui s’est produit sur la base de données MongoDB. Ces informations peuvent être utiles dans le cas où la base de données a été supprimée par erreur et où l’utilisateur doit déterminer à quel moment cet événement s’est produit.

Nom de la propriété Description
eventTimestamp Heure UTC à laquelle cet événement de base de données s’est produit.
ownerId Nom de la base de données MongoDB.
ownerResourceId ID de ressource de la base de données MongoDB.
operationType Type d’opération de cet événement de base de données.

Notes

Les valeurs possibles pour operationType comprennent :

  • Create : événement de création de base de données
  • Delete : événement de suppression de base de données
  • Replace : événement de modification de base de données
  • SystemOperation : événement de modification de la base de données déclenché par le système. Cet événement n’est pas initié par l’utilisateur

Pour obtenir la liste de toutes les mutations de base de données, consultez l’article Bases de données MongoDB restaurables – Liste.

Collection MongoDB restaurable

Chaque ressource contient des informations sur un événement de mutation, tel que la création et la suppression, qui s’est produit sur la collection MongoDB. Ces informations peuvent être utiles dans les cas où la collection a été modifiée ou supprimée et où l’utilisateur doit déterminer à quel moment cet événement s’est produit.

Nom de la propriété Description
eventTimestamp Heure UTC à laquelle cet événement de collection s’est produit.
ownerId Nom de la collection MongoDB.
ownerResourceId ID de ressource de la collection MongoDB.
operationType Type d’opération de cet événement de collection.

Notes

Les valeurs possibles pour operationType comprennent :

  • Create : événement de création de collection
  • Delete : événement de suppression de collection
  • Replace : événement de modification de collection
  • SystemOperation : événement de modification de collection déclenché par le système. Cet événement n’est pas initié par l’utilisateur

Pour obtenir la liste de toutes les mutations de conteneur sous la même base de données, consultez l’article Ressources MongoDB récupérables– Liste.

Ressources MongoDB restaurables

Chaque ressource représente une base de données unique et toutes les collections sous cette base de données.

Nom de la propriété Description
databaseName Nom de la base de données MongoDB.
collectionNames Liste des collections MongoDB sous cette base de données.

Pour obtenir la liste de toutes les combinaisons de bases de données et collections MongoDB qui existent sur le compte à l’heure et à l’emplacement donnés, consultez Ressources MongoDB récupérables – Liste.

Ressources Graph restaurables

Chaque ressource représente une base de données unique et tous les graphes sous cette base de données.

Nom de la propriété Description
gremlinDatabaseName Nom de la base de données Graph.
graphNames Liste des graphes sous cette base de données.

Pour obtenir la liste de toutes les combinaisons de bases de données et graphes Gremlin qui existent sur le compte à l’heure et à l’emplacement donnés, consultez l’article Ressources Graph restaurables – Liste.

Base de données de graphe restaurable

Chaque ressource contient des informations sur un événement de mutation, tel que la création et la suppression, qui s’est produit sur la base de données de graphe. Ces informations peuvent être utiles dans le cas où la base de données a été supprimée par erreur et où l’utilisateur doit déterminer à quel moment cet événement s’est produit.

Nom de la propriété Description
eventTimestamp Heure UTC à laquelle cet événement de base de données s’est produit.
ownerId Nom de la base de données Graph.
ownerResourceId ID de ressource de la base de données de graphe.
operationType Type d’opération de cet événement de base de données.

Notes

Les valeurs possibles pour operationType comprennent :

  • Create : événement de création de base de données
  • Delete : événement de suppression de base de données
  • Replace : événement de modification de base de données
  • SystemOperation : événement de modification de la base de données déclenché par le système. Cet événement n’est pas initié par l’utilisateur.

Pour obtenir un flux d’événements de toutes les mutations sur la base de données Gremlin, consultez Bases de données de graphique pouvant être restaurées - Liste.

Graphes restaurables

Chaque ressource contient des informations sur un événement de mutation, tel que la création et la suppression, qui s’est produit sur le graphe. Ces informations peuvent être utiles dans les cas où le graphe a été modifié ou supprimé et si vous avez besoin de savoir à quel moment cet événement s’est produit.

Nom de la propriété Description
eventTimestamp Heure UTC à laquelle cet événement de collection s’est produit.
ownerId Nom de la collection de graphes.
ownerResourceId ID de ressource de la collection de graphes.
operationType Type d’opération de cet événement de collection.

Notes

Les valeurs possibles pour operationType comprennent :

  • Create : événement de création de graphe
  • Delete : événement de suppression de graphe
  • Replace : événement de modification de graphe
  • SystemOperation : événement de modification de collection déclenché par le système. Cet événement n’est pas initié par l’utilisateur.

Pour obtenir la liste de toutes les mutations de conteneur sous la même base de données, consultez l’article Graphes restaurables – Liste.

Ressources de table restaurables

Répertorie toutes les tables Azure Cosmos DB restaurables disponibles pour un compte de base de données spécifique à un moment et un emplacement donnés. Notez que l’API pour Table ne spécifie pas de base de données explicite.

Nom de la propriété Description
TableNames Liste des conteneurs Table sous ce compte.

Pour obtenir la liste des tables qui existent sur le compte à l’heure et à l’emplacement donnés, consultez l’article Ressources SQL restaurables – Liste.

Table restaurable

Chaque ressource contient des informations sur un événement de mutation, tel que la création et la suppression, qui s’est produit sur la table. Ces informations peuvent être utiles dans les cas où la table a été modifiée ou supprimée et si vous avez besoin de savoir à quel moment cet événement s’est produit.

Nom de la propriété Description
eventTimestamp Heure UTC à laquelle cet événement de base de données s’est produit.
ownerId Nom de la base de données Table.
ownerResourceId ID de ressource de la ressource Table.
operationType Type d’opération de cet événement Table.

Notes

Les valeurs possibles pour operationType comprennent :

  • Create : événement de création de table
  • Delete : événement de suppression de table
  • Replace : événement de modification de table
  • SystemOperation : événement de modification de la base de données déclenché par le système. Cet événement n’est pas initié par l’utilisateur

Pour obtenir la liste de toutes les mutations de table sous la même base de données, consultez l’article Tables restaurables – Liste.

Étapes suivantes