DSCResources/MSFT_SPSearchMetadataCategory/MSFT_SPSearchMetadataCategory.psm1

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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
function Get-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Collections.Hashtable])]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String]
        $Name,

        [Parameter(Mandatory = $true)]
        [System.String]
        $ServiceAppName,

        [Parameter()]
        [System.Boolean]
        $AutoCreateNewManagedProperties,

        [Parameter()]
        [System.Boolean]
        $DiscoverNewProperties,

        [Parameter()]
        [System.Boolean]
        $MapToContents,

        [Parameter()]
        [ValidateSet("Present","Absent")]
        [System.String]
        $Ensure = "Present",

        [Parameter()]
        [System.Management.Automation.PSCredential]
        $InstallAccount
    )

    Write-Verbose -Message "Getting Metadata Category Setting for '$Name'"

    $result = Invoke-SPDSCCommand -Credential $InstallAccount `
                                  -Arguments @($PSBoundParameters) `
                                  -ScriptBlock {
        $params = $args[0]

        $ssa = Get-SPEnterpriseSearchServiceApplication -Identity $params.ServiceAppName
        if ($null -eq $ssa)
        {
            throw("The specified Search Service Application $($params.ServiceAppName) is `
                   invalid. Please make sure you specify the name of an existing service application."
)
        }
        $category = Get-SPEnterpriseSearchMetadataCategory -SearchApplication $ssa | `
                                    Where-Object{$_.Name -eq $params.Name}
        if ($null -eq $category)
        {
            return @{
                Name = $params.Name
                ServiceAppName = $params.ServiceAppName
                AutoCreateNewManagedProperties = $null
                DiscoverNewProperties = $null
                MapToContents = $null
                Ensure = "Absent"
            }
        }
        else
        {
            $results = @{
                Name = $params.Name
                ServiceAppName = $params.ServiceAppName
                AutoCreateNewManagedProperties = $category.AutoCreateNewManagedProperties
                DiscoverNewProperties = $category.DiscoverNewProperties
                MapToContents = $category.MapToContents
                Ensure = "Present"
            }
            return $results
        }
    }
    return $result
}

function Set-TargetResource
{
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String]
        $Name,

        [Parameter(Mandatory = $true)]
        [System.String]
        $ServiceAppName,

        [Parameter()]
        [System.Boolean]
        $AutoCreateNewManagedProperties,

        [Parameter()]
        [System.Boolean]
        $DiscoverNewProperties,

        [Parameter()]
        [System.Boolean]
        $MapToContents,

        [Parameter()]
        [ValidateSet("Present","Absent")]
        [System.String]
        $Ensure = "Present",

        [Parameter()]
        [System.Management.Automation.PSCredential]
        $InstallAccount
    )

    Write-Verbose -Message "Setting Metadata Category Setting for '$Name'"

    # Validate that the specified crawled properties are all valid and existing
    Invoke-SPDSCCommand -Credential $InstallAccount `
                        -Arguments @($PSBoundParameters) `
                        -ScriptBlock {
        $params = $args[0]

        $ssa = Get-SPEnterpriseSearchServiceApplication -Identity $params.ServiceAppName
        if ($null -eq $ssa)
        {
            throw("The specified Search Service Application $($params.ServiceAppName) is `
                   invalid. Please make sure you specify the name of an existing service application."
)
        }

        # Set the specified properties on the Managed Property
        $category = Get-SPEnterpriseSearchMetadataCategory -Identity $params.Name `
                                                           -SearchApplication $params.ServiceAppName

        # The category exists and it shouldn't, delete it;
        if ($params.Ensure -eq "Absent" -and $null -ne $category)
        {
            # If the category we are trying to remove is not empty, throw an error
            if ($category.CrawledPropertyCount -gt 0)
            {
                throw "Cannot delete Metadata Category $($param.Name) because it contains " + `
                      "Crawled Properties. Please remove all associated Crawled Properties " + `
                      "before attempting to delete this category."
            }
            Remove-SPEnterpriseSearchMetadataCategory -Identity $params.Name `
                                                      -SearchApplication $params.ServiceAppName `
                                                      -Confirm:$false
        }

        # The category doesn't exist, but should
        if ($params.Ensure -eq "Present" -and $null -eq $category)
        {
            $category = New-SPEnterpriseSearchMetadataCategory -Name $params.Name `
                                                               -SearchApplication $params.ServiceAppName
        }
        Set-SPEnterpriseSearchMetadataCategory -Identity $params.Name `
                                               -SearchApplication $params.ServiceAppName `
                                               -AutoCreateNewManagedProperties $params.AutoCreateNewManagedProperties `
                                               -DiscoverNewProperties $params.DiscoverNewProperties `
                                               -MapToContents $params.MapToContents
    }
}

function Test-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String]
        $Name,

        [Parameter(Mandatory = $true)]
        [System.String]
        $ServiceAppName,

        [Parameter()]
        [System.Boolean]
        $AutoCreateNewManagedProperties,

        [Parameter()]
        [System.Boolean]
        $DiscoverNewProperties,

        [Parameter()]
        [System.Boolean]
        $MapToContents,

        [Parameter()]
        [ValidateSet("Present","Absent")]
        [System.String]
        $Ensure = "Present",

        [Parameter()]
        [System.Management.Automation.PSCredential]
        $InstallAccount
    )

    Write-Verbose -Message "Testing Metadata Category Setting for '$Name'"

    $PSBoundParameters.Ensure = $Ensure
    $CurrentValues = Get-TargetResource @PSBoundParameters

    return Test-SPDscParameterState -CurrentValues $CurrentValues `
                                    -DesiredValues $PSBoundParameters `
                                    -ValuesToCheck @("Name",
                                                     "PropertyType",
                                                     "Ensure",
                                                     "AutoCreateNewManagedProperties",
                                                     "DiscoverNewProperties",
                                                     "MapToContents")
}

Export-ModuleMember -Function *-TargetResource