Modules/SharePointDsc.WebApplication/SPWebApplication.Throttling.psm1
|
$script:SPDscUtilModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\SharePointDsc.Util' Import-Module -Name $script:SPDscUtilModulePath function Get-SPDscWebApplicationThrottlingConfig { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] $WebApplication ) return @{ ListViewThreshold = $WebApplication.MaxItemsPerThrottledOperation AllowObjectModelOverride = $WebApplication.AllowOMCodeOverrideThrottleSettings AdminThreshold = $WebApplication.MaxItemsPerThrottledOperationOverride ListViewLookupThreshold = $WebApplication.MaxQueryLookupFields HappyHourEnabled = $WebApplication.UnthrottledPrivilegedOperationWindowEnabled HappyHour = @{ Hour = $WebApplication.DailyStartUnthrottledPrivilegedOperationsHour Minute = $WebApplication.DailyStartUnthrottledPrivilegedOperationsMinute Duration = $WebApplication.DailyUnthrottledPrivilegedOperationsDuration } UniquePermissionThreshold = $WebApplication.MaxUniquePermScopesPerList RequestThrottling = $WebApplication.HttpThrottleSettings.PerformThrottle ChangeLogEnabled = $WebApplication.ChangeLogExpirationEnabled ChangeLogExpiryDays = $WebApplication.ChangeLogRetentionPeriod.Days EventHandlersEnabled = $WebApplication.EventHandlersEnabled } } function Set-SPDscWebApplicationThrottlingConfig { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] $WebApplication, [Parameter(Mandatory = $true)] $Settings ) # Format here is SPWebApplication property = Custom settings property $mapping = @{ MaxItemsPerThrottledOperation = "ListViewThreshold" AllowOMCodeOverrideThrottleSettings = "AllowObjectModelOverride" MaxItemsPerThrottledOperationOverride = "AdminThreshold" MaxQueryLookupFields = "ListViewLookupThreshold" UnthrottledPrivilegedOperationWindowEnabled = "HappyHourEnabled" MaxUniquePermScopesPerList = "UniquePermissionThreshold" EventHandlersEnabled = "EventHandlersEnabled" ChangeLogExpirationEnabled = "ChangeLogEnabled" } $mapping.Keys | ForEach-Object -Process { Set-SPDscObjectPropertyIfValuePresent -ObjectToSet $WebApplication ` -PropertyToSet $_ ` -ParamsValue $settings ` -ParamKey $mapping[$_] } # Set throttle settings child property seperately Set-SPDscObjectPropertyIfValuePresent -ObjectToSet $WebApplication.HttpThrottleSettings ` -PropertyToSet "PerformThrottle" ` -ParamsValue $Settings ` -ParamKey "RequestThrottling" # Create time span object separately if (($Settings.ContainsKey("ChangeLogExpiryDays")) -eq $true) { $days = New-TimeSpan -Days $Settings.ChangeLogExpiryDays $WebApplication.ChangeLogRetentionPeriod = $days } } function Set-SPDscWebApplicationHappyHourConfig { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] $WebApplication, [Parameter(Mandatory = $true)] $Settings ) if ((Test-SPDscObjectHasProperty $Settings "Hour") -eq $false ` -or (Test-SPDscObjectHasProperty $Settings "Minute") -eq $false ` -or (Test-SPDscObjectHasProperty $Settings "Duration") -eq $false) { $message = "Happy hour settings must include 'hour', 'minute' and 'duration'" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } else { if ($Settings.Hour -lt 0 -or $Settings.Hour -gt 23) { $message = "Happy hour setting 'hour' must be between 0 and 23" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } if ($Settings.Minute -lt 0 -or $Settings.Minute -gt 59) { $message = "Happy hour setting 'minute' must be between 0 and 59" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } if ($Settings.Duration -lt 0 -or $Settings.Duration -gt 23) { $message = "Happy hour setting 'hour' must be between 0 and 23" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } $h = $Settings.Hour $m = $Settings.Minute $d = $Settings.Duration $WebApplication.SetDailyUnthrottledPrivilegedOperationWindow($h, $m, $d) } } function Test-SPDscWebApplicationThrottlingConfig { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] $CurrentSettings, [Parameter(Mandatory = $true)] $DesiredSettings, [Parameter(Mandatory = $true)] [System.String] $Source ) $relPath = "..\..\Modules\SharePointDsc.Util\SharePointDsc.Util.psm1" Import-Module -Name (Join-Path -Path $PSScriptRoot -ChildPath $relPath -Resolve) $testReturn = Test-SPDscParameterState -CurrentValues $CurrentSettings ` -Source $Source ` -DesiredValues $DesiredSettings ` -ValuesToCheck @( "ListViewThreshold", "AllowObjectModelOverride", "AdminThreshold", "ListViewLookupThreshold", "HappyHourEnabled", "UniquePermissionThreshold", "RequestThrottling", "ChangeLogEnabled", "ChangeLogExpiryDays", "EventHandlersEnabled" ) if ($testReturn -eq $true) { if ($null -ne $DesiredSettings.HappyHour) { $DesiredHappyHour = @{ } if ($null -ne $DesiredSettings.HappyHour.Hour) { $DesiredHappyHour.Add("Hour", [int32]$DesiredSettings.HappyHour.Hour) } else { $DesiredHappyHour.Add("Hour", $null) } if ($null -ne $DesiredSettings.HappyHour.Minute) { $DesiredHappyHour.Add("Minute", [int32]$DesiredSettings.HappyHour.Minute) } else { $DesiredHappyHour.Add("Minute", $null) } if ($null -ne $DesiredSettings.HappyHour.Duration) { $DesiredHappyHour.Add("Duration", [int32]$DesiredSettings.HappyHour.Duration) } else { $DesiredHappyHour.Add("Duration", $null) } $testReturn = Test-SPDscParameterState -CurrentValues $CurrentSettings.HappyHour ` -Source $Source ` -DesiredValues $DesiredHappyHour ` -ValuesToCheck @("Hour", "Minute", "Duration") } } return $testReturn } |