DSCResources/MSFT_EXOMailContact/MSFT_EXOMailContact.psm1
|
function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory=$true)] [System.String] $Name, [Parameter(Mandatory=$true)] [System.String] $ExternalEmailAddress, [Parameter()] [System.String] [ValidateLength(0,64)] $Alias, [Parameter()] [System.String] [ValidateLength(0,256)] $DisplayName, [Parameter()] [System.String] $FirstName, [Parameter()] [System.String] $Initials, [Parameter()] [System.String] $LastName, [Parameter()] [System.String] [ValidateSet('BinHex', 'UuEncode', 'AppleSingle', 'AppleDouble')] $MacAttachmentFormat = 'BinHex', [Parameter()] [System.String] [ValidateSet('Text','Html','TextAndHtml')] $MessageBodyFormat = 'TextAndHtml', [Parameter()] [System.String] [ValidateSet('Mime', 'Text')] $MessageFormat, [Parameter()] [System.String[]] $ModeratedBy, [Parameter()] [System.Boolean] $ModerationEnabled, [Parameter()] [System.String] $OrganizationalUnit, [Parameter()] [System.String] [ValidateSet('Always', 'Internal', 'Never')] $SendModerationNotifications = 'Always', [Parameter()] [System.Boolean] $UsePreferMessageFormat, [Parameter()] [ValidateSet('Present', 'Absent')] [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 ) Write-Verbose -Message "Getting configuration of Mail Contact for $Name" if ($Global:CurrentModeIsExport) { $ConnectionMode = New-M365DSCConnection -Workload 'ExchangeOnline' ` -InboundParameters $PSBoundParameters ` -SkipModuleReload $true } else { $ConnectionMode = 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 = $PSBoundParameters $nullReturn.Ensure = "Absent" try { $contactList = Get-MailContact -ErrorAction Stop $contact = $contactList | Where-Object -FilterScript { $_.Name -eq $Name } if ($null -eq $contact) { Write-Verbose -Message "Contact $($Name) does not exist." return $nullReturn } else { $result = @{ Name = $Name ExternalEmailAddress = $contact.ExternalEmailAddress Alias = $contact.Alias DisplayName = $contact.DisplayName FirstName = $contact.FirstName Initials = $contact.Initials LastName = $contact.LastName MacAttachmentFormat = $contact.MacAttachmentFormat MessageBodyFormat = $contact.MessageBodyFormat MessageFormat = $contact.MessageFormat ModeratedBy = $contact.ModeratedBy ModerationEnabled = $contact.ModerationEnabled OrganizationalUnit = $contact.OrganizationalUnit SendModerationNotifications = $contact.SendModerationNotifications UsePreferMessageFormat = $contact.UsePreferMessageFormat Ensure = 'Present' Credential = $Credential ApplicationId = $ApplicationId CertificateThumbprint = $CertificateThumbprint CertificatePath = $CertificatePath CertificatePassword = $CertificatePassword TenantId = $TenantId } Write-Verbose -Message "Found Mail Contact $($Name)" Write-Verbose -Message "Get-TargetResource Result: `n $(Convert-M365DscHashtableToString -Hashtable $result)" return $result } } catch { try { Write-Verbose -Message $_ $tenantIdValue = "" if (-not [System.String]::IsNullOrEmpty($TenantId)) { $tenantIdValue = $TenantId } elseif ($null -ne $Credential) { $tenantIdValue = $Credential.UserName.Split('@')[1] } Add-M365DSCEvent -Message $_ -EntryType 'Error' ` -EventID 1 -Source $($MyInvocation.MyCommand.Source) ` -TenantId $tenantIdValue } catch { Write-Verbose -Message $_ } return $nullReturn } } function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory=$true)] [System.String] $Name, [Parameter(Mandatory=$true)] [System.String] $ExternalEmailAddress, [Parameter()] [System.String] [ValidateLength(0,64)] $Alias, [Parameter()] [System.String] [ValidateLength(0,256)] $DisplayName, [Parameter()] [System.String] $FirstName, [Parameter()] [System.String] $Initials, [Parameter()] [System.String] $LastName, [Parameter()] [System.String] [ValidateSet('BinHex', 'UuEncode', 'AppleSingle', 'AppleDouble')] $MacAttachmentFormat = 'BinHex', [Parameter()] [System.String] [ValidateSet('Text','Html','TextAndHtml')] $MessageBodyFormat = 'TextAndHtml', [Parameter()] [System.String] [ValidateSet('Mime', 'Text')] $MessageFormat, [Parameter()] [System.String[]] $ModeratedBy, [Parameter()] [System.Boolean] $ModerationEnabled, [Parameter()] [System.String] $OrganizationalUnit, [Parameter()] [System.String] [ValidateSet('Always', 'Internal', 'Never')] $SendModerationNotifications = 'Always', [Parameter()] [System.Boolean] $UsePreferMessageFormat, [Parameter()] [ValidateSet('Present', 'Absent')] [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 ) Write-Verbose -Message "Setting Mail Contact configuration for $Name" $currentContact = Get-TargetResource @PSBoundParameters if ($Global:CurrentModeIsExport) { $ConnectionMode = New-M365DSCConnection -Workload 'ExchangeOnline' ` -InboundParameters $PSBoundParameters ` -SkipModuleReload $true } else { $ConnectionMode = 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 $setParameters = $PSBoundParameters $setParameters.Remove('Credential') | Out-Null $setParameters.Remove('ApplicationId') | Out-Null $setParameters.Remove('TenantId') | Out-Null $setParameters.Remove('CertificateThumbprint') | Out-Null $setParameters.Remove('CertificatePath') | Out-Null $setParameters.Remove('CertificatePassword') | Out-Null $setParameters.Remove('Ensure') | Out-Null # Mail Contact doesn't exist but it should if ($Ensure -eq "Present" -and $currentContact.Ensure -eq "Absent") { Write-Verbose -Message "The Mail Contact '$($Name)' does not exist but it should. Creating Mail Contact." New-MailContact @setParameters } # Mail Contact exists but shouldn't elseif ($Ensure -eq "Absent" -and $currentContact.Ensure -eq "Present") { Write-Verbose -Message "Mail Contact'$($Name)' exists but shouldn't. Removing Mail Contact." Remove-MailContact -Identity $Name -Confirm:$false } elseif ($Ensure -eq "Present" -and $currentContact.Ensure -eq "Present") { Write-Verbose -Message "Mail Contact '$($Name)' already exists. Updating settings" Write-Verbose -Message "Updating Mail Contact '$($Name)' with values: $(Convert-M365DscHashtableToString -Hashtable $setParameters)" $setParameters.Add("Identity", $Name) $setParameters.Remove("OrganizationalUnit") | Out-Null Set-MailContact @setParameters } } function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory=$true)] [System.String] $Name, [Parameter(Mandatory=$true)] [System.String] $ExternalEmailAddress, [Parameter()] [System.String] [ValidateLength(0,64)] $Alias, [Parameter()] [System.String] [ValidateLength(0,256)] $DisplayName, [Parameter()] [System.String] $FirstName, [Parameter()] [System.String] $Initials, [Parameter()] [System.String] $LastName, [Parameter()] [System.String] [ValidateSet('BinHex', 'UuEncode', 'AppleSingle', 'AppleDouble')] $MacAttachmentFormat = 'BinHex', [Parameter()] [System.String] [ValidateSet('Text','Html','TextAndHtml')] $MessageBodyFormat = 'TextAndHtml', [Parameter()] [System.String] [ValidateSet('Mime', 'Text')] $MessageFormat, [Parameter()] [System.String[]] $ModeratedBy, [Parameter()] [System.Boolean] $ModerationEnabled, [Parameter()] [System.String] $OrganizationalUnit, [Parameter()] [System.String] [ValidateSet('Always', 'Internal', 'Never')] $SendModerationNotifications = 'Always', [Parameter()] [System.Boolean] $UsePreferMessageFormat, [Parameter()] [ValidateSet('Present', 'Absent')] [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 ) #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 Mail Contact configuration for $Name" $CurrentValues = Get-TargetResource @PSBoundParameters Write-Verbose -Message "Current Values: $(Convert-M365DscHashtableToString -Hashtable $CurrentValues)" Write-Verbose -Message "Target Values: $(Convert-M365DscHashtableToString -Hashtable $PSBoundParameters)" $ValuesToCheck = $PSBoundParameters $ValuesToCheck.Remove('Credential') | Out-Null $ValuesToCheck.Remove('ApplicationId') | Out-Null $ValuesToCheck.Remove('TenantId') | Out-Null $ValuesToCheck.Remove('CertificateThumbprint') | Out-Null $ValuesToCheck.Remove('CertificatePath') | Out-Null $ValuesToCheck.Remove('CertificatePassword') | Out-Null $ValuesToCheck.Remove('OrganizationalUnit') | Out-Null $TestResult = Test-M365DSCParameterState -CurrentValues $CurrentValues ` -Source $($MyInvocation.MyCommand.Source) ` -DesiredValues $PSBoundParameters ` -ValuesToCheck $ValuesToCheck.Keys 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.String] $CertificateThumbprint, [Parameter()] [System.String] $CertificatePath, [Parameter()] [System.Management.Automation.PSCredential] $CertificatePassword ) $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 { $dscContent = [System.Text.StringBuilder]::new() [array]$contactList = Get-MailContact -ErrorAction Stop if ($contactList.Length -eq 0) { Write-Host $Global:M365DSCEmojiGreenCheckMark } else { Write-Host "`r`n" -NoNewline } $i = 1 foreach ($contact in $contactList) { Write-Host " |---[$i/$($contactList.Count)] $($contact.Name)" -NoNewline $params = @{ Name = $contact.Name ExternalEmailAddress = $contact.ExternalEmailAddress Credential = $Credential ApplicationId = $ApplicationId TenantId = $TenantId CertificateThumbprint = $CertificateThumbprint CertificatePassword = $CertificatePassword CertificatePath = $CertificatePath } $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.Append($currentDSCBlock) | Out-Null Save-M365DSCPartialExport -Content $currentDSCBlock ` -FileName $Global:PartialExportFileName Write-Host $Global:M365DSCEmojiGreenCheckMark $i ++ } return $dscContent.ToString() } catch { try { Write-Verbose -Message $_ $tenantIdValue = "" if (-not [System.String]::IsNullOrEmpty($TenantId)) { $tenantIdValue = $TenantId } elseif ($null -ne $Credential) { $tenantIdValue = $Credential.UserName.Split('@')[1] } Add-M365DSCEvent -Message $_ -EntryType 'Error' ` -EventID 1 -Source $($MyInvocation.MyCommand.Source) ` -TenantId $tenantIdValue } catch { Write-Verbose -Message $_ } return "" } } Export-ModuleMember -Function *-TargetResource |