Set-HubSite

SharePoint Online: Sets hub site properties

Script

#Requires -Version 5.1
#Requires -Modules Microsoft.Online.SharePoint.PowerShell

[CmdletBinding()]
Param(
    [Parameter(Mandatory = $true)]
    [string]$Site,
    [string]$Title,
    [string]$Description,
    [string]$LogoUrl,
    [bool]$RequiresJoinApproval,
    [string]$SiteDesignId
)

Process {
    try {
        $cmdArgs = @{ ErrorAction = 'Stop'; Identity = $Site }
        if (-not [System.String]::IsNullOrWhiteSpace($Title)) { $cmdArgs.Add('Title', $Title) }
        if (-not [System.String]::IsNullOrWhiteSpace($Description)) { $cmdArgs.Add('Description', $Description) }
        if (-not [System.String]::IsNullOrWhiteSpace($LogoUrl)) { $cmdArgs.Add('LogoUrl', $LogoUrl) }
        if (-not [System.String]::IsNullOrWhiteSpace($SiteDesignId)) { $cmdArgs.Add('SiteDesignId', $SiteDesignId) }
        if ($PSBoundParameters.ContainsKey('RequiresJoinApproval')) { $cmdArgs.Add('RequiresJoinApproval', $RequiresJoinApproval) }
        Set-SPOHubSite @cmdArgs | Out-Null
        $result = Get-SPOHubSite -Identity $Site -ErrorAction Stop | Select-Object *
        if ($null -ne $result) { foreach ($item in $result) { $item | Add-Member -NotePropertyName Timestamp -NotePropertyValue (Get-Date -Format "yyyy-MM-dd HH:mm:ss") -PassThru -Force } }
    }
    catch { throw }
}

Customize

Site string

URL of the hub site

Title string

Display name of the hub

Description string

Description of the hub site

LogoUrl string

URL of a logo to use in the hub navigation

RequiresJoinApproval bool

Determines if joining the hub requires approval

SiteDesignId string

Site design ID to associate with the hub