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
.NAME
    SPWeb

# Description
    
    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 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
            }
        }
    }