en-US/about_SPSearchFileType.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
.NAME
    SPSearchFileType

# Description
    
    **Type:** Distributed
    
    This resource is responsible for managing the search file types in the search
    service application. You can create new file types, change existing types and
    remove existing file types.
    
    The default value for the Ensure parameter is Present. When not specifying this
    parameter, the file type is added.
    
.PARAMETER FileType
    Key - string
    The name of the file type

.PARAMETER ServiceAppName
    Key - string
    The name of the search service application

.PARAMETER Description
    Write - string
    The description of the file type

.PARAMETER MimeType
    Write - string
    The mime type of the file type

.PARAMETER Enabled
    Write - boolean
    The state of the file type

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present if the file type 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 to apply settings to a specific file type in search, using the required parameters


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

        node localhost {
            SPSearchFileType PDF
            {
                FileType = "pdf"
                ServiceAppName = "Search Service Application"
                Description = "PDF"
                MimeType = "application/pdf"
                Ensure = "Present"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example shows how to disable a specific file type in search


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

        node localhost {
            SPSearchFileType PDF
            {
                FileType = "pdf"
                ServiceAppName = "Search Service Application"
                Description = "PDF"
                MimeType = "application/pdf"
                Enabled = $false
                Ensure = "Present"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }