functions/SPClientWeb/New-SPClientWeb.ps1

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
#Requires -Version 3.0

<#
  New-SPClientWeb.ps1
 
  Copyright (c) 2017 karamem0
 
  This software is released under the MIT License.
  https://github.com/karamem0/SPClient/blob/master/LICENSE
#>


function New-SPClientWeb {

<#
.SYNOPSIS
  Creates a new subsite.
.DESCRIPTION
  The New-SPClientWeb function adds a new subsite to the site.
.PARAMETER ClientContext
  Indicates the client context. If not specified, uses default context.
.PARAMETER ParentObject
  Indicates the site which a subsite to be created.
.PARAMETER Url
  Indicates the url.
.PARAMETER Title
  Indicates the title. If not specified, uses default title of the site template.
.PARAMETER Description
  Indicates the description.
.PARAMETER Locale
  Indicates the locale ID in which the language is used. If not specified, uses the parent site language.
.PARAMETER Template
  Indicates the template name.
.PARAMETER UniquePermissions
  If specified, the site uses unique permissions.
.PARAMETER Retrieval
  Indicates the data retrieval expression.
.EXAMPLE
  New-SPClientWeb -Url "CustomWeb" -Title "Custom Web"
.INPUTS
  None or SPClient.SPClientWebParentPipeBind
.OUTPUTS
  Microsoft.SharePoint.Client.Web
.LINK
  https://github.com/karamem0/SPClient/blob/master/doc/New-SPClientWeb.md
#>


    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $false)]
        [Microsoft.SharePoint.Client.ClientContext]
        $ClientContext = $SPClient.ClientContext,
        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true)]
        [SPClient.SPClientWebParentPipeBind]
        $ParentObject,
        [Parameter(Mandatory = $true)]
        [string]
        $Url,
        [Parameter(Mandatory = $false)]
        [string]
        $Title,
        [Parameter(Mandatory = $false)]
        [string]
        $Description,
        [Parameter(Mandatory = $false)]
        [Alias('Language')]
        [string]
        $Locale,
        [Parameter(Mandatory = $false)]
        [SPClient.SPClientWebTemplateIdentityPipeBind]
        $Template,
        [Parameter(Mandatory = $false)]
        [switch]
        $UniquePermissions,
        [Parameter(Mandatory = $false)]
        [string]
        $Retrieval
    )

    process {
        if ($ClientContext -eq $null) {
            throw "Cannot bind argument to parameter 'ClientContext' because it is null."
        }
        $Creation = New-Object Microsoft.SharePoint.Client.WebCreationInformation
        $Creation.Url = $Url
        $Creation.Language = $Locale
        if ($PSBoundParameters.ContainsKey('Template')) {
            $Creation.WebTemplate = $Template.GetValue($ClientContext)
        }
        $Creation.Title = $Title
        $Creation.Description = $Description
        $Creation.UseSamePermissionsAsParentSite = -not $UniquePermissions
        $ClientObject = $ParentObject.ClientObject.Webs.Add($Creation)
        $ClientObject.Update()
        Invoke-ClientContextLoad `
            -ClientContext $ClientContext `
            -ClientObject $ClientObject `
            -Retrieval $Retrieval
        Write-Output $ClientObject
    }

}