SPDesignerSettings - dsccommunity/SharePointDsc GitHub Wiki

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
WebAppUrl	Key	String	The URL of the web application or site collection to configure
SettingsScope	Required	String	Define the scope of the configuration - either WebApplication or SiteCollection	WebApplication, SiteCollection
AllowCreateDeclarativeWorkflow	Write	Boolean	Allow users to create declarative workflows with SharePoint Designer
AllowCustomiseMasterPage	Write	Boolean	Allow masterpages to be changed by SharePoint Designer
AllowDetachPagesFromDefinition	Write	Boolean	Allow pages to be un-ghosted by SharePoint Designer
AllowManageSiteURLStructure	Write	Boolean	Allow site URL structure to be changed by SharePoint Designer
AllowSaveDeclarativeWorkflowAsTemplate	Write	Boolean	Allow users to save declarative workflows as a template from SharePoint Designer
AllowSavePublishDeclarativeWorkflow	Write	Boolean	Allow users to save and re-publish declarative workflows with SharePoint Designer
AllowSharePointDesigner	Write	Boolean	Allow the use of SharePoint Designer

Description

Type: Distributed Requires CredSSP: No

This resource is used to set the SharePoint Designer settings for the local farm or site collections. These settings will be used to control if users are allowed to make changes using SharePoint Designer. Note that this will not prevent users from installing SharePoint Designer, just from using SharePoint Designer to connect to the farm.

Settings can be applied against an entire web application, or a specific site collection. Use the "SettingsScope" property to set it to either "WebApplication" or "SiteCollection" to define which you are targetting.

Examples

Example 1

This example applies settings to disable SharePoint Designer access to the specified web application.

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

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPDesignerSettings MainWebAppSPDSettings
        {
            WebAppUrl                              = "https://intranet.sharepoint.contoso.com"
            SettingsScope                          = "WebApplication"
            AllowSharePointDesigner                = $false
            AllowDetachPagesFromDefinition         = $false
            AllowCustomiseMasterPage               = $false
            AllowManageSiteURLStructure            = $false
            AllowCreateDeclarativeWorkflow         = $false
            AllowSavePublishDeclarativeWorkflow    = $false
            AllowSaveDeclarativeWorkflowAsTemplate = $false
            PsDscRunAsCredential                   = $SetupAccount
        }
    }
}