Search Results for

    Show / Hide Table of Contents

    Set-PnPSearchConfiguration

    SYNOPSIS

    Sets the search configuration.

    SYNTAX

    Config

    Set-PnPSearchConfiguration -Configuration <String> [-Scope <SearchConfigurationScope>] 
     [-Connection <PnPConnection>] 
    

    Path

    Set-PnPSearchConfiguration -Path <String> [-Scope <SearchConfigurationScope>] 
     [-Connection <PnPConnection>] 
    

    DESCRIPTION

    This cmdlet sets the search configuration for a single web, site collection or a tenant, using a file or a configuration string.

    EXAMPLES

    EXAMPLE 1

    Set-PnPSearchConfiguration -Configuration $config
    

    Sets the search configuration for the current web.

    EXAMPLE 2

    Set-PnPSearchConfiguration -Configuration $config -Scope Site
    

    Sets the search configuration for the current site collection.

    EXAMPLE 3

    Set-PnPSearchConfiguration -Configuration $config -Scope Subscription
    

    Sets the search configuration for the current tenant.

    EXAMPLE 4

    Set-PnPSearchConfiguration -Path searchconfig.xml -Scope Subscription
    

    Reads the search configuration from the specified XML file and sets it for the current tenant.

    PARAMETERS

    -Configuration

    Search configuration string.

    Type: String
    Parameter Sets: Config
    
    Required: True
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -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
    Parameter Sets: (All)
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -Path

    Path to a search configuration.

    Type: String
    Parameter Sets: Path
    
    Required: True
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -Scope

    Scope to apply the setting to. The default is Web.

    Type: SearchConfigurationScope
    Parameter Sets: (All)
    Accepted values: Web, Site, Subscription
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    RELATED LINKS

    Microsoft 365 Patterns and Practices

    Back to top Generated by DocFX spacer