Set-PnPHubSite

Tip

We encourage you to make improvements to this documentation. Please navigate to https://github.com/pnp/powershell/blob/dev/documentation/Set-PnPHubSite.md to change this file.

Required Permissions

  • SharePoint: Access to the SharePoint Tenant Administration site

Sets hub site properties

Syntax

Set-PnPHubSite
   [-Identity] <HubSitePipeBind>
   [-Title <String>]
   [-LogoUrl <String>]
   [-Description <String>]
   [-SiteDesignId <Guid>]
   [-HideNameInNavigation]
   [-RequiresJoinApproval]
   [-Connection <PnPConnection>]
   [<CommonParameters>]

Description

Allows configuring a hub site

Examples

EXAMPLE 1

Set-PnPHubSite -Identity "https://tenant.sharepoint.com/sites/myhubsite" -Title "My New Title"

Sets the title of the hub site

EXAMPLE 2

Set-PnPHubSite -Identity "https://tenant.sharepoint.com/sites/myhubsite" -Description "My updated description"

Sets the description of the hub site

EXAMPLE 3

Set-PnPHubSite -Identity "https://tenant.sharepoint.com/sites/myhubsite" -SiteDesignId df8a3ef1-9603-44c4-abd9-541aea2fa745

Sets the site design which should be applied to sites joining the the hub site

EXAMPLE 4

Set-PnPHubSite -Identity "https://tenant.sharepoint.com/sites/myhubsite" -LogoUrl "https://tenant.sharepoint.com/SiteAssets/Logo.png"

Sets the logo of the hub site

Parameters

-Connection

Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type:PnPConnection
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Description

{{ Fill Description Description }}

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-HideNameInNavigation
Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Identity

{{ Fill Identity Description }}

Type:HubSitePipeBind
Aliases:HubSite
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-LogoUrl

{{ Fill LogoUrl Description }}

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RequiresJoinApproval
Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SiteDesignId

GUID of the SharePoint Site Design which should be applied when a site joins the hub site

Type:Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Title

{{ Fill Title Description }}

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False