en-US/about_SPWebAppBlockedFileTypes.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
.NAME
    SPWebAppBlockedFileTypes

# Description
    
    This resource is responsible for controlling the blocked file type setting on a
    specific web application. It has two modes of operation, the first is to use
    the "blocked" property, where you are able to define a specific list of file
    types that will be blocked. In this mode when it is detected that the list
    does not match the local farm, it is set to match this list exactly. The
    second mode is to use the "EnsureBlocked" and "EnsureAllowed" properties.
    EnsureBlocked will check to make sure that the specified file types are on the
    list, and if not they will be added. EnsureAllowed checks to make sure that a
    file type is not on the list, and if it is it will be removed. Both of these
    properties will only make changes to the file types in their list and will
    leave the full list as it is otherwise, whereas the blocked property resets
    
.PARAMETER Url
    Key - string
    The URL of the web application to set blocked file types for

.PARAMETER Blocked
    write - string
    This is a fixed list to use for blocked file types in this web app

.PARAMETER EnsureBlocked
    write - string
    This list of file types that will always be added to the list for this web app. Types not in this list will be left in the list

.PARAMETER EnsureAllowed
    write - string
    This list of file types that will always be removedfrom the list for this web app. Types not in this list will be left in the list

.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 ensure that specific file types are always blocked while 
    others will always be allowed. Any file types not mentioned in this config will be
    able to be managed manually.


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

        node localhost {
            SPWebAppBlockedFileTypes PrimaryWebAppBlockedFileTypes
            {
                Url                    = "http://exmaple.contoso.local"
                EnsureBlocked          = @("exe", "dll", "msi")
                EnsureAllowed          = @("pdf", "docx", "xlsx")
                PsDscRunAsCredential   = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example shows how to ensure that the blocked file type list always
    specifically matches this list.


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

        node localhost {
            SPWebAppBlockedFileTypes PrimaryWebAppBlockedFileTypes
            {
                Url                    = "http://exmaple.contoso.local"
                Blocked                = @("exe", "dll", "msi")
                PsDscRunAsCredential   = $SetupAccount
            }
        }
    }