Skip to content

SPWebAppThrottlingSettings

dscbot edited this page Mar 17, 2023 · 18 revisions

SPWebAppThrottlingSettings

Parameters

Parameter Attribute DataType Description Allowed Values
WebAppUrl Key String The URL of the web application
ListViewThreshold Write UInt32 What should the list view threshold for this site be set to
AllowObjectModelOverride Write Boolean Should object model code be able to be override the list view threshold
AdminThreshold Write UInt32 What is the list view threshold for site administrators
ListViewLookupThreshold Write UInt32 What is the maximum number of lookup fields in a single list view
HappyHourEnabled Write Boolean Should the happy hour window be enabled for this web app
HappyHour Write MSFT_SPWebApplicationHappyHour The time window for happy hour
UniquePermissionThreshold Write UInt32 What is the limit for unique permissions on a single object in this web app
RequestThrottling Write Boolean Is request throttling enabled on this web app
ChangeLogEnabled Write Boolean Is the change log enabled for this web app
ChangeLogExpiryDays Write UInt32 How many days does the change log store data for
EventHandlersEnabled Write Boolean Are event handlers enabled in the web application

MSFT_SPWebApplicationHappyHour

Parameters

Parameter Attribute DataType Description Allowed Values
Hour Write UInt32
Minute Write UInt32
Duration Write UInt32

Description

Type: Distributed Requires CredSSP: No

This resource is responsible for setting web application settings that are found under the "resource throttling" screen in central admin. The web application is specified through the URL property, and then any combination of settings can be applied. Any settings not included will be left as the default (or whatever they have been manually changed to within SharePoint). Happy hour is the setting used to control the window where threshold do not apply throughout the day. You can specify the start time of this window as well as

Examples

Example 1

This example shows how to apply throttling settings to a specific web app

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

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPWebAppThrottlingSettings PrimaryWebAppThrottlingSettings
        {
            WebAppUrl                = "http://example.contoso.local"
            ListViewThreshold        = 5000
            AllowObjectModelOverride = $false
            HappyHourEnabled         = $true
            HappyHour                = MSFT_SPWebApplicationHappyHour {
                Hour     = 3
                Minute   = 0
                Duration = 1
            }
            PsDscRunAsCredential     = $SetupAccount
        }
    }
}
Clone this wiki locally