en-US/about_SPWebApplicationExtension.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
.NAME
    SPWebApplicationExtension

# Description
    
    This resource is responsible for extending an existing web application into a new
    zone. The resource will provision the web application extension with all of
    the current settings, and then ensure that it stays present and will ensure the
    AllowAnonymous and Authentication methods remain consistent. Please note that this
    currently does not support changing the claims provider on an existing claims
    enabled web application externsion.
    
.PARAMETER WebAppUrl
    Key - string
    The URL of the parent web application

.PARAMETER Name
    Required - string
    The name of the web application extension

.PARAMETER Url
    Required - string
    The URL of the web application extension

.PARAMETER Zone
    Key - string
    Allowed values: Default, Intranet, Internet, Extranet, Custom
    Specifies one of the five zones with which the internal URL of this new extension is to be associated.

.PARAMETER AllowAnonymous
    Write - boolean
    Should anonymous access be enabled for this web app extension

.PARAMETER AuthenticationMethod
    Write - string
    Allowed values: NTLM, Kerberos, Claims
    What authentication mode should be used for the web app extension

.PARAMETER AuthenticationProvider
    Write - string
    What authentication provider should be used for the web app. This value is required when AuthenticationMethod is set to Claims

.PARAMETER HostHeader
    Write - string
    The host header to use for the web app extension

.PARAMETER Path
    Write - string
    The path on the local servers to host the IIS web site from

.PARAMETER Port
    Write - string
    The port to run the site on

.PARAMETER UseSSL
    Write - boolean
    Should this web app extension use SSL

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present if the web app should exist, absent if it should not

.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 create a new web application extension in the local farm


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

        node localhost {
            SPWebApplicationExtension IntranetZone
            {
                WebAppUrl              = "http://example.contoso.local"
                Name                   = "Contoso Intranet Zone"
                AllowAnonymous         = $false
                AuthenticationMethod   = "NTLM"
                Url                    = "http://intranet.contoso.local"
                Zone                   = "Intranet"
                HostHeader             = "intranet.contoso.local"
                Path                   = "c:\inetpub\wwwroot\wss\VirtualDirectories\intranet"
                UseSSL                 = $false
                Port                   = 80
                Ensure                 = "Present"
                PsDscRunAsCredential   = $SetupAccount
            }
        }
    }