en-US/about_SPWebAppThrottlingSettings.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
    SPWebAppThrottlingSettings

# Description
    
    **Type:** Distributed
    
    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
    
.PARAMETER Url
    Key - string
    The URL of the web application

.PARAMETER ListViewThreshold
    Write - uint32
    What should the list view threshold for this site be set to

.PARAMETER AllowObjectModelOverride
    Write - boolean
    Should object model code be able to be override the list view threshold

.PARAMETER AdminThreshold
    Write - uint32
    What is the list view threshold for site administrators

.PARAMETER ListViewLookupThreshold
    Write - uint32
    What is the maximum number of lookup fields in a single list view

.PARAMETER HappyHourEnabled
    Write - boolean
    Should the happy hour window be enabled for this web app

.PARAMETER HappyHour
    Write - string
    The time window for happy hour

.PARAMETER UniquePermissionThreshold
    Write - uint32
    What is the limit for unique permissions on a single object in this web app

.PARAMETER RequestThrottling
    Write - boolean
    Is request throttling enabled on this web app

.PARAMETER ChangeLogEnabled
    Write - boolean
    Is the change log enabled for this web app

.PARAMETER ChangeLogExpiryDays
    Write - uint32
    How many days does the change log store data for

.PARAMETER EventHandlersEnabled
    Write - boolean
    Are event handlers enabled in the web application

.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 throttling settings to a specific web app


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

        node localhost {
            SPWebAppThrottlingSettings PrimaryWebAppThrottlingSettings
            {
                Url                      = "http://exmaple.contoso.local"
                ListViewThreshold        = 5000
                AllowObjectModelOverride = $false
                HappyHourEnabled         = $true
                HappyHour                = MSFT_SPWebApplicationHappyHour {
                    Hour     = 3
                    Minute   = 0
                    Duration = 1
                }
                PsDscRunAsCredential     = $SetupAccount
            }
        }
    }