en-US/about_SPWeb.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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
.NAME
    SPWeb

# Description
    
    **Type:** Distributed
    
    This resource will provision a SPWeb based on the settings that are passed
    through. These settings map to the New-SPWeb cmdlet and accept the same values
    
    The default value for the Ensure parameter is Present. When not specifying this
    parameter, the web is created.
    
.PARAMETER Url
    Key - string
    The URL of the web

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present if the web should exist or Absent if it should be removed

.PARAMETER Description
    Write - string
    The description to apply to the web

.PARAMETER Name
    Write - string
    The Name of the web

.PARAMETER Language
    Write - uint32
    The Lanhuage (LCID) of the web

.PARAMETER Template
    Write - string
    The WebTemplate to use to create the web

.PARAMETER UniquePermissions
    Write - Boolean
    True if the web should have unique permissions, otherwise false.

.PARAMETER UseParentTopNav
    Write - Boolean
    True if the web should use the parent nav bar, otherwise false.

.PARAMETER AddToQuickLaunch
    Write - Boolean
    True if the web should be in the quick launch of the parent web, otherwise false.

.PARAMETER AddToTopNav
    Write - Boolean
    True if the web should be added to the top nav bar of the parent web, otherwise false.

.PARAMETER RequestAccessEmail
    Write - string
    The e-mail address to which requests for access are sent. Set to emtpy string to disable access requests.

.PARAMETER InstallAccount
    Write - String
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5


.EXAMPLE
    This example deploys a subsite in a specific location


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

        node localhost {
            SPWeb TeamSite
            {
                Url                      = "http://sharepoint.contoso.com/sites/site/subweb"
                Name                     = "Team Sites"
                Ensure                   = "Present"
                Description              = "A place to share documents with your team."
                Template                 = "STS#0"
                Language                 = 1033
                AddToTopNav              = $true
                PsDscRunAsCredential     = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example deploys a subsite in a specific location and enables
    access requests for this web


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

        node localhost {
            SPWeb TeamSite
            {
                Url                      = "http://sharepoint.contoso.com/sites/site/subweb"
                Name                     = "Team Sites"
                Ensure                   = "Present"
                Description              = "A place to share documents with your team."
                Template                 = "STS#0"
                Language                 = 1033
                AddToTopNav              = $true
                UniquePermissions        = $true
                RequestAccessEmail       = "sample@contoso.com"
                PsDscRunAsCredential     = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example deploys a subsite in a specific location and disables
    access requests for this web


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

        node localhost {
            SPWeb TeamSite
            {
                Url                      = "http://sharepoint.contoso.com/sites/site/subweb"
                Name                     = "Team Sites"
                Ensure                   = "Present"
                Description              = "A place to share documents with your team."
                Template                 = "STS#0"
                Language                 = 1033
                AddToTopNav              = $true
                RequestAccessEmail       = ""
                PsDscRunAsCredential     = $SetupAccount
            }
        }
    }