Export (0) Print
Expand All
Expand Minimize
0 out of 1 rated this helpful - Rate this topic

Set-SPAppSiteSubscriptionName

SharePoint 2013

Published: July 16, 2012

Applies to:  SharePoint Server 2013 Standard 

Sets or changes the name for the specified site subscription.

Set-SPAppSiteSubscriptionName -Name <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-SiteSubscription <SPSiteSubscriptionPipeBind>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Name

Required

System.String

Specifies the name for the site subscription.

Each site subscription must have a unique name. The name is used in part to determine the domain that apps for SharePoint are installed in for each site subscription.

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.

noteNote:

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

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

Optional

System.Management.Automation.SwitchParameter

The site subscription name is recorded in other databases in the SharePoint farm. In cases such as disaster recovery or restore of the SharePoint farm, the Force parameter can be specified to ensure that the site subscription name has been propagated appropriately throughout the SharePoint farm.

SiteSubscription

Optional

Microsoft.SharePoint.PowerShell.SPSiteSubscriptionPipeBind

Specifies the SPSiteSubscription object or the SPSiteSubscription Id or the URL of an SPSite. If this parameter is not specified, then the default site subscription is used. All SharePoint SPSites are members of the default site subscription if they have not been specifically assigned a site subscription.

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

Detailed Description

Use the Set-SPAppSiteSubscriptionName cmdlet to set or change the name for a specified site subscription by using the Name parameter.

Input Types

Return Types

-----------EXAMPLE 1----------

Set-SPAppSiteSubscriptionName -Name Contoso

This example sets the name of the default site subscription to “Contoso”.

-----------EXAMPLE 2----------

Set-SPAppSiteSubscriptionName -Name Contoso -SiteSubscription https://www.contoso.com

This example changes the name of the site subscription for SPSite from https://www.contoso.com to “Contoso”.

Change History

Date Description

July 16, 2012

Initial publication

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.