en-US/about_SPManagedPath.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
.NAME
    SPManagedPath

# Description
    
    **Type:** Distributed
    
    This resource is responsible for creating managed paths associated with a
    specific web application. The WebAppUrl parameter is used to specify the web
    application to create the path against, and the RelativeUrl parameter lets you
    set the URL. Explicit when set to true will create an explicit inclusion path,
    if set to false the path is created as wildcard inclusion. If you are using
    host named site collections set HostHeader to true and the path will be
    created as a host header path to be applied for host named site collections.
    
    The default value for the Ensure parameter is Present. When not specifying this
    parameter, the managed path is created.
    
.PARAMETER WebAppUrl
    Key - string
    The URL of the web application to apply the managed path to - this is ignored for host header web applications

.PARAMETER RelativeUrl
    Key - string
    The relative URL of the managed path

.PARAMETER Explicit
    Required - boolean
    Should the host header be explicit? If false then it is a wildcard

.PARAMETER HostHeader
    Required - boolean
    Is this a host header web application?

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present ensures managed path exists, absent ensures it is removed

.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 deploy an explicit managed path to a specifici web application


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

        node localhost {
            SPManagedPath TestManagedPath 
            {
                WebAppUrl      = "http://sharepoint.contoso.com"
                InstallAccount = $SetupAccount
                RelativeUrl    = "example"
                Explicit       = $true
                HostHeader     = $false
            }
        }
    }


.EXAMPLE
    This example shows how to add a wildcard managed path to a specific web application


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

        node localhost {
            SPManagedPath TestManagedPath 
            {
                WebAppUrl      = "http://sharepoint.contoso.com"
                InstallAccount = $SetupAccount
                RelativeUrl    = "teams"
                Explicit       = $false
                HostHeader     = $true
            }
        }
    }


.EXAMPLE
    This example shows how to remove a wildcard managed path from a specific web application


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

        node localhost {
            SPManagedPath TestManagedPath 
            {
                WebAppUrl      = "http://sharepoint.contoso.com"
                InstallAccount = $SetupAccount
                RelativeUrl    = "teams"
                Explicit       = $false
                HostHeader     = $true
                Ensure         = "Absent"
            }
        }
    }