DSCResources/MSFT_EXOMailboxSettings/MSFT_EXOMailboxSettings.psm1
|
Confirm-M365DSCModuleDependency -ModuleName 'MSFT_EXOMailboxSettings' function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [System.String] $DisplayName, [Parameter()] [System.String] $TimeZone, [Parameter()] [System.String] $Locale, [Parameter()] [System.Boolean] $AuditEnabled, [Parameter()] [System.String] $RetentionPolicy, [Parameter()] [System.String] $AddressBookPolicy, [Parameter()] [System.String] $RoleAssignmentPolicy, [Parameter()] [System.String] $SharingPolicy, [Parameter()] [ValidateSet('Present')] [System.String] $Ensure = 'Present', [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [System.String] $CertificatePath, [Parameter()] [System.Management.Automation.PSCredential] $CertificatePassword, [Parameter()] [Switch] $ManagedIdentity, [Parameter()] [System.String[]] $AccessTokens ) Write-Verbose -Message "Getting configuration of Office 365 Mailbox Settings for $DisplayName" try { if (-not $Script:exportedInstance -or $Script:exportedInstance.UserPrincipalName -ne $DisplayName) { Write-Verbose -Message "No cached instance found, retrieving from service." if ($Global:CurrentModeIsExport) { $null = New-M365DSCConnection -Workload 'ExchangeOnline' ` -InboundParameters $PSBoundParameters ` -SkipModuleReload $true } else { $null = New-M365DSCConnection -Workload 'ExchangeOnline' ` -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 = @{ DisplayName = $DisplayName } $mailboxInfo = Get-Mailbox -Identity $DisplayName -ErrorAction SilentlyContinue } else { $nullReturn = @{ DisplayName = $DisplayName } $mailboxInfo = $Script:exportedInstance } Write-Verbose -Message "Found an existing instance of Mailbox '$($DisplayName)'" $mailboxSettings = Get-MailboxRegionalConfiguration -Identity $DisplayName -ErrorAction SilentlyContinue if ($null -eq $mailboxSettings -or $null -eq $mailboxInfo) { Write-Verbose -Message "The specified Mailbox doesn't already exist." return $nullReturn } $result = @{ DisplayName = $DisplayName TimeZone = $mailboxSettings.TimeZone Locale = $mailboxSettings.Language.Name RetentionPolicy = $mailboxInfo.RetentionPolicy AddressBookPolicy = $mailboxInfo.AddressBookPolicy RoleAssignmentPolicy = $mailboxInfo.RoleAssignmentPolicy SharingPolicy = $mailboxInfo.SharingPolicy AuditEnabled = $mailboxInfo.AuditEnabled Ensure = 'Present' Credential = $Credential ApplicationId = $ApplicationId CertificateThumbprint = $CertificateThumbprint CertificatePath = $CertificatePath CertificatePassword = $CertificatePassword ManagedIdentity = $ManagedIdentity.IsPresent TenantId = $TenantId AccessTokens = $AccessTokens } return $result } catch { New-M365DSCLogEntry -Message 'Error retrieving data:' ` -Exception $_ ` -Source $($MyInvocation.MyCommand.Source) ` -TenantId $TenantId ` -Credential $Credential throw } } function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $DisplayName, [Parameter()] [System.String] $TimeZone, [Parameter()] [System.String] $Locale, [Parameter()] [System.Boolean] $AuditEnabled, [Parameter()] [System.String] $RetentionPolicy, [Parameter()] [System.String] $AddressBookPolicy, [Parameter()] [System.String] $RoleAssignmentPolicy, [Parameter()] [System.String] $SharingPolicy, [Parameter()] [ValidateSet('Present')] [System.String] $Ensure = 'Present', [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [System.String] $CertificatePath, [Parameter()] [System.Management.Automation.PSCredential] $CertificatePassword, [Parameter()] [Switch] $ManagedIdentity, [Parameter()] [System.String[]] $AccessTokens ) Write-Verbose -Message "Setting configuration of Office 365 Mailbox Settings for $DisplayName" #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 $null = New-M365DSCConnection -Workload 'ExchangeOnline' ` -InboundParameters $PSBoundParameters Set-MailboxRegionalConfiguration -Identity $DisplayName ` -Language $Locale ` -TimeZone $TimeZone $needToUpdate = $false $updateParams = @{ Identity = $DisplayName } if (-not [System.String]::IsNullOrEmpty($AddressBookPolicy)) { $needToUpdate = $true $updateParams.Add('AddressBookPolicy', $AddressBookPolicy) } if (-not [System.String]::IsNullOrEmpty($RoleAssignmentPolicy)) { $needToUpdate = $true $updateParams.Add('RoleAssignmentPolicy', $RoleAssignmentPolicy) } if (-not [System.String]::IsNullOrEmpty($RetentionPolicy)) { $needToUpdate = $true $updateParams.Add('RetentionPolicy', $RetentionPolicy) } if (-not [System.String]::IsNullOrEmpty($SharingPolicy)) { $needToUpdate = $true $updateParams.Add('SharingPolicy', $SharingPolicy) } if ($needToUpdate) { Write-Verbose -Message "Updating Mailbox specific properties with:`r`n$(Convert-M365DscHashtableToString -Hashtable $updateParams)" Set-Mailbox @updateParams } } function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [System.String] $DisplayName, [Parameter()] [System.String] $TimeZone, [Parameter()] [System.String] $Locale, [Parameter()] [System.Boolean] $AuditEnabled, [Parameter()] [System.String] $RetentionPolicy, [Parameter()] [System.String] $AddressBookPolicy, [Parameter()] [System.String] $RoleAssignmentPolicy, [Parameter()] [System.String] $SharingPolicy, [Parameter()] [ValidateSet('Present')] [System.String] $Ensure = 'Present', [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [System.String] $CertificatePath, [Parameter()] [System.Management.Automation.PSCredential] $CertificatePassword, [Parameter()] [Switch] $ManagedIdentity, [Parameter()] [System.String[]] $AccessTokens ) #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 $result = Test-M365DSCTargetResource -DesiredValues $PSBoundParameters ` -ResourceName $($MyInvocation.MyCommand.Source).Replace('MSFT_', '') return $result } function Export-TargetResource { [CmdletBinding()] [OutputType([System.String])] param ( [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [System.String] $CertificatePath, [Parameter()] [System.Management.Automation.PSCredential] $CertificatePassword, [Parameter()] [Switch] $ManagedIdentity, [Parameter()] [System.String[]] $AccessTokens ) $ConnectionMode = New-M365DSCConnection -Workload 'ExchangeOnline' ` -InboundParameters $PSBoundParameters ` -SkipModuleReload $true #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 try { [array]$mailboxes = Get-Mailbox -ResultSize 'Unlimited' $i = 1 if ($mailboxes.Length -eq 0) { Write-M365DSCHost -Message $Global:M365DSCEmojiGreenCheckMark -CommitWrite } else { Write-M365DSCHost -Message "`r`n"-DeferWrite } $dscContent = '' $ObjectGuid = [System.Guid]::empty foreach ($mailbox in $mailboxes) { $DisplayNameValue = $mailbox.Name if ([System.Guid]::TryParse($mailbox.Identity, [System.Management.Automation.PSReference]$ObjectGuid)) { try { $user = Get-User -Identity $mailbox.Identity $DisplayNameValue = $user.UserPrincipalName } catch { Write-Verbose -Message "Could not retrieve user with id {$($mailbox.Identity)}" } } Write-M365DSCHost -Message " |---[$i/$($mailboxes.Length)] $($DisplayNameValue)" -DeferWrite if (-not [System.String]::IsNullOrEmpty($DisplayNameValue)) { if ($null -ne $Global:M365DSCExportResourceInstancesCount) { $Global:M365DSCExportResourceInstancesCount++ } $Params = @{ Credential = $Credential DisplayName = $DisplayNameValue ApplicationId = $ApplicationId TenantId = $TenantId CertificateThumbprint = $CertificateThumbprint CertificatePassword = $CertificatePassword ManagedIdentity = $ManagedIdentity.IsPresent CertificatePath = $CertificatePath AccessTokens = $AccessTokens } $Script:exportedInstance = $mailbox $Results = Get-TargetResource @Params if ($Results -is [System.Collections.Hashtable] -and $Results.Count -gt 1) { $currentDSCBlock = Get-M365DSCExportContentForResource -ResourceName $ResourceName ` -ConnectionMode $ConnectionMode ` -ModulePath $PSScriptRoot ` -Results $Results ` -Credential $Credential $dscContent += $currentDSCBlock Save-M365DSCPartialExport -Content $currentDSCBlock ` -FileName $Global:PartialExportFileName Write-M365DSCHost -Message $Global:M365DSCEmojiGreenCheckMark -CommitWrite } else { Write-M365DSCHost -Message $Global:M365DSCEmojiRedX -CommitWrite } } $i++ } return $dscContent } catch { New-M365DSCLogEntry -Message 'Error during Export:' ` -Exception $_ ` -Source $($MyInvocation.MyCommand.Source) ` -TenantId $TenantId ` -Credential $Credential throw } } Export-ModuleMember -Function *-TargetResource |