Set-SPOHubSite
Sets the hub site information such as name, logo, and description.
Syntax
Default (Default)
Set-SPOHubSite
[-Identity] <SpoHubSitePipeBind>
[-Title <String>]
[-LogoUrl <String>]
[-Description <String>]
[-SiteDesignId <Guid>]
[-RequiresJoinApproval <Boolean>]
[-HideNameInNavigation <Boolean>]
[-EnablePermissionsSync <Boolean>]
[<CommonParameters>]
Description
Use this cmdlet to set properties such as name, logo, and description. These properties appear for the hub in the SharePoint user interface.
If the hub site doesn't exist, this cmdlet returns a "File not found" error.
Examples
Example 1
Set-SPOHubSite https://contoso.sharepoint.com/sites/Marketing `
-Title "Marketing Hub" `
-LogoUrl https://contoso.sharepoint.com/sites/Marketing/SiteAssets/hublogo.png `
-Description "Hub for the Marketing division"
This example updates the name of the hub displayed in the SharePoint user interface. It also updates the logo used in the hub navigation, and specifies an optional description for the hub.
Parameters
-Description
Applicable: SharePoint Online
A description of the hub site.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnablePermissionsSync
{{ Fill EnablePermissionsSync Description }}
Parameter properties
| Type: | System.Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-HideNameInNavigation
{{ Fill HideNameInNavigation Description }}
Parameter properties
| Type: | System.Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: SharePoint Online
URL of the hub site.
Parameter properties
| Type: | Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | HubSite |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-LogoUrl
Applicable: SharePoint Online
The URL of a logo to use in the hub navigation.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RequiresJoinApproval
Applicable: SharePoint Online
Determines if joining a Hub site requires approval.
Parameter properties
| Type: | System.Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SiteDesignId
Applicable: SharePoint Online
Site Design ID, for example db752673-18fd-44db-865a-aa3e0b28698e
Parameter properties
| Type: | System.Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Title
Applicable: SharePoint Online
The display name of the hub.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| 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.