Skip to content

Set-SPOHubSite.md

Latest commit

 

History

History
150 lines (111 loc) · 3.19 KB

Set-SPOHubSite.md

File metadata and controls

150 lines (111 loc) · 3.19 KB
external help file sharepointonline.xml
Module Name Microsoft.Online.SharePoint.PowerShell
online version https://learn.microsoft.com/powershell/module/sharepoint-online/set-spohubsite
applicable SharePoint Online
title Set-SPOHubSite
schema 2.0.0
author trent-green
ms.author trgreen
ms.reviewer

Set-SPOHubSite

SYNOPSIS

Sets the hub site information such as name, logo, and description.

SYNTAX

Set-SPOHubSite [-Identity] <SpoHubSitePipeBind> [-Title <string>] [-LogoUrl <string>] [-Description <string>] [-SiteDesignId <guid>] [-RequiresJoinApproval <bool>] [<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

-Identity

URL of the hub site.

Type: SpoSitePipeBind
Parameter Sets: (All)
Aliases: HubSite
Applicable: SharePoint Online

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Title

The display name of the hub.

Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online

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

-LogoUrl

The URL of a logo to use in the hub navigation.

Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online

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

-Description

A description of the hub site.

Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online

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

-SiteDesignId

Site Design ID, for example db752673-18fd-44db-865a-aa3e0b28698e

Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online

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

-RequiresJoinApproval

Determines if joining a Hub site requires approval.

Type: Boolean
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.