en-US/about_SPSearchCrawlRule.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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
.NAME
    SPSearchCrawlRule

# Description
    
    **Type:** Distributed
    **Requires CredSSP:** No
    
    This resource is responsible for managing the search crawl rules in the search
    service application. You can create new rules, change existing rules and remove
    existing rules.
    
    The default value for the Ensure parameter is Present. When not specifying this
    parameter, the crawl rule is created.
    
.PARAMETER Path
    Key - string
    The name of the search service application

.PARAMETER ServiceAppName
    Required - string
    The name of the search service application

.PARAMETER AuthenticationType
    Write - string
    Allowed values: DefaultRuleAccess, BasicAccountRuleAccess, CertificateRuleAccess, NTLMAccountRuleAccess, FormRuleAccess, CookieRuleAccess, AnonymousAccess
    Authentication type used by the crawl rule

.PARAMETER RuleType
    Write - string
    Allowed values: InclusionRule, ExclusionRule
    The type of the rule

.PARAMETER CrawlConfigurationRules
    Write - string
    Allowed values: FollowLinksNoPageCrawl, CrawlComplexUrls, CrawlAsHTTP
    The configuration options for this rule

.PARAMETER AuthenticationCredentials
    Write - String
    The credentials used for this crawl rule (used for types BasicAccountRuleAccess and NTLMAccountRuleAccess)

.PARAMETER CertificateName
    Write - string
    The certificate used for this crawl rule (used for type CertificateRuleAccess)

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present if the crawl rule should exist, absent if it should not

.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 settings to a sepcific URL in search


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

        node localhost {
            SPSearchCrawlRule IntranetCrawlAccount
            {
                Path = "https://intranet.sharepoint.contoso.com"
                ServiceAppName = "Search Service Application"
                Ensure = "Present"
                RuleType = "InclusionRule"
                CrawlConfigurationRules = "FollowLinksNoPageCrawl","CrawlComplexUrls", "CrawlAsHTTP"
                AuthenticationType = "DefaultRuleAccess"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example shows how to set a certificate for authentication to a content source


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

        node localhost {
            SPSearchCrawlRule IntranetCrawlAccountCertificate
            {
                Path = "https://intranet.sharepoint.contoso.com"
                ServiceAppName = "Search Service Application"
                Ensure = "Present"
                RuleType = "InclusionRule"
                CrawlConfigurationRules = "FollowLinksNoPageCrawl","CrawlComplexUrls", "CrawlAsHTTP"
                AuthenticationType = "CertificateRuleAccess"
                CertificateName = "Certificate Name"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }