.png)
Import-SPSiteSubscriptionSettings
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Restores a backup of subscription site settings to the given subscription identifier.
Import-SPSiteSubscriptionSettings [-Identity] <SPSiteSubscriptionPipeBind> -Path <String> [-AdminProperties <SwitchParameter>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Required | Microsoft.SharePoint.PowerShell.SPSiteSubscriptionPipeBind | Specifies the ID of the subscription to restore . 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 input file. The type must be a valid path, in the form C:\filename.bak. | ||
| AdminProperties | Optional | System.Management.Automation.SwitchParameter | Specifies that only administrator subscription properties are imported. If this parameter is not set, only non-administrator subscription properties are imported. | ||
| 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.
| ||
| Confirm | Optional | System.Management.Automation.SwitchParameter | Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters | ||
| Force | No | System.Management.Automation.SwitchParameter | If a setting key already exists, determines whether the value must be overwritten with the value in the backup file. | ||
| WhatIf | Optional | System.Management.Automation.SwitchParameter | Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters |
Note: Detailed Description
The Import-SPSiteSubscriptionSettings cmdlet restores a backup of subscription site settings to the given subscription identifier when the Identity parameter is used. To overwrite existing settings, use the Force parameter.
Input Types
Return Types
--------------EXAMPLE-----------------
Get-SPSiteSubscription http://contoso.com | Import-SPSiteSubscriptionSettings –path "c:/backups/contoso_settings_file.bak" –force
This example restores the subscription settings store of contoso.com.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
