Skip to content

Latest commit

 

History

History
136 lines (100 loc) · 3.25 KB

Get-PnPSearchConfiguration.md

File metadata and controls

136 lines (100 loc) · 3.25 KB
Raw
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

Get-PnPSearchConfiguration

SYNOPSIS

Returns the search configuration

SYNTAX

Xml

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

OutputFormat

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

EXAMPLES

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

PS:> Get-PnPSearchConfiguration

Returns the search configuration for the current web

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

PS:> Get-PnPSearchConfiguration -Scope Site

Returns the search configuration for the current site collection

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

PS:> Get-PnPSearchConfiguration -Scope Subscription

Returns the search configuration for the current tenant

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

PS:> Get-PnPSearchConfiguration -Path searchconfig.xml -Scope Subscription

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

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

PS:> Get-PnPSearchConfiguration -Scope Site -OutputFormat ManagedPropertyMappings

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

PARAMETERS

-OutputFormat

Output format for of the configuration. Defaults to complete XML

Type: OutputFormat
Parameter Sets: OutputFormat

Required: False
Position: Named
Accept pipeline input: False

-Path

Local path where the search configuration will be saved

Type: String
Parameter Sets: Xml

Required: False
Position: Named
Accept pipeline input: False

-Scope

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

Type: SearchConfigurationScope
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Connection

Optional connection to be used by cmdlet. Retrieve the value for this parameter by eiter specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type: SPOnlineConnection
Parameter Sets: (All)

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

Required: False
Position: Named
Accept pipeline input: False

OUTPUTS

System.String

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

RELATED LINKS

SharePoint Developer Patterns and Practices