DSCResources/MSFT_SPSite/MSFT_SPSite.psm1
|
$script:resourceModulePath = Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent $script:modulesFolderPath = Join-Path -Path $script:resourceModulePath -ChildPath 'Modules' $script:resourceHelperModulePath = Join-Path -Path $script:modulesFolderPath -ChildPath 'SharePointDsc.Util' Import-Module -Name (Join-Path -Path $script:resourceHelperModulePath -ChildPath 'SharePointDsc.Util.psm1') function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [System.String] $Url, [Parameter(Mandatory = $true)] [System.String] $OwnerAlias, [Parameter()] [System.UInt32] $CompatibilityLevel, [Parameter()] [System.String] $ContentDatabase, [Parameter()] [System.String] $Description, [Parameter()] [System.String] $HostHeaderWebApplication, [Parameter()] [System.UInt32] $Language, [Parameter()] [System.String] $Name, [Parameter()] [System.String] $OwnerEmail, [Parameter()] [System.String] $QuotaTemplate, [Parameter()] [System.String] $SecondaryEmail, [Parameter()] [System.String] $SecondaryOwnerAlias, [Parameter()] [System.String] $Template, [Parameter()] [System.Boolean] $CreateDefaultGroups = $true, [Parameter()] [ValidateSet("TenantAdministration", "None")] [System.String] $AdministrationSiteType, [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) Write-Verbose -Message "Getting site collection $Url" $result = Invoke-SPDscCommand -Credential $InstallAccount ` -Arguments $PSBoundParameters ` -ScriptBlock { $params = $args[0] $site = $null try { $centralAdminWebApp = [Microsoft.SharePoint.Administration.SPAdministrationWebApplication]::Local $centralAdminSite = Get-SPSite -Identity $centralAdminWebApp.Url $site = New-Object "Microsoft.SharePoint.SPSite" -ArgumentList @($params.Url, $centralAdminSite.SystemAccount.UserToken) } catch [System.Exception] { } if ($null -eq $site) { Write-Verbose "Site Collection not found" return @{ Url = $params.Url OwnerAlias = $null CompatibilityLevel = $null ContentDatabase = $null Description = $null HostHeaderWebApplication = $null Language = $null Name = $null OwnerEmail = $null QuotaTemplate = $null SecondaryEmail = $null SecondaryOwnerAlias = $null Template = $null CreateDefaultGroups = $null } } else { if ($site.HostHeaderIsSiteName) { $HostHeaderWebApplication = $site.WebApplication.Url } if ($null -eq $site.Owner) { $owner = $null } else { if ($site.WebApplication.UseClaimsAuthentication) { $owner = (New-SPClaimsPrincipal -Identity $site.Owner.UserLogin ` -IdentityType "EncodedClaim").Value } else { $owner = $site.Owner.UserLogin } } if ($null -eq $site.SecondaryContact) { $secondaryOwner = $null } else { if ($site.WebApplication.UseClaimsAuthentication) { $secondaryOwner = (New-SPClaimsPrincipal -Identity $site.SecondaryContact.UserLogin ` -IdentityType "EncodedClaim").Value } else { $secondaryOwner = $site.SecondaryContact.UserLogin } } $admService = Get-SPDscContentService $quota = ($admService.QuotaTemplates | ` Where-Object -FilterScript { $_.QuotaID -eq $site.Quota.QuotaID }).Name $CreateDefaultGroups = $true if ($null -eq $site.RootWeb.AssociatedVisitorGroup -and $null -eq $site.RootWeb.AssociatedMemberGroup -and $null -eq $site.RootWeb.AssociatedOwnerGroup) { $CreateDefaultGroups = $false } return @{ Url = $site.Url OwnerAlias = $owner CompatibilityLevel = $site.CompatibilityLevel ContentDatabase = $site.ContentDatabase.Name Description = $site.RootWeb.Description HostHeaderWebApplication = $HostHeaderWebApplication Language = $site.RootWeb.Language Name = $site.RootWeb.Name OwnerEmail = $site.Owner.Email QuotaTemplate = $quota SecondaryEmail = $site.SecondaryContact.Email SecondaryOwnerAlias = $secondaryOwner Template = "$($site.RootWeb.WebTemplate)#$($site.RootWeb.Configuration)" CreateDefaultGroups = $CreateDefaultGroups AdministrationSiteType = $site.AdministrationSiteType InstallAccount = $params.InstallAccount } } } return $result } function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $Url, [Parameter(Mandatory = $true)] [System.String] $OwnerAlias, [Parameter()] [System.UInt32] $CompatibilityLevel, [Parameter()] [System.String] $ContentDatabase, [Parameter()] [System.String] $Description, [Parameter()] [System.String] $HostHeaderWebApplication, [Parameter()] [System.UInt32] $Language, [Parameter()] [System.String] $Name, [Parameter()] [System.String] $OwnerEmail, [Parameter()] [System.String] $QuotaTemplate, [Parameter()] [System.String] $SecondaryEmail, [Parameter()] [System.String] $SecondaryOwnerAlias, [Parameter()] [System.String] $Template, [Parameter()] [System.Boolean] $CreateDefaultGroups = $true, [Parameter()] [ValidateSet("TenantAdministration", "None")] [System.String] $AdministrationSiteType, [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) Write-Verbose -Message "Setting site collection $Url" if ($PSBoundParameters.ContainsKey("CreateDefaultGroups") -eq $false) { $PSBoundParameters.CreateDefaultGroups = $true } $CurrentValues = Get-TargetResource @PSBoundParameters $null = Invoke-SPDscCommand -Credential $InstallAccount ` -Arguments @($PSBoundParameters, $CurrentValues) ` -ScriptBlock { $params = $args[0] $CurrentValues = $args[1] $doCreateDefaultGroups = $false $params.Remove("InstallAccount") | Out-Null $CreateDefaultGroups = $params.CreateDefaultGroups $params.Remove("CreateDefaultGroups") | Out-Null $site = Get-SPSite -Identity $params.Url -ErrorAction SilentlyContinue if ($null -eq $site) { Write-Verbose -Message ("Starting New-SPSite with the following parameters: " + ` "$(Convert-SPDscHashtableToString $params)") $site = New-SPSite @params if ($CreateDefaultGroups -eq $true) { $doCreateDefaultGroups = $true } else { Write-Verbose -Message ("CreateDefaultGroups set to false. The default " + ` "SharePoint groups will not be created") } } else { $newParams = @{ Identity = $params.Url } if ($params.ContainsKey("QuotaTemplate") -eq $true) { if ($params.QuotaTemplate -ne $CurrentValues.QuotaTemplate) { $newParams.QuotaTemplate = $params.QuotaTemplate } } $centralAdminWebApp = [Microsoft.SharePoint.Administration.SPAdministrationWebApplication]::Local $centralAdminSite = Get-SPSite -Identity $centralAdminWebApp.Url $systemAccountSite = New-Object "Microsoft.SharePoint.SPSite" -ArgumentList @($site.Id, $centralAdminSite.SystemAccount.UserToken) if ($params.OwnerAlias -ne $CurrentValues.OwnerAlias) { Write-Verbose -Message "Updating owner to $($params.OwnerAlias)" try { $confirmedUsername = $systemAccountSite.RootWeb.EnsureUser($params.OwnerAlias) $systemAccountSite.Owner = $confirmedUsername } catch { Write-Output "Cannot resolve user $($params.OwnerAlias) as OwnerAlias" } } if ($params.ContainsKey("SecondaryOwnerAlias") -eq $true -and ` $params.SecondaryOwnerAlias -ne $CurrentValues.SecondaryOwnerAlias) { Write-Verbose -Message "Updating secondary owner to $($params.SecondaryOwnerAlias)" try { $confirmedUsername = $systemAccountSite.RootWeb.EnsureUser($params.SecondaryOwnerAlias) $systemAccountSite.SecondaryContact = $confirmedUsername } catch { Write-Verbose -Message ("Cannot resolve user $($params.SecondaryOwnerAlias) " + ` "as SecondaryOwnerAlias") } } if ($params.ContainsKey("AdministrationSiteType") -eq $true) { if ($params.AdministrationSiteType -ne $CurrentValues.AdministrationSiteType) { $newParams.AdministrationSiteType = $params.AdministrationSiteType } } if ($newParams.Count -gt 1) { Write-Verbose -Message "Updating existing site collection" Write-Verbose -Message ("Starting Set-SPSite with the following parameters: " + ` "$(Convert-SPDscHashtableToString $newParams)") Set-SPSite @newParams } if ($CurrentValues.CreateDefaultGroups -eq $false) { if ($CreateDefaultGroups -eq $true) { $doCreateDefaultGroups = $true } else { Write-Verbose -Message ("CreateDefaultGroups set to false. The default " + ` "SharePoint groups will not be created") } } } if ($doCreateDefaultGroups -eq $true) { Write-Verbose -Message ("Creating default groups") $centralAdminWebApp = [Microsoft.SharePoint.Administration.SPAdministrationWebApplication]::Local $centralAdminSite = Get-SPSite -Identity $centralAdminWebApp.Url $systemAccountSite = New-Object "Microsoft.SharePoint.SPSite" -ArgumentList @($site.Id, $centralAdminSite.SystemAccount.UserToken) if ($null -eq $systemAccountSite.SecondaryContact) { $secondaryOwnerLogin = $null } else { $secondaryOwnerLogin = $systemAccountSite.SecondaryContact.UserLogin; } $systemAccountSite.RootWeb.CreateDefaultAssociatedGroups($systemAccountSite.Owner.UserLogin, $secondaryOwnerLogin, $null) } } } function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [System.String] $Url, [Parameter(Mandatory = $true)] [System.String] $OwnerAlias, [Parameter()] [System.UInt32] $CompatibilityLevel, [Parameter()] [System.String] $ContentDatabase, [Parameter()] [System.String] $Description, [Parameter()] [System.String] $HostHeaderWebApplication, [Parameter()] [System.UInt32] $Language, [Parameter()] [System.String] $Name, [Parameter()] [System.String] $OwnerEmail, [Parameter()] [System.String] $QuotaTemplate, [Parameter()] [System.String] $SecondaryEmail, [Parameter()] [System.String] $SecondaryOwnerAlias, [Parameter()] [System.String] $Template, [Parameter()] [System.Boolean] $CreateDefaultGroups = $true, [Parameter()] [ValidateSet("TenantAdministration", "None")] [System.String] $AdministrationSiteType, [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) Write-Verbose -Message "Testing site collection $Url" $CurrentValues = Get-TargetResource @PSBoundParameters Write-Verbose -Message "Current Values: $(Convert-SPDscHashtableToString -Hashtable $CurrentValues)" Write-Verbose -Message "Target Values: $(Convert-SPDscHashtableToString -Hashtable $PSBoundParameters)" if ($CreateDefaultGroups -eq $true) { if ($CurrentValues.CreateDefaultGroups -ne $true) { $message = "The default site groups are not configured as desired." Write-Verbose -Message $message Add-SPDscEvent -Message $message -EntryType 'Error' -EventID 1 -Source $MyInvocation.MyCommand.Source Write-Verbose -Message "Test-TargetResource returned false" return $false } } $result = Test-SPDscParameterState -CurrentValues $CurrentValues ` -Source $($MyInvocation.MyCommand.Source) ` -DesiredValues $PSBoundParameters ` -ValuesToCheck @("Url", "QuotaTemplate", "OwnerAlias", "SecondaryOwnerAlias", "AdministrationSiteType") Write-Verbose -Message "Test-TargetResource returned $result" return $result } Export-ModuleMember -Function *-TargetResource |