SPSearchCrawlMapping

SPSearchCrawlMapping

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
ServiceAppName	Key	String	Search Service Application Name
Url	Key	String	Source URI for the crawl mapping
Target	Required	String	Target URI for the crawl mapping
Ensure	Write	String	Ensure the crawl mapping is Present or Absent	Present, Absent
InstallAccount	Write	PSCredential	POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5

Description

Type: Distributed Requires CredSSP: No

This resource is responsible for managing the search crawl mapping in the search service application. You can create new mappings, change existing mappings and remove existing mappings.

The default value for the Ensure parameter is Present. When you omit this parameter the crawl rule is created.

Examples

Example 1

This example shows how to apply a Search Crawl Mapping rule to a search application.

    Configuration Example
    {
        param
        (
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPSearchCrawlMapping IntranetCrawlMapping
            {
                ServiceAppName = "Search Service Application"
                Url = "http://crawl.sharepoint.com"
                Target = "http://site.sharepoint.com"
                Ensure = "Present"
                PsDScRunAsCredential = $SetupAccount
            }
        }
    }