Export-SPSiteSubscriptionSettings
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Creates a backup file of site subscription data.
Export-SPSiteSubscriptionSettings [-Identity] <SPSiteSubscriptionPipeBind> -Path <String> [-AdminProperties <SwitchParameter>] [-AssignmentCollection <SPAssignmentCollection>] [-Force <SwitchParameter>]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Required | Microsoft.SharePoint.PowerShell.SPSiteSubscriptionPipeBind | Specifies the ID of the site subscription from which to back up data. The type must be a valid URL, in the form http://server_name or a GUID in the form 1234-4567-985tg. | ||
| Path | Required | System.String | Specifies the location of the output file. The type must be a valid path; for example, C:/backupfile.back.. | ||
| AdminProperties | Optional | System.Management.Automation.SwitchParameter | Specifies that only administrator subscription properties are exported. If this parameter is not set, only non-administrator subscription properties are exported. | ||
| AssignmentCollection | Optional | Microsoft.SharePoint.PowerShell.SPAssignmentCollection | Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
| ||
| Force | No | System.Management.Automation.SwitchParameter | Forces the output backup file (if provided) to overwrite any existing file at the given path. |
Detailed Description
The Export-SPSiteSubscriptionSettings cmdlet generates a backup file of all settings in the subscription data store for the given site subscription.
Input Types
Return Types
--------------EXAMPLE-----------------
Get-SPSiteSubscription http://contoso.com | Backup-SPSiteSubscriptionSettings –path "c:/backups"
The example backs up the subscription settings store of http://www.contoso.com.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |

Note: