en-US/about_SPSearchCrawlMapping.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
.NAME
    SPSearchCrawlMapping

# 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.
    
.PARAMETER ServiceAppName
    Key - String
    Search Service Application Name

.PARAMETER Url
    Key - String
    Source URI for the crawl mapping

.PARAMETER Target
    Required - String
    Target URI for the crawl mapping

.PARAMETER Ensure
    Write - String
    Allowed values: Present, Absent
    Ensure the crawl mapping is Present or Absent

.PARAMETER InstallAccount
    Write - String
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5


.EXAMPLE
    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
            }
           
        }
    }