Edit

Set-SPAppSiteSubscriptionName

  • Reference
Module:
sharepoint-server
Applies to:
SharePoint Server Subscription Edition

Sets or changes the name for the specified site subscription.

Syntax

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

Description

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

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

-----------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".

Parameters

-AssignmentCollection

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.

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.

Type:SPAssignmentCollection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Confirm

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Force

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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Name

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.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-SiteSubscription

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.

Type:SPSiteSubscriptionPipeBind
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition