DSCResources/MSFT_SPOAccessControlSettings/MSFT_SPOAccessControlSettings.psm1
|
function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [ValidateSet('Yes')] [String] $IsSingleInstance, [Parameter()] [System.Boolean] $DisplayStartASiteOption, [Parameter()] [System.String] $StartASiteFormUrl, [Parameter()] [System.Boolean] $IPAddressEnforcement, [Parameter()] [System.String] $IPAddressAllowList, [Parameter()] [System.UInt32] $IPAddressWACTokenLifetime, [Parameter()] [System.Boolean] $CommentsOnSitePagesDisabled, [Parameter()] [System.Boolean] $SocialBarOnSitePagesDisabled, [Parameter()] [System.Boolean] $DisallowInfectedFileDownload, [Parameter()] [System.boolean] $ExternalServicesEnabled, [Parameter()] [System.Boolean] $EmailAttestationRequired, [Parameter()] [System.UInt32] $EmailAttestationReAuthDays, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.Management.Automation.PSCredential] $ApplicationSecret, [Parameter()] [System.String] $CertificatePath, [Parameter()] [System.Management.Automation.PSCredential] $CertificatePassword, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [Switch] $ManagedIdentity ) Write-Verbose -Message 'Getting configuration of SharePoint Online Access Control Settings' $ConnectionMode = New-M365DSCConnection -Workload 'PnP' ` -InboundParameters $PSBoundParameters #Ensure the proper dependencies are installed in the current environment. Confirm-M365DSCDependencies #region Telemetry $ResourceName = $MyInvocation.MyCommand.ModuleName -replace 'MSFT_', '' $CommandName = $MyInvocation.MyCommand $data = Format-M365DSCTelemetryParameters -ResourceName $ResourceName ` -CommandName $CommandName ` -Parameters $PSBoundParameters Add-M365DSCTelemetryEvent -Data $data #endregion $nullReturn = $PSBoundParameters $nullReturn.Ensure = 'Absent' try { $SPOAccessControlSettings = Get-PnPTenant -ErrorAction Stop return @{ IsSingleInstance = 'Yes' DisplayStartASiteOption = $SPOAccessControlSettings.DisplayStartASiteOption StartASiteFormUrl = $SPOAccessControlSettings.StartASiteFormUrl IPAddressEnforcement = $SPOAccessControlSettings.IPAddressEnforcement IPAddressAllowList = $SPOAccessControlSettings.IPAddressAllowList IPAddressWACTokenLifetime = $SPOAccessControlSettings.IPAddressWACTokenLifetime CommentsOnSitePagesDisabled = $SPOAccessControlSettings.CommentsOnSitePagesDisabled SocialBarOnSitePagesDisabled = $SPOAccessControlSettings.SocialBarOnSitePagesDisabled DisallowInfectedFileDownload = $SPOAccessControlSettings.DisallowInfectedFileDownload ExternalServicesEnabled = $SPOAccessControlSettings.ExternalServicesEnabled EmailAttestationRequired = $SPOAccessControlSettings.EmailAttestationRequired EmailAttestationReAuthDays = $SPOAccessControlSettings.EmailAttestationReAuthDays Credential = $Credential ApplicationId = $ApplicationId TenantId = $TenantId ApplicationSecret = $ApplicationSecret CertificatePassword = $CertificatePassword CertificatePath = $CertificatePath CertificateThumbprint = $CertificateThumbprint Managedidentity = $ManagedIdentity.IsPresent Ensure = 'Present' } } catch { if ($error[0].Exception.Message -like 'No connection available') { Write-Verbose -Message 'Make sure that you are connected to your SPOService' } New-M365DSCLogEntry -Message 'Error retrieving data:' ` -Exception $_ ` -Source $($MyInvocation.MyCommand.Source) ` -TenantId $TenantId ` -Credential $Credential return $nullReturn } } function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateSet('Yes')] [String] $IsSingleInstance, [Parameter()] [System.Boolean] $DisplayStartASiteOption, [Parameter()] [System.String] $StartASiteFormUrl, [Parameter()] [System.Boolean] $IPAddressEnforcement, [Parameter()] [System.String] $IPAddressAllowList, [Parameter()] [System.UInt32] $IPAddressWACTokenLifetime, [Parameter()] [System.Boolean] $CommentsOnSitePagesDisabled, [Parameter()] [System.Boolean] $SocialBarOnSitePagesDisabled, [Parameter()] [System.Boolean] $DisallowInfectedFileDownload, [Parameter()] [System.boolean] $ExternalServicesEnabled, [Parameter()] [System.Boolean] $EmailAttestationRequired, [Parameter()] [System.UInt32] $EmailAttestationReAuthDays, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.Management.Automation.PSCredential] $ApplicationSecret, [Parameter()] [System.String] $CertificatePath, [Parameter()] [System.Management.Automation.PSCredential] $CertificatePassword, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [Switch] $ManagedIdentity ) Write-Verbose -Message 'Setting configuration of SharePoint Online Access Control Settings' #Ensure the proper dependencies are installed in the current environment. Confirm-M365DSCDependencies #region Telemetry $ResourceName = $MyInvocation.MyCommand.ModuleName -replace 'MSFT_', '' $CommandName = $MyInvocation.MyCommand $data = Format-M365DSCTelemetryParameters -ResourceName $ResourceName ` -CommandName $CommandName ` -Parameters $PSBoundParameters Add-M365DSCTelemetryEvent -Data $data #endregion $ConnectionMode = New-M365DSCConnection -Workload 'PnP' ` -InboundParameters $PSBoundParameters $CurrentParameters = $PSBoundParameters $CurrentParameters.Remove('Ensure') | Out-Null $CurrentParameters.Remove('Credential') | Out-Null $CurrentParameters.Remove('IsSingleInstance') | Out-Null $CurrentParameters.Remove('ApplicationId') | Out-Null $CurrentParameters.Remove('TenantId') | Out-Null $CurrentParameters.Remove('CertificatePath') | Out-Null $CurrentParameters.Remove('CertificatePassword') | Out-Null $CurrentParameters.Remove('CertificateThumbprint') | Out-Null $CurrentParameters.Remove('ManagedIdentity') | Out-Null $CurrentParameters.Remove('ApplicationSecret') | Out-Null if ($IPAddressAllowList -eq '') { Write-Verbose -Message 'The IPAddressAllowList is not configured, for that the IPAddressEnforcement parameter can not be set and will be removed' $CurrentParameters.Remove('IPAddressEnforcement') $CurrentParameters.Remove('IPAddressAllowList') } $tenant = Set-PnPTenant @CurrentParameters } function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [ValidateSet('Yes')] [String] $IsSingleInstance, [Parameter()] [System.Boolean] $DisplayStartASiteOption, [Parameter()] [System.String] $StartASiteFormUrl, [Parameter()] [System.Boolean] $IPAddressEnforcement, [Parameter()] [System.String] $IPAddressAllowList, [Parameter()] [System.UInt32] $IPAddressWACTokenLifetime, [Parameter()] [System.Boolean] $CommentsOnSitePagesDisabled, [Parameter()] [System.Boolean] $SocialBarOnSitePagesDisabled, [Parameter()] [System.Boolean] $DisallowInfectedFileDownload, [Parameter()] [System.boolean] $ExternalServicesEnabled, [Parameter()] [System.Boolean] $EmailAttestationRequired, [Parameter()] [System.UInt32] $EmailAttestationReAuthDays, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.Management.Automation.PSCredential] $ApplicationSecret, [Parameter()] [System.String] $CertificatePath, [Parameter()] [System.Management.Automation.PSCredential] $CertificatePassword, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [Switch] $ManagedIdentity ) #Ensure the proper dependencies are installed in the current environment. Confirm-M365DSCDependencies #region Telemetry $ResourceName = $MyInvocation.MyCommand.ModuleName -replace 'MSFT_', '' $CommandName = $MyInvocation.MyCommand $data = Format-M365DSCTelemetryParameters -ResourceName $ResourceName ` -CommandName $CommandName ` -Parameters $PSBoundParameters Add-M365DSCTelemetryEvent -Data $data #endregion Write-Verbose -Message 'Testing configuration of SharePoint Online Access Control Settings' $CurrentValues = Get-TargetResource @PSBoundParameters Write-Verbose -Message "Current Values: $(Convert-M365DscHashtableToString -Hashtable $CurrentValues)" Write-Verbose -Message "Target Values: $(Convert-M365DscHashtableToString -Hashtable $PSBoundParameters)" $TestResult = Test-M365DSCParameterState -CurrentValues $CurrentValues ` -Source $($MyInvocation.MyCommand.Source) ` -DesiredValues $PSBoundParameters ` -ValuesToCheck @('IsSingleInstance', ` 'Credential', ` 'DisplayStartASiteOption', ` 'StartASiteFormUrl', ` 'IPAddressEnforcement', ` 'IPAddressAllowList', ` 'IPAddressWACTokenLifetime', ` 'CommentsOnSitePagesDisabled', ` 'SocialBarOnSitePagesDisabled', ` 'DisallowInfectedFileDownload', ` 'ExternalServicesEnabled', ` 'EmailAttestationRequired', ` 'EmailAttestationReAuthDays') Write-Verbose -Message "Test-TargetResource returned $TestResult" return $TestResult } function Export-TargetResource { [CmdletBinding()] [OutputType([System.String])] param ( [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.Management.Automation.PSCredential] $ApplicationSecret, [Parameter()] [System.String] $CertificatePath, [Parameter()] [System.Management.Automation.PSCredential] $CertificatePassword, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [Switch] $ManagedIdentity ) try { $ConnectionMode = New-M365DSCConnection -Workload 'PNP' ` -InboundParameters $PSBoundParameters #Ensure the proper dependencies are installed in the current environment. Confirm-M365DSCDependencies #region Telemetry $ResourceName = $MyInvocation.MyCommand.ModuleName -replace 'MSFT_', '' $CommandName = $MyInvocation.MyCommand $data = Format-M365DSCTelemetryParameters -ResourceName $ResourceName ` -CommandName $CommandName ` -Parameters $PSBoundParameters Add-M365DSCTelemetryEvent -Data $data #endregion $Params = @{ IsSingleInstance = 'Yes' ApplicationId = $ApplicationId TenantId = $TenantId CertificatePassword = $CertificatePassword CertificatePath = $CertificatePath CertificateThumbprint = $CertificateThumbprint Managedidentity = $ManagedIdentity.IsPresent Credential = $Credential ApplicationSecret = $ApplicationSecret } $dscContent = '' $Results = Get-TargetResource @Params $Results = Update-M365DSCExportAuthenticationResults -ConnectionMode $ConnectionMode ` -Results $Results $currentDSCBlock = Get-M365DSCExportContentForResource -ResourceName $ResourceName ` -ConnectionMode $ConnectionMode ` -ModulePath $PSScriptRoot ` -Results $Results ` -Credential $Credential $dscContent += $currentDSCBlock Save-M365DSCPartialExport -Content $currentDSCBlock ` -FileName $Global:PartialExportFileName Write-Host $Global:M365DSCEmojiGreenCheckMark return $dscContent } catch { Write-Host $Global:M365DSCEmojiRedX New-M365DSCLogEntry -Message 'Error during Export:' ` -Exception $_ ` -Source $($MyInvocation.MyCommand.Source) ` -TenantId $TenantId ` -Credential $Credential return '' } } Export-ModuleMember -Function *-TargetResource |