en-US/about_SPWebAppGeneralSettings.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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
.NAME
    SPWebAppGeneralSettings

# Description
    
    This resource is responsible for setting web application settings that are
    found under the "general settings" 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).
    
.PARAMETER Url
    Key - string
    The URL of the web app to set the general settings for

.PARAMETER TimeZone
    Write - uint32
    The timezone code to use for this web app. A full list is at https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.spregionalsettings.timezones.aspx

.PARAMETER Alerts
    Write - boolean
    Should alerts be enabled for this web app

.PARAMETER AlertsLimit
    Write - uint32
    What is the maximum number of alerts that a user can create in this web app

.PARAMETER RSS
    Write - boolean
    Should RSS feeds be enabled in this web app

.PARAMETER BlogAPI
    Write - boolean
    Should the Blog API be enabled in this web app

.PARAMETER BlogAPIAuthenticated
    Write - boolean
    Is authentication required for the blog API

.PARAMETER BrowserFileHandling
    Write - String
    Allowed values: Strict, Permissive
    What file handling mode should be used in this web app - strict or permissive

.PARAMETER SecurityValidation
    Write - boolean
    Is security validation enforced in this web app

.PARAMETER SecurityValidationExpires
    Write - boolean
    Does security validation expire after a set time

.PARAMETER SecurityValidationTimeOutMinutes
    Write - uint32
    Number of minutes security validation will expire if securityvalidationexpires is set

.PARAMETER RecycleBinEnabled
    Write - boolean
    Is the recycle bin enabled in this web application

.PARAMETER RecycleBinCleanupEnabled
    Write - boolean
    Is automatic cleanup of the recycle bin enabled in this web app

.PARAMETER RecycleBinRetentionPeriod
    Write - uint32
    How many days does the recycle bin keep content for

.PARAMETER SecondStageRecycleBinQuota
    Write - uint32
    How much content does the second stage recycle bin keep content for

.PARAMETER MaximumUploadSize
    Write - uint32
    What is the maximum file upload size for this web app (in MB)

.PARAMETER CustomerExperienceProgram
    Write - boolean
    Should the customer experience program be enabled in this web app

.PARAMETER AllowOnlineWebPartCatalog
    Write - boolean
    Should the Online WebPart Gallery be enabled for this web app

.PARAMETER SelfServiceSiteCreationEnabled
    Write - boolean
    Should Self Service Site Creation be enabled

.PARAMETER PresenceEnabled
    Write - boolean
    Is Skype for Business presence enabled for this web app

.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 some of the available general settings to the 
    specified web app


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

        node localhost {
            SPWebAppGeneralSettings PrimaryWebAppGeneralSettings
            {
                Url                    = "http://exmaple.contoso.local"
                TimeZone               = 76
                Alerts                 = $true
                RSS                    = $false
                PsDscRunAsCredential   = $SetupAccount
            }
        }
    }