en-us/about_SPWebAppSiteUseAndDeletion.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
.NAME
    SPWebAppSiteUseAndDeletion
 
.SYNOPSIS
 
This resource is responsible for controlling the Site Use and Deletion settings on a specific web application.
You can enable or disable the Site Use and Deletion feature, specify the amount of days after which the alerts are being send, if sites have to be deleted automatically and if so after how many days this has to be done.
 
.EXAMPLE
 
    SPWebAppSiteUseAndDeletion ConfigureSiteUseAndDeletion
    {
        Url = "http://example.contoso.local"
        SendUnusedSiteCollectionNotifications = $true
        UnusedSiteNotificationPeriod = 90
        AutomaticallyDeleteUnusedSiteCollections = $true
        UnusedSiteNotificationsBeforeDeletion = 24
        PsDscRunAsCredential = $InstallAccount
    }
 
.PARAMETER Url
    Key - string
    The URL of the web application
 
.PARAMETER SendUnusedSiteCollectionNotifications
    Write - boolean
    Should emails be sent to notify site owners of unused site collections
 
.PARAMETER UnusedSiteNotificationPeriod
    Write - uint32
    How many days should pass before a site is flagged as unused
 
.PARAMETER AutomaticallyDeleteUnusedSiteCollections
    Write - boolean
    Should unused site collection be automatically deleted
 
.PARAMETER UnusedSiteNotificationsBeforeDeletion
    Write - uint32
    How many days before an unused site is deleted should an email be sent to the owner
 
.PARAMETER InstallAccount
    Write - string
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5