SPSearchManagedProperty - dsccommunity/SharePointDsc GitHub Wiki

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Name	Key	String	The name of the managed property
ServiceAppName	Key	String	The name of the search service app that this managed property exists within
PropertyType	Required	String	The type of managed property - choose between Binary, DateTime, Decimal, Double, Integer, Text, and YesNo	Binary, DateTime, Decimal, Double, Integer, Text, YesNo
Aliases	Write	StringArray[]	Aliases of the managed property
CrawledProperties	Write	StringArray[]	List of crawled properties that the property is mapped with
Ensure	Write	String	Present if the source should exist, absent if it should not	Present, Absent
HasMultipleValues	Write	Boolean	Should the property allow for multiple values to be selected
IncludeAllCrawledProperties	Write	Boolean	Should the property be mapped to all crawled properties
NoWordBreaker	Write	Boolean	Should the property only match exact content
Queryable	Write	Boolean	Should the property be Queryable
Refinable	Write	Boolean	Should the property be Refinable
Retrievable	Write	Boolean	Should the property be Retrievable
SafeForAnonymous	Write	Boolean	Should the property be marked as safe for anonymous access
Searchable	Write	Boolean	Should the property be Searchable
Sortable	Write	Boolean	Should the property be Sortable
TokenNormalization	Write	Boolean	Should the property be case sensitive

Description

Type: Distributed Requires CredSSP: No

This resource will deploy and configure a managed property in a specified search service application.

The default value for the Ensure parameter is Present. When not specifying this parameter, the managed property is created.

Examples

Example 1

This example shows how create a new Managed Property, using the required parameters

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPSearchManagedProperty MyProperty
        {
            Name                        = "MyProperty"
            ServiceAppName              = "Search Service Application"
            PropertyType                = "Text"
            Searchable                  = $true
            IncludeAllCrawledProperties = $false
            CrawledProperties           = @("OWS_Notes, Personal:AboutMe")
            PsDscRunAsCredential        = $SetupAccount
        }
    }
}