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
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
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.
| Type: | string[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-Site
Specifies the URL of the site collection to which to enable the hub site features.
| Type: | SpoSitePipeBind |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
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.