About Help

Choose a topic from the list on the left or search for a specific topic. Choose a topic from the list or search for a specific topic.
Cmdlets  Providers  Aliases  Modules
 

about_SPWebAppThrottlingSettings

Spwebappthrottlingsettings

SharePointDSC
 

SHORT DESCRIPTION

 

.NAME

    SPWebAppThrottlingSettings 
 
# Description 
     
    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 
            } 
        } 
    }