DSCResources/MSFT_EXORemoteDomain/MSFT_EXORemoteDomain.psm1
|
Confirm-M365DSCModuleDependency -ModuleName 'MSFT_EXORemoteDomain' function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [System.String] $Identity, [Parameter()] [ValidateLength(0, 256)] [System.String] $DomainName, [Parameter()] [ValidateSet('External', 'ExternalLegacy', 'InternalLegacy', 'None')] [System.String] $AllowedOOFType, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.Boolean] $AutoForwardEnabled, [Parameter()] [System.Boolean] $AutoReplyEnabled, [Parameter()] [ValidateSet('Use7Bit', 'UseQP', 'UseBase64', 'UseQPHtmlDetectTextPlain', 'UseBase64HtmlDetectTextPlain', 'UseQPHtml7BitTextPlain', 'UseBase64Html7BitTextPlain', 'Undefined')] [System.String] $ByteEncoderTypeFor7BitCharsets, [Parameter()] [System.String] $CharacterSet, [Parameter()] [ValidateSet('MimeHtmlText', 'MimeText', 'MimeHtml')] [System.String] $ContentType, [Parameter()] [System.Boolean] $DeliveryReportEnabled, [Parameter()] [System.Boolean] $DisplaySenderName, [Parameter()] [System.Boolean] $IsInternal, [Parameter()] [System.String] $LineWrapSize, [Parameter()] [System.Boolean] $MeetingForwardNotificationEnabled, [Parameter()] [ValidateLength(1, 64)] [System.String] $Name, [Parameter()] [System.Boolean] $NDREnabled, [Parameter()] [System.String] $NonMimeCharacterSet, [Parameter()] [ValidateSet('50220', '50221', '50222', 'Undefined')] [System.String] $PreferredInternetCodePageForShiftJis, [Parameter()] [System.Int32] $RequiredCharsetCoverage, [Parameter()] [System.Boolean] $TargetDeliveryDomain, [Parameter()] [System.Boolean] $TNEFEnabled, [Parameter()] [System.Boolean] $TrustedMailInboundEnabled, [Parameter()] [System.Boolean] $TrustedMailOutboundEnabled, [Parameter()] [System.Boolean] $UseSimpleDisplayName, [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 Remote Domain for $Identity" try { if (-not $Script:exportedInstance -or $Script:exportedInstance.Identity -ne $Identity) { $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 = $PSBoundParameters $nullReturn.Ensure = 'Absent' $RemoteDomain = Get-RemoteDomain -Identity $Identity -ErrorAction SilentlyContinue if ($null -eq $RemoteDomain) { Write-Verbose -Message "RemoteDomain configuration for $($Identity) does not exist." return $nullReturn } } else { $RemoteDomain = $Script:exportedInstance } Write-Verbose -Message "Found RemoteDomain with Identity {$Identity}" $result = @{ Identity = $RemoteDomain.Identity DomainName = $RemoteDomain.DomainName AllowedOOFType = $RemoteDomain.AllowedOOFType Ensure = 'Present' AutoForwardEnabled = $RemoteDomain.AutoForwardEnabled AutoReplyEnabled = $RemoteDomain.AutoReplyEnabled ByteEncoderTypeFor7BitCharsets = $RemoteDomain.ByteEncoderTypeFor7BitCharsets CharacterSet = $RemoteDomain.CharacterSet ContentType = $RemoteDomain.ContentType DeliveryReportEnabled = $RemoteDomain.DeliveryReportEnabled DisplaySenderName = $RemoteDomain.DisplaySenderName IsInternal = $RemoteDomain.IsInternal LineWrapSize = $RemoteDomain.LineWrapSize MeetingForwardNotificationEnabled = $RemoteDomain.MeetingForwardNotificationEnabled Name = $RemoteDomain.Name NDREnabled = $RemoteDomain.NDREnabled NonMimeCharacterSet = $RemoteDomain.NonMimeCharacterSet PreferredInternetCodePageForShiftJis = $RemoteDomain.PreferredInternetCodePageForShiftJis RequiredCharsetCoverage = $RemoteDomain.RequiredCharsetCoverage TargetDeliveryDomain = $RemoteDomain.TargetDeliveryDomain TNEFEnabled = $RemoteDomain.TNEFEnabled TrustedMailInboundEnabled = $RemoteDomain.TrustedMailInboundEnabled TrustedMailOutboundEnabled = $RemoteDomain.TrustedMailOutboundEnabled UseSimpleDisplayName = $RemoteDomain.UseSimpleDisplayName 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 return $nullReturn } } function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $Identity, [Parameter()] [ValidateLength(0, 256)] [System.String] $DomainName, [Parameter()] [ValidateSet('External', 'ExternalLegacy', 'InternalLegacy', 'None')] [System.String] $AllowedOOFType, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.Boolean] $AutoForwardEnabled, [Parameter()] [System.Boolean] $AutoReplyEnabled, [Parameter()] [ValidateSet('Use7Bit', 'UseQP', 'UseBase64', 'UseQPHtmlDetectTextPlain', 'UseBase64HtmlDetectTextPlain', 'UseQPHtml7BitTextPlain', 'UseBase64Html7BitTextPlain', 'Undefined')] [System.String] $ByteEncoderTypeFor7BitCharsets, [Parameter()] [System.String] $CharacterSet, [Parameter()] [ValidateSet('MimeHtmlText', 'MimeText', 'MimeHtml')] [System.String] $ContentType, [Parameter()] [System.Boolean] $DeliveryReportEnabled, [Parameter()] [System.Boolean] $DisplaySenderName, [Parameter()] [System.Boolean] $IsInternal, [Parameter()] [System.String] $LineWrapSize, [Parameter()] [System.Boolean] $MeetingForwardNotificationEnabled, [Parameter()] [ValidateLength(1, 64)] [System.String] $Name, [Parameter()] [System.Boolean] $NDREnabled, [Parameter()] [System.String] $NonMimeCharacterSet, [Parameter()] [ValidateSet('50220', '50221', '50222', 'Undefined')] [System.String] $PreferredInternetCodePageForShiftJis, [Parameter()] [System.Int32] $RequiredCharsetCoverage, [Parameter()] [System.Boolean] $TargetDeliveryDomain, [Parameter()] [System.Boolean] $TNEFEnabled, [Parameter()] [System.Boolean] $TrustedMailInboundEnabled, [Parameter()] [System.Boolean] $TrustedMailOutboundEnabled, [Parameter()] [System.Boolean] $UseSimpleDisplayName, [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 ) #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 "Setting configuration of Remote Domain for $Identity" $currentRemoteDomainConfig = Get-TargetResource @PSBoundParameters $null = New-M365DSCConnection -Workload 'ExchangeOnline' ` -InboundParameters $PSBoundParameters $RemoteDomainParams = Remove-M365DSCAuthenticationParameter -BoundParameters $PSBoundParameters # CASE: Remote Domain doesn't exist but should; if ($Ensure -eq 'Present' -and $currentRemoteDomainConfig.Ensure -eq 'Absent') { Write-Verbose -Message "Remote Domain '$($Name)' does not exist but it should. Create and configure it." # Create remote domain if ([System.String]::IsNullOrEmpty($Name)) { $Name = $Identity } New-RemoteDomain -Name $Name -DomainName $DomainName $tries = 1 $remoteDomain = $null do { Write-Verbose -Message 'Waiting for 10 seconds' Start-Sleep -Seconds 10 $remoteDomain = Get-RemoteDomain -Identity $Name -ErrorAction SilentlyContinue $tries++ } until ($null -eq $remoteDomain -or $tries -le 12) # Configure new remote domain $RemoteDomainParams.Remove('DomainName') | Out-Null Set-RemoteDomain @RemoteDomainParams } # CASE: Remote Domain exists but it shouldn't; elseif ($Ensure -eq 'Absent' -and $currentRemoteDomainConfig.Ensure -eq 'Present') { Write-Verbose -Message "Remote Domain '$($Name)' exists but it shouldn't. Remove it." Remove-RemoteDomain -Identity $Name -Confirm:$false } # CASE: Remote Domain exists and it should, but has different values than the desired ones elseif ($Ensure -eq 'Present' -and $currentRemoteDomainConfig.Ensure -eq 'Present') { Write-Verbose -Message "Remote Domain '$($Name)' already exists, but needs updating." Write-Verbose -Message "Setting RemoteDomain for $($Identity) with values: $(Convert-M365DscHashtableToString -Hashtable $RemoteDomainParams)" $RemoteDomainParams.Remove('DomainName') | Out-Null Set-RemoteDomain @RemoteDomainParams } } function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [System.String] $Identity, [Parameter()] [ValidateLength(0, 256)] [System.String] $DomainName, [Parameter()] [ValidateSet('External', 'ExternalLegacy', 'InternalLegacy', 'None')] [System.String] $AllowedOOFType, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.Boolean] $AutoForwardEnabled, [Parameter()] [System.Boolean] $AutoReplyEnabled, [Parameter()] [ValidateSet('Use7Bit', 'UseQP', 'UseBase64', 'UseQPHtmlDetectTextPlain', 'UseBase64HtmlDetectTextPlain', 'UseQPHtml7BitTextPlain', 'UseBase64Html7BitTextPlain', 'Undefined')] [System.String] $ByteEncoderTypeFor7BitCharsets, [Parameter()] [System.String] $CharacterSet, [Parameter()] [ValidateSet('MimeHtmlText', 'MimeText', 'MimeHtml')] [System.String] $ContentType, [Parameter()] [System.Boolean] $DeliveryReportEnabled, [Parameter()] [System.Boolean] $DisplaySenderName, [Parameter()] [System.Boolean] $IsInternal, [Parameter()] [System.String] $LineWrapSize, [Parameter()] [System.Boolean] $MeetingForwardNotificationEnabled, [Parameter()] [ValidateLength(1, 64)] [System.String] $Name, [Parameter()] [System.Boolean] $NDREnabled, [Parameter()] [System.String] $NonMimeCharacterSet, [Parameter()] [ValidateSet('50220', '50221', '50222', 'Undefined')] [System.String] $PreferredInternetCodePageForShiftJis, [Parameter()] [System.Int32] $RequiredCharsetCoverage, [Parameter()] [System.Boolean] $TargetDeliveryDomain, [Parameter()] [System.Boolean] $TNEFEnabled, [Parameter()] [System.Boolean] $TrustedMailInboundEnabled, [Parameter()] [System.Boolean] $TrustedMailOutboundEnabled, [Parameter()] [System.Boolean] $UseSimpleDisplayName, [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]$AllRemoteDomains = Get-RemoteDomain -ErrorAction Stop $dscContent = '' if ($AllRemoteDomains.Length -eq 0) { Write-M365DSCHost -Message $Global:M365DSCEmojiGreenCheckMark -CommitWrite } else { Write-M365DSCHost -Message "`r`n" -DeferWrite } $i = 1 foreach ($domain in $AllRemoteDomains) { if ($null -ne $Global:M365DSCExportResourceInstancesCount) { $Global:M365DSCExportResourceInstancesCount++ } Write-M365DSCHost -Message " |---[$i/$($AllRemoteDomains.Length)] $($domain.Identity)" -DeferWrite $Params = @{ Identity = $domain.Identity Credential = $Credential ApplicationId = $ApplicationId TenantId = $TenantId CertificateThumbprint = $CertificateThumbprint CertificatePassword = $CertificatePassword ManagedIdentity = $ManagedIdentity.IsPresent CertificatePath = $CertificatePath AccessTokens = $AccessTokens } $Script:exportedInstance = $domain $Results = Get-TargetResource @Params $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 $i++ } return $dscContent } catch { Write-M365DSCHost -Message $Global:M365DSCEmojiRedX -CommitWrite New-M365DSCLogEntry -Message 'Error during Export:' ` -Exception $_ ` -Source $($MyInvocation.MyCommand.Source) ` -TenantId $TenantId ` -Credential $Credential return '' } } Export-ModuleMember -Function *-TargetResource |