Share via


SPBackupRestoreConsole Members

Include Protected Members
Include Inherited Members

Provides static methods for running and managing backup and restore operations.

The SPBackupRestoreConsole type exposes the following members.

Properties

  Name Description
Public propertyStatic member CurrentItem The place number, in the sequence of cfomponents that are part of the current operation, of the component currently being backed up or restored.
Public propertyStatic member CurrentlyRunning Gets an object that represents the currently running backup or restore operation.
Public propertyStatic member CurrentPhase Gets a value that indicates the current phase of the backup or restore operation.
Public propertyStatic member CurrentTotalItems The number of components being backed up or restored in the current operation.

Top

Methods

  Name Description
Public methodStatic member Abort Cancels the backup or restore operation with the specified ID.
Public methodStatic member CreateBackupRestore(SPBackupRestoreSettings) Creates a backup or restore operation and assigns it an ID.
Public methodStatic member CreateBackupRestore(SPBackupRestoreSettings, Boolean) Creates a backup or restore operation and assigns it an ID.
Public methodStatic member DatabaseExists Gets a value that indicates whether the specified database exists on the specified server and can be read by the specified user.
Public methodStatic member DiskSize Gets (as out parameters) the total disk space on a volume and the amount of that space that is available to the user.
Public methodStatic member DiskSizeRequired(Guid) Gets the amount of disk space needed to backup the entire tree of components in the specified backup operation.
Public methodStatic member DiskSizeRequired(Guid, SPBackupRestoreObject) Gets the amount of disk space needed to backup the specified node (and its children) in the tree of components in the specified backup operation.
Public methodStatic member DiskSizeRequired(Guid, Boolean) Gets the amount of disk space needed to backup the entire tree of components in the specified backup operation.
Public methodStatic member DiskSizeRequired(Guid, SPBackupRestoreObject, Boolean) Gets the amount of disk space needed to backup the specified node (and its children) in the tree of components in the specified backup operation.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public methodStatic member FindItems Gets the specified SharePoint Foundation components from the specified backup or restore operation.
Public methodStatic member FormatTree Gets a tree view of the hierarchy of SharePoint Foundation components in the backup or restore operation down to the level of the content databases.
Public methodStatic member Get Gets the operation (represented by a SPBackupRestoreConsoleObject) with the specified ID.
Public method GetHashCode (Inherited from Object.)
Public methodStatic member GetHistory(String) Gets a list of all backup and restore operations made to (or from) the specified location.
Public methodStatic member GetHistory(String, Boolean) Gets a list of all backup operations made to the specified location or all restore operations made from the location.
Public methodStatic member GetRestoreRenameList Creates, from the specified component and its children, a collection of restorable components that can be renamed when restored.
Public methodStatic member GetRoot Gets the root component of the tree of components that are being backed up or restored in the operation that is identified by the specified Guid.
Public method GetType (Inherited from Object.)
Public methodStatic member GetUserNamePasswordList Gets a collection of all the components in the backup or restore operation that require a username and password.
Protected method MemberwiseClone (Inherited from Object.)
Public methodStatic member Remove Removes an item from the internal collection of backup and restore operations.
Public methodStatic member ReOrderRenameListByAppPool Returns an object that groups the specified components to be backed up or restored by the ID of their application pool.
Public methodStatic member RequiresRename Gets a value that indicates whether a restore operation's method is creating a new copy of the backed up components (in which case the components must be renamed) or is overwriting an existing version.
Public methodStatic member Run Launches a backup or restore operation for the specified component.
Public methodStatic member SetActive Sets the specified operation as the current operation.
Public methodStatic member SetOnlyBackupRestoreItem Specifies that only the specified component and its children will be the backed up or restored.
Public method ToString (Inherited from Object.)
Public methodStatic member UsingNetworkServices Gets a value that indicates whether the backup or restore operation uses the Network Service account.

Top

See Also

Reference

SPBackupRestoreConsole Class

Microsoft.SharePoint.Administration.Backup Namespace