Add-SPSiteSubscriptionProfileConfig
Adds a new site subscription to a User Profile Service application.
Syntax
Add-SPSiteSubscriptionProfileConfig
[-Identity] <SPSiteSubscriptionPipeBind>
[-MySiteHostLocation <SPSitePipeBind>]
-ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-SynchronizationOU <String>]
[-WhatIf]
[<CommonParameters>] Add-SPSiteSubscriptionProfileConfig
[-Identity] <SPSiteSubscriptionPipeBind>
-MySiteHostLocation <SPSitePipeBind>
-ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-MySiteManagedPath <SPPrefixPipeBind>]
[-SiteNamingConflictResolution <String>]
[-SynchronizationOU <String>]
[-WhatIf]
[<CommonParameters>] Description
This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet parameter sets.
The Add-SPSiteSubscriptionProfileConfig cmdlet adds a new site subscription to a User Profile Service application.
For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.
Examples
--------------EXAMPLE------------------
$sub = Get-SPSiteSubscription https://contoso/my
$proxy = Get-SPServiceApplicationProxy | ? {$_.TypeName -eq 'User Profile Service Application Proxy'}
Add-SPSiteSubscriptionProfileConfig -Identity $sub -ProfileServiceApplicationProxy $proxy -MySiteHostLocation https://contoso/my
$sub = New-SPSiteSubscriptionThis example creates a new User Profile Service application tenant.
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 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-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 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Identity
Specifies the proxy of the User Profile Service application to add the site subscription to.
The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a User Profile Service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object.
| Type: | SPSiteSubscriptionPipeBind |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-MySiteHostLocation
Specifies the site collection where the My Site host for the site subscription is provisioned.
The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid URL, in the form https://server_name; or an instance of a valid SPSite object.
| Type: | SPSitePipeBind |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-MySiteManagedPath
Specifies the managed path where personal sites will be created.
The type must be a valid URL, in the form https://server_name.
| Type: | SPPrefixPipeBind |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-ProfileServiceApplicationProxy
Specifies the identifier for the User Profile Service Application proxy where the tenant is to be created.
| Type: | SPServiceApplicationProxyPipeBind |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-SiteNamingConflictResolution
Specifies the format to use to name personal sites.
Use one of the following integer values:
1 Personal site collections are to be named based on user names without any conflict resolution. For example, https://portal_site/location/username/
2 Personal site collections are to be based on user names with conflict resolution by using domain names. For example, .../username/ or .../domain_username/
3 Personal site collections are to be named by using domain and user name always, to avoid any conflicts. For example, https://portal_site/location/domain_username/
The default value is 1 (do not resolve conflicts).
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-SynchronizationOU
Specifies the organizational unit serving the site subscription.
The type must be a valid name of an organizational unit; for example, OrgUnit1.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-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 2013, SharePoint Server 2016, SharePoint Server 2019 |