Get Site Search Settings | SharePoint Search Configuration Script

Get Site Search Settings

This PnP PowerShell script retrieves comprehensive SharePoint site search settings and configuration details. Essential for auditing search configuration, understanding current settings, and planning search optimization strategies.

Purpose

Site search settings provide critical information for:

Auditing current search configuration and settings
Understanding search scope and result sources
Documenting search settings for compliance
Planning search optimization and enhancement strategies
Troubleshooting search-related issues
Comparing settings across different sites

Prerequisites

PnP PowerShell module installed
Search administrator permissions
Connection to your SharePoint Online site
Site collection administrator rights

PowerShell Script

# Get Search Settings Script for a Tenant
            # Retrieves search configuration settings for a specific site
            
            # Variables
            $siteUrl = "https://tenantName.sharepoint.com/sites/siteName"
            $clientId = ""
            $outputPath = ""
            
            Write-Host "Connecting to $siteUrl..." -ForegroundColor Cyan
            Connect-PnPOnline -Url $siteUrl -ClientId $clientId -Interactive
            
            Write-Host "Retrieving search settings..." -ForegroundColor Cyan
            
            # Get search settings
            $searchSettings = Get-PnPSearchSettings
            
            if ($searchSettings) {
                Write-Host "`nSearch Settings Retrieved:" -ForegroundColor Green
                
                # Display in console
                $searchSettings | Format-List
                
                # Export to CSV
                $csvFile = Join-Path $outputPath "search_settings_$(Get-Date -Format 'yyyyMMdd_HHmmss').csv"
                $searchSettings | Export-Csv -Path $csvFile -NoTypeInformation
                
                Write-Host "`nSearch settings exported to: $csvFile" -ForegroundColor Green
                
                # Also export as JSON for better readability
                $jsonFile = Join-Path $outputPath "search_settings_$(Get-Date -Format 'yyyyMMdd_HHmmss').json"
                $searchSettings | ConvertTo-Json -Depth 10 | Out-File -FilePath $jsonFile -Encoding UTF8
                
                Write-Host "Search settings exported to JSON: $jsonFile" -ForegroundColor Green
                
            } else {
                Write-Host "No search settings found" -ForegroundColor Yellow
            }
            
            Disconnect-PnPOnline
            
            Write-Host "`nDone!" -ForegroundColor Cyan

Usage Notes

Update the site URL to match your SharePoint environment
Ensure you have appropriate search administration permissions
Export settings to a file for documentation purposes
Use results to compare configurations across sites
Review settings regularly as part of search governance
Consider privacy and compliance requirements when accessing settings