SPOfficeOnlineServerSupressionSettings - dsccommunity/SharePointDsc GitHub Wiki

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Extension	Key	String	The file extension that needs to be supressed
Actions	Write	StringArray[]	The action that needs to be supressed	attend, attendservice, convert, edit, editnew, embedview, formedit, formsubmit, imagepreview, interactivepreview, legacywebservice, mobileView, preloadedit, preloadview, present, presentservice, rest, rtc, syndicate, view
Ensure	Write	String	Present ensures the supression for this extension exists, absent ensures it doesn't	Present, Absent

Description

Type: Distributed Requires CredSSP: No

This resource will configured the supression settings for Office Online Server (formerly known as Office Web Apps). With these setting you can specify for which extensions should Office Online Server not be used to open the file.

The default value for the Ensure parameter is Present. When not specifying this parameter, the supression settings are configured.

Examples

Example 1

This example shows how to configure OOS supression settings for the local SharePoint farm.

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

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPOfficeOnlineServerSupressionSettings 'PDF'
        {
            Extension            = "pdf"
            Actions              = "view", "edit"
            Ensure               = "Present"
            PsDscRunAsCredential = $SetupAccount
        }
    }
}

Example 2

This example shows how to remove OOS supression settings for the local SharePoint farm.

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

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPOfficeOnlineServerSupressionSettings 'PDF'
        {
            Extension            = "pdf"
            Ensure               = "Absent"
            PsDscRunAsCredential = $SetupAccount
        }
    }
}