en-US/about_SPSearchAuthoritativePage.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
.NAME
    SPSearchAuthoritativePage

# Description
    
    **Type:** Distributed
    
    This resource is responsible for managing the search authoritative pages in the
    search service application. You can create new pages, change existing pages and
    remove existing pages.
    
    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 Path
    Key - String
    Source URI for the authoritative page

.PARAMETER Level
    Write - Real32
    Level of Authoratitive Page, values between 0.0 and 2.0

.PARAMETER Action
    Write - String
    Allowed values: Authoratative, Demoted
    The resource will either make the page authoritative or demoted based on this value

.PARAMETER Ensure
    Write - String
    Allowed values: Present, Absent
    Ensure the Authoritative 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 create a Search Authoritative Page


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

        node localhost {
            SPSearchAuthoritativePage AuthoratativePage
            {
                ServiceAppName       = "Search Service Application"
                Path                 = "http://site.sharepoint.com/Pages/authoritative.aspx"
                Action               = "Authoratative"
                Level                = 0.0
                Ensure               = "Present"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example shows how to create a Search Demoted Page


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

        node localhost {
            SPSearchAuthoritativePage AuthoratativePage
            {
                ServiceAppName       = "Search Service Application"
                Path                 = "http://site.sharepoint.com/Pages/demoted.aspx"
                Action               = "Demoted"
                Ensure               = "Present"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }