SPBackupRestoreConsoleObject Class
Represents a particular backup or restore operation.
Inheritance Hierarchy
System.Object
Microsoft.SharePoint.Administration.Backup.SPBackupRestoreConsoleObject
Namespace: Microsoft.SharePoint.Administration.Backup
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaration
<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel := True)> _
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
Public NotInheritable Class SPBackupRestoreConsoleObject
'Usage
Dim instance As SPBackupRestoreConsoleObject
[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel = true)]
[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
public sealed class SPBackupRestoreConsoleObject
Remarks
This class provides a lightweight representation of backup and restore operations and also enables multiple operations to be queued.
This class has no public constructor. Objects of this class are created with the SPBackupRestoreConsole.CreateBackupRestore method. The latter method returns the Id property of the SPBackupRestoreConsoleObject operation which is a Guid that can be passed to the critical methods of a SPBackupRestoreConsole object. This is a faster way of identifying a particular SPBackupRestoreConsoleObject than searching all of them for a particular one.
If you do need to get a reference to a SPBackupRestoreConsoleObject object itself, use SPBackupRestoreConsole.Get.
An SPBackupRestoreConsoleObject object persists as either an spbackup.xml or an sprestore.xml file that is saved in a subfolder of the backup location identified in the Location property. If you are creating your own backup and restore management UI, consider using these files to obtain data for the UI or to initialize values in subsequent backup or restore operations. Microsoft does not support editing or removing these files.
Note
There is also a spbrtoc.xml file in the root of Location that provides a history of all operations to and from that location.
Examples
The following is an edited example of an spbackup.xml file for purposes of readability.
Warning
The actual spbackup.xml files on your system should never be edited.
<?xml version="1.0" encoding="utf-8"?>
<SPBackup>
<SPGlobalInformation>
<SPId>b3aded39-25c8-48ba-b68e-ac4624536dba</SPId>
<SPRequestedBy>REDMOND\sally</SPRequestedBy>
<SPCurrentPhase>Done</SPCurrentPhase>
<SPNetworkServices>false</SPNetworkServices>
<SPBackupMethod>Full</SPBackupMethod>
<SPDirectoryNumber>0</SPDirectoryNumber>
<SPDirectoryName>spbr0000</SPDirectoryName>
<SPTopComponent>Farm\Windows SharePoint Services Web Application\SharePoint - 42712\WSS_Content_3cfae446821e442a8300185e58423876</SPTopComponent>
<SPTopComponentId>88c72a5d-08c9-4ee9-9f6a-3cfc3ab7d359</SPTopComponentId>
<SPCurrentItem>1</SPCurrentItem>
<SPTotalItems>1</SPTotalItems>
<SPStartTime>10/05/2007 21:04:32</SPStartTime>
<SPFinishTime>10/05/2007 21:04:40</SPFinishTime>
<SPUpdateProgress>5</SPUpdateProgress>
<SPWarningCount>0</SPWarningCount>
<SPErrorCount>0</SPErrorCount>
</SPGlobalInformation>
<SPBackupNode>
<SPBackupObject Name="Farm">
<SPBackupRestoreClass>Microsoft.SharePoint.Administration.SPFarm, Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c</SPBackupRestoreClass>
<SPBackupSelectable>True</SPBackupSelectable>
<SPRestoreSelectable>True</SPRestoreSelectable>
<SPName>SharePoint_Config_e34e9e22-f022-4cfe-9533-e99069d3578f</SPName>
<SPId>ec959e02-a86e-47c4-a201-62fc60487427</SPId>
<SPCanBackup>False</SPCanBackup>
<SPCanRestore>False</SPCanRestore>
<SPCurrentProgress>0</SPCurrentProgress>
<SPLastUpdate>10/05/2007 21:04:31</SPLastUpdate>
<SPCurrentPhase>NotSelected</SPCurrentPhase>
<SPParameters>
<SPParameter Key="SPDescription"><![CDATA[Content and configuration data for the entire server farm.]]></SPParameter>
<SPParameter Key="SPName"><![CDATA[SharePoint_Config_e34e9e22-f022-4cfe-9533-e99069d3578f]]></SPParameter>
<SPParameter Key="ec959e02-a86e-47c4-a201-62fc60487427STATE.xml"><![CDATA[00000000.bak]]></SPParameter>
</SPParameters>
</SPBackupObject>
<SPBackupNode>
<SPBackupObject Name="SharePoint_Config_e34e9e22-f022-4cfe-9533-e99069d3578f">
<SPBackupRestoreClass>Microsoft.SharePoint.Administration.SPConfigurationDatabase, Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c</SPBackupRestoreClass>
<SPBackupSelectable>False</SPBackupSelectable>
<SPRestoreSelectable>False</SPRestoreSelectable>
<SPName>SharePoint_Config_e34e9e22-f022-4cfe-9533-e99069d3578f</SPName>
<SPId>32174369-92ac-4b85-b104-9d53408dbaa4</SPId>
<SPCanBackup>False</SPCanBackup>
<SPCanRestore>False</SPCanRestore>
<SPCurrentProgress>0</SPCurrentProgress>
<SPLastUpdate>10/05/2007 21:04:31</SPLastUpdate>
<SPCurrentPhase>NotSelected</SPCurrentPhase>
<SPParameters>
<SPParameter Key="SPDescription"><![CDATA[Configuration data for the entire server farm.]]></SPParameter>
<SPParameter Key="InstanceId"><![CDATA[7b91473b-a528-4afe-8392-737a466478bf]]></SPParameter>
<SPParameter Key="ServerId"><![CDATA[5ebeacf8-d420-4150-959b-2d0d617bc100]]></SPParameter>
<SPParameter Key="FarmId"><![CDATA[ec959e02-a86e-47c4-a201-62fc60487427]]></SPParameter>
<SPParameter Key="32174369-92ac-4b85-b104-9d53408dbaa4STATE.xml"><![CDATA[00000001.bak]]></SPParameter>
</SPParameters>
</SPBackupObject>
</SPBackupNode>
<SPBackupNode>
<SPBackupObject Name="Windows SharePoint Services Web Application">
<SPBackupRestoreClass>Microsoft.SharePoint.Administration.SPWebService, Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c</SPBackupRestoreClass>
<SPBackupSelectable>True</SPBackupSelectable>
<SPRestoreSelectable>True</SPRestoreSelectable>
<SPName />
<SPId>21d91b29-5c5b-4893-9264-4e9c758618b4</SPId>
<SPCanBackup>False</SPCanBackup>
<SPCanRestore>False</SPCanRestore>
<SPCurrentProgress>0</SPCurrentProgress>
<SPLastUpdate>10/05/2007 21:04:31</SPLastUpdate>
<SPCurrentPhase>NotSelected</SPCurrentPhase>
<SPParameters>
<SPParameter Key="SPDescription"><![CDATA[Collection of Web Applications]]></SPParameter>
<SPParameter Key="21d91b29-5c5b-4893-9264-4e9c758618b4STATE.xml"><![CDATA[00000002.bak]]></SPParameter>
</SPParameters>
</SPBackupObject>
<SPBackupNode>
<SPBackupObject Name="SharePoint - 80">
<SPBackupRestoreClass>Microsoft.SharePoint.Administration.SPWebApplication, Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c</SPBackupRestoreClass>
<SPBackupSelectable>True</SPBackupSelectable>
<SPRestoreSelectable>True</SPRestoreSelectable>
<SPName>SharePoint - 80</SPName>
<SPId>10ea4e6f-ae37-4909-b04f-f516c066bc37</SPId>
<SPCanBackup>False</SPCanBackup>
<SPCanRestore>False</SPCanRestore>
<SPCurrentProgress>0</SPCurrentProgress>
<SPLastUpdate>10/05/2007 21:04:31</SPLastUpdate>
<SPCurrentPhase>NotSelected</SPCurrentPhase>
<SPParameters>
<SPParameter Key="SPDescription"><![CDATA[Content and configuration data for this Web application.]]></SPParameter>
<SPParameter Key="SPName"><![CDATA[SharePoint - 80]]></SPParameter>
<SPParameter Key="SPServer"><![CDATA[http://server01/]]></SPParameter>
<SPParameter Key="10ea4e6f-ae37-4909-b04f-f516c066bc37STATE.xml"><![CDATA[00000005.bak]]></SPParameter>
<SPParameter Key="IdentityType"><![CDATA[NetworkService]]></SPParameter>
<SPParameter Key="DisableKerberos"><![CDATA[False]]></SPParameter>
<SPParameter Key="AllowAnonymous"><![CDATA[False]]></SPParameter>
</SPParameters>
</SPBackupObject>
<SPBackupNode>
<SPBackupObject Name="WSS_Content">
<SPBackupRestoreClass>Microsoft.SharePoint.Administration.SPContentDatabase, Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c</SPBackupRestoreClass>
<SPBackupSelectable>True</SPBackupSelectable>
<SPRestoreSelectable>True</SPRestoreSelectable>
<SPName>WSS_Content</SPName>
<SPId>f85cb9e9-a813-4449-8a62-ffba47f31838</SPId>
<SPCanBackup>False</SPCanBackup>
<SPCanRestore>False</SPCanRestore>
<SPCurrentProgress>0</SPCurrentProgress>
<SPLastUpdate>10/05/2007 21:04:31</SPLastUpdate>
<SPCurrentPhase>NotSelected</SPCurrentPhase>
<SPParameters>
<SPParameter Key="SPDescription"><![CDATA[Content for the Web Application.]]></SPParameter>
<SPParameter Key="f85cb9e9-a813-4449-8a62-ffba47f31838STATE.xml"><![CDATA[00000006.bak]]></SPParameter>
<SPParameter Key="ServerId"><![CDATA[5ebeacf8-d420-4150-959b-2d0d617bc100]]></SPParameter>
<SPParameter Key="WarningSiteCount"><![CDATA[9000]]></SPParameter>
<SPParameter Key="InstanceId"><![CDATA[7b91473b-a528-4afe-8392-737a466478bf]]></SPParameter>
<SPParameter Key="MaximumSiteCount"><![CDATA[15000]]></SPParameter>
<SPParameter Key="Url"><![CDATA[http://server01/]]></SPParameter>
</SPParameters>
</SPBackupObject>
</SPBackupNode>
</SPBackupNode>
</SPBackupNode>
<SPBackupNode>
<SPBackupObject Name="WSS_Administration">
<SPBackupRestoreClass>Microsoft.SharePoint.Administration.SPWebService, Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c</SPBackupRestoreClass>
<SPBackupSelectable>False</SPBackupSelectable>
<SPRestoreSelectable>False</SPRestoreSelectable>
<SPName>WSS_Administration</SPName>
<SPId>9ef0382a-1014-435e-9d17-74be76a3342a</SPId>
<SPCanBackup>False</SPCanBackup>
<SPCanRestore>False</SPCanRestore>
<SPCurrentProgress>0</SPCurrentProgress>
<SPLastUpdate>10/05/2007 21:04:31</SPLastUpdate>
<SPCurrentPhase>NotSelected</SPCurrentPhase>
<SPParameters>
<SPParameter Key="SPDescription"><![CDATA[Collection of Web Applications]]></SPParameter>
<SPParameter Key="9ef0382a-1014-435e-9d17-74be76a3342aSTATE.xml"><![CDATA[00000007.bak]]></SPParameter>
</SPParameters>
</SPBackupObject>
<SPBackupNode>
<SPBackupObject Name="Web Application">
<SPBackupRestoreClass>Microsoft.SharePoint.Administration.SPAdministrationWebApplication, Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c</SPBackupRestoreClass>
<SPBackupSelectable>False</SPBackupSelectable>
<SPRestoreSelectable>False</SPRestoreSelectable>
<SPName />
<SPId>2f72ccb6-9baa-47bd-ae63-ea8b4bc5f233</SPId>
<SPCanBackup>False</SPCanBackup>
<SPCanRestore>False</SPCanRestore>
<SPCurrentProgress>0</SPCurrentProgress>
<SPLastUpdate>10/05/2007 21:04:31</SPLastUpdate>
<SPCurrentPhase>NotSelected</SPCurrentPhase>
<SPParameters>
<SPParameter Key="SPDescription"><![CDATA[Content and configuration data for this Web application.]]></SPParameter>
<SPParameter Key="2f72ccb6-9baa-47bd-ae63-ea8b4bc5f233STATE.xml"><![CDATA[00000008.bak]]></SPParameter>
<SPParameter Key="SPName"><![CDATA[]]></SPParameter>
<SPParameter Key="SPServer"><![CDATA[http://server01:7697/]]></SPParameter>
<SPParameter Key="DisableKerberos"><![CDATA[False]]></SPParameter>
<SPParameter Key="AllowAnonymous"><![CDATA[False]]></SPParameter>
</SPParameters>
</SPBackupObject>
<SPBackupNode>
<SPBackupObject Name="SharePoint_AdminContent_d86ba3d1-cce5-4391-8135-fae450dd8332">
<SPBackupRestoreClass>Microsoft.SharePoint.Administration.SPContentDatabase, Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c</SPBackupRestoreClass>
<SPBackupSelectable>True</SPBackupSelectable>
<SPRestoreSelectable>False</SPRestoreSelectable>
<SPName>SharePoint_AdminContent_d86ba3d1-cce5-4391-8135-fae450dd8332</SPName>
<SPId>a80e3734-75b3-4c7c-b04f-d6003ac3045f</SPId>
<SPCanBackup>False</SPCanBackup>
<SPCanRestore>False</SPCanRestore>
<SPCurrentProgress>0</SPCurrentProgress>
<SPLastUpdate>10/05/2007 21:04:31</SPLastUpdate>
<SPCurrentPhase>NotSelected</SPCurrentPhase>
<SPParameters>
<SPParameter Key="MaximumSiteCount"><![CDATA[15000]]></SPParameter>
<SPParameter Key="a80e3734-75b3-4c7c-b04f-d6003ac3045fSTATE.xml"><![CDATA[00000009.bak]]></SPParameter>
<SPParameter Key="IsAdministrationContentDatabase"><![CDATA[true]]></SPParameter>
<SPParameter Key="SPDescription"><![CDATA[Content for the Web Application.]]></SPParameter>
<SPParameter Key="ServerId"><![CDATA[5ebeacf8-d420-4150-959b-2d0d617bc100]]></SPParameter>
<SPParameter Key="InstanceId"><![CDATA[7b91473b-a528-4afe-8392-737a466478bf]]></SPParameter>
<SPParameter Key="WarningSiteCount"><![CDATA[9000]]></SPParameter>
<SPParameter Key="Url"><![CDATA[http://server01:7697/]]></SPParameter>
</SPParameters>
</SPBackupObject>
</SPBackupNode>
</SPBackupNode>
</SPBackupNode>
<SPBackupNode>
<SPBackupObject Name="Windows SharePoint Services Search">
<!-- details of this Web service object, a child of "Farm", omitted -->
</SPBackupObject>
<SPBackupNode>
<SPBackupObject Name="Search instance">
<!-- details of this child of Web service "Windows SharePoint Services Search" omitted -->
</SPBackupObject>
<SPBackupNode>
<SPBackupObject Name="WSS_Search_SERVER01">
<!-- details of this child of "Search instance" omitted -->
</SPBackupObject>
</SPBackupNode>
</SPBackupNode>
</SPBackupNode>
</SPBackupNode>
</SPBackup>
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.