Register-SPOHubSite
Enables the hub site feature on a site to make it a hub site. For more information visit SharePoint hub sites overview.
Syntax
Default (Default)
Register-SPOHubSite
[-Site] <SpoSitePipeBind>
-Principals <String[]>
[<CommonParameters>]
Description
Use this cmdlet to register an existing site collection as a hub site.
Important
A maximum of 2000 hub sites may be created per tenant, with 'unlimited' number of site collections associated to a hub site.
Note
It can take up to 2-4 hours for the changes to appear.
Examples
Example 1
Register-SPOHubSite https://contoso.sharepoint.com/sites/Marketing -Principals $null
This example registers the marketing site on Contoso as hub site without setting any principals for it.
Parameters
-Principals
Applicable: SharePoint Online
Specifies one or more principals (user or group) to be granted rights to the specified HubSite. Can be used to filter who can associate sites to this hub site.
Parameter properties
| Type: | System.String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Site
Applicable: SharePoint Online
Specifies the URL of the site collection to which to enable the hub site features.
Parameter properties
| Type: | Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind
Outputs
System.Object
Notes
If the site doesn't exist, this cmdlet returns a "File not found" error.
If the site is already a hub site, this cmdlet returns a "This site is already a HubSite" error.
If the site is already associated with another hub site, this cmdlet returns a "This site is currently associated with a HubSite" error. You'll need to run the Remove-SPOHubSiteAssociation cmdlet first before you can make the site a hub site.