Skip to content

spo hubsite connect

Connects the specified site collection to the given hub site

Attention

This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.

Usage

spo hubsite connect [options]

Options

Option Description
--help output usage information
-u, --url <url> The URL of the site collection to connect to the hub site
-i, --hubSiteId <hubSiteId> The ID of the hub site to which to connect the site collection
-o, --output [output] Output type. json|text. Default text
--verbose Runs command with verbose logging
--debug Runs command with debug logging

Important

Before using this command, log in to a SharePoint Online site, using the spo login command.

Remarks

To connect a site collection to a hub site, you have to first log in to a SharePoint site using the spo login command, eg. spo login https://contoso.sharepoint.com.

If the specified site collection is already connected to a hub site, it will be disconnected and connected to the newly specified hub site.

If the specified hubSiteId doesn't point to a valid hub site, you will get a ResourceNotFoundException error.

Examples

Connect the site collection with URL https://contoso.sharepoint.com/sites/contoso-sales to the hub site with ID 255a50b2-527f-4413-8485-57f4c17a24d1

spo hubsite connect --url https://contoso.sharepoint.com/sites/contoso-sales --hubSiteId 255a50b2-527f-4413-8485-57f4c17a24d1

More information