Skip to content

SPSearchFileType

Brian Farnhill edited this page Dec 9, 2016 · 16 revisions

Parameters

Parameter Attribute DataType Description Allowed Values
FileType Key string The name of the file type
ServiceAppName Required string The name of the search service application
Description Write string The description of the file type
MimeType Write string The mime type of the file type
Enabled Write boolean The state of the file type
Ensure Write string Present if the service app should exist, absent if it should not Present, Absent
InstallAccount Write String POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5

Description

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.

Examples

Example 1

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 2

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
        }
    }
}
Clone this wiki locally