SPSearchAuthoritativePage - dsccommunity/SharePointDsc GitHub Wiki

Parameters

Parameter Attribute DataType Description Allowed Values
Path Key String Source URI for the authoritative page
ServiceAppName Key String Search Service Application Name
Action Write String The resource will either make the page authoritative or demoted based on this value Authoratative, Demoted
Ensure Write String Ensure the Authoritative is Present or Absent Present, Absent
Level Write Real32 Level of Authoratitive Page, values between 0.0 and 2.0

Description

Type: Distributed Requires CredSSP: No

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.

Examples

Example 1

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 2

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