IBackupRestoreConfiguration interface

Provides a property that indicates whether the component that the implementing class represents can be included in backups (and restorations) of only configuration settings.

Namespace:  Microsoft.SharePoint.Administration.Backup
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)


<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel := True)> _
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
Public Interface IBackupRestoreConfiguration _
    Inherits IBackupRestore
Dim instance As IBackupRestoreConfiguration
[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel = true)]
[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
public interface IBackupRestoreConfiguration : IBackupRestore


Notes to implementers

Your custom component class should implement this interface, and implement its CanBackupRestoreAsConfiguration property to always return true, if the following conditions are met:

  • The class represents only configuration settings.

  • The settings are scoped to the entire farm or to the Content Publishing Web Service. For more information about the Content Publishing Web Service, see Background: Service Entities in Windows SharePoint Services.

  • The settings do not assume any particular server names or farm topology.

Conversely, your class should not implement this interface if it represents content, such as lists, Web sites, site collections, Web applications, supplemental databases, or collections of non-configuration files; nor should it implement this interface if it contains configuration settings that are relative to (or assume the existence of) such content components. In the latter case, the class should probably be implemented as an IBackupRestore child of a parent IBackupRestore object that represents the content.

As a rule of thumb, think of a configuration-only backup as a kind of farm template. For example, if SharePoint Foundation has been installed on a farm, farm administrators can restore the configuration-only components to create a deployment that is configured to match the source farm. The administrators can then optionally restore all, or selected parts, of the original content, or add new content, or both. Although components that implement IBackupRestoreConfiguration can be part of configuration-and-content restorations, it helps to keep the ‘farm template’ scenario in mind when deciding whether a component should implement IBackupRestoreConfiguration. If it would be appropriate for your component to be part of a farm template, even if none of content from the source farm was restored to a new target farm, then your class should implement IBackupRestoreConfiguration.

See also


IBackupRestoreConfiguration members

Microsoft.SharePoint.Administration.Backup namespace