Get-PnPSearchConfiguration

Returns the search configuration

Syntax

Get-PnPSearchConfiguration
   [-Path <String>]
                             [-Scope <SearchConfigurationScope>]
                             [-Web <WebPipeBind>]
                             [-Connection <SPOnlineConnection>]
Get-PnPSearchConfiguration
   [-OutputFormat <OutputFormat>]
                             [-Scope <SearchConfigurationScope>]
                             [-Web <WebPipeBind>]
                             [-Connection <SPOnlineConnection>]

Examples

------------------EXAMPLE 1------------------

Get-PnPSearchConfiguration

Returns the search configuration for the current web

------------------EXAMPLE 2------------------

Get-PnPSearchConfiguration -Scope Site

Returns the search configuration for the current site collection

------------------EXAMPLE 3------------------

Get-PnPSearchConfiguration -Scope Subscription

Returns the search configuration for the current tenant

------------------EXAMPLE 4------------------

Get-PnPSearchConfiguration -Path searchconfig.xml -Scope Subscription

Returns the search configuration for the current tenant and saves it to the specified file

------------------EXAMPLE 5------------------

Get-PnPSearchConfiguration -Scope Site -OutputFormat ManagedPropertyMappings

Returns all custom managed properties and crawled property mapping at the current site collection

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:SPOnlineConnection
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-OutputFormat

Output format for of the configuration. Defaults to complete XML

Type:OutputFormat
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Path

Local path where the search configuration will be saved

Type:String
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Scope

Scope to use. Either Web, Site, or Subscription. Defaults to Web

Type:SearchConfigurationScope
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Web

This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.

Type:WebPipeBind
Position:Named
Accept pipeline input:False
Accept wildcard characters:False

Outputs

System.String

Does not return a string when the -Path parameter has been specified.