en-US/about_SPSearchManagedProperty.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
    SPSearchManagedProperty

# 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.
    
.PARAMETER Name
    Key - String
    The name of the managed property

.PARAMETER ServiceAppName
    Key - String
    The name of the search service app that this managed property exists within

.PARAMETER PropertyType
    Required - String
    Allowed values: Binary, DateTime, Decimal, Double, Integer, Text, YesNo
    The type of managed property - choose between Binary, DateTime, Decimal, Double, Integer, Text, and YesNo

.PARAMETER Searchable
    Write - Boolean
    Should the property be Searchable

.PARAMETER Queryable
    Write - Boolean
    Should the property be Queryable

.PARAMETER Retrievable
    Write - Boolean
    Should the property be Retrievable

.PARAMETER HasMultipleValues
    Write - Boolean
    Should the property allow for multiple values to be selected

.PARAMETER Refinable
    Write - Boolean
    Should the property be Refinable

.PARAMETER Sortable
    Write - Boolean
    Should the property be Sortable

.PARAMETER SafeForAnonymous
    Write - Boolean
    Should the property be marked as safe for anonymous access

.PARAMETER Aliases
    Write - String
    Aliases of the managed property

.PARAMETER TokenNormalization
    Write - Boolean
    Should the property be case sensitive

.PARAMETER NoWordBreaker
    Write - Boolean
    Should the property only match exact content

.PARAMETER IncludeAllCrawledProperties
    Write - Boolean
    Should the property be mapped to all crawled properties

.PARAMETER CrawledProperties
    Write - String
    List of crawled properties that the property is mapped with

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present if the source 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 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
            }
        }
    }