DSCResources/MSFT_TeamsClientConfiguration/MSFT_TeamsClientConfiguration.psm1
|
Confirm-M365DSCModuleDependency -ModuleName 'MSFT_TeamsClientConfiguration' function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [System.String] [ValidateSet('Global')] $Identity, [Parameter()] [System.Boolean] $AllowBox, [Parameter()] [System.Boolean] $AllowDropBox, [Parameter()] [System.Boolean] $AllowEmailIntoChannel, [Parameter()] [System.Boolean] $AllowGoogleDrive, [Parameter()] [System.Boolean] $AllowGuestUser, [Parameter()] [System.Boolean] $AllowOrganizationTab, [Parameter()] [System.Boolean] $AllowResourceAccountSendMessage, [Parameter()] [System.Boolean] $AllowScopedPeopleSearchandAccess, [Parameter()] [System.Boolean] $AllowShareFile, [Parameter()] [System.Boolean] $AllowSkypeBusinessInterop, [Parameter()] [System.Boolean] $AllowEgnyte, [Parameter()] [System.String] [ValidateSet('NotRequired', 'RequiredOutsideScheduleMeeting', 'AlwaysRequired')] $ContentPin = 'RequiredOutsideScheduledMeeting', [Parameter()] [System.String] [ValidateSet('NoAccess', 'PartialAccess', 'FullAccess')] $ResourceAccountContentAccess, [Parameter()] [System.String[]] $RestrictedSenderList = $null, [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [Switch] $ManagedIdentity, [Parameter()] [System.String[]] $AccessTokens ) Write-Verbose -Message 'Getting configuration of Teams Client' try { if (-not $Script:exportMode) { $null = New-M365DSCConnection -Workload 'MicrosoftTeams' ` -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 = @{ Identity = 'Global' } } $config = Get-CsTeamsClientConfiguration -ErrorAction Stop $result = @{ Identity = $config.Identity AllowBox = $config.AllowBox AllowDropBox = $config.AllowDropBox AllowEgnyte = $config.AllowEgnyte AllowEmailIntoChannel = $config.AllowEmailIntoChannel AllowGoogleDrive = $config.AllowGoogleDrive AllowGuestUser = $config.AllowGuestUser AllowOrganizationTab = $config.AllowOrganizationTab AllowResourceAccountSendMessage = $config.AllowResourceAccountSendMessage AllowScopedPeopleSearchandAccess = $config.AllowScopedPeopleSearchandAccess AllowShareFile = $config.AllowShareFile AllowSkypeBusinessInterop = $config.AllowSkypeBusinessInterop ContentPin = $config.ContentPin ResourceAccountContentAccess = $config.ResourceAccountContentAccess RestrictedSenderList = $config.RestrictedSenderList Credential = $Credential ApplicationId = $ApplicationId TenantId = $TenantId CertificateThumbprint = $CertificateThumbprint ManagedIdentity = $ManagedIdentity.IsPresent AccessTokens = $AccessTokens } if ([System.String]::IsNullOrEmpty($Config.RestrictedSenderList)) { $result.Remove('RestrictedSenderList') | Out-Null } 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] [ValidateSet('Global')] $Identity, [Parameter()] [System.Boolean] $AllowBox, [Parameter()] [System.Boolean] $AllowDropBox, [Parameter()] [System.Boolean] $AllowEmailIntoChannel, [Parameter()] [System.Boolean] $AllowGoogleDrive, [Parameter()] [System.Boolean] $AllowGuestUser, [Parameter()] [System.Boolean] $AllowOrganizationTab, [Parameter()] [System.Boolean] $AllowResourceAccountSendMessage, [Parameter()] [System.Boolean] $AllowScopedPeopleSearchandAccess, [Parameter()] [System.Boolean] $AllowShareFile, [Parameter()] [System.Boolean] $AllowSkypeBusinessInterop, [Parameter()] [System.Boolean] $AllowEgnyte, [Parameter()] [System.String] [ValidateSet('NotRequired', 'RequiredOutsideScheduleMeeting', 'AlwaysRequired')] $ContentPin = 'RequiredOutsideScheduledMeeting', [Parameter()] [System.String] [ValidateSet('NoAccess', 'PartialAccess', 'FullAccess')] $ResourceAccountContentAccess, [Parameter()] [System.String[]] $RestrictedSenderList = $null, [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [Switch] $ManagedIdentity, [Parameter()] [System.String[]] $AccessTokens ) Write-Verbose -Message 'Setting configuration of Teams Client' #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 'MicrosoftTeams' ` -InboundParameters $PSBoundParameters $SetParams = Remove-M365DSCAuthenticationParameter -BoundParameters $PSBoundParameters if ([System.String]::IsNullOrEmpty($RestrictedSenderList)) { $SetParams.Remove('RestrictedSenderList') | Out-Null } else { # https://learn.microsoft.com/en-us/powershell/module/teams/set-csteamsclientconfiguration?view=teams-ps#-restrictedsenderlist # This is a semicolon-separated string of the domains you'd like to allow to send emails to Teams channels $tempValue = $SetParams['RestrictedSenderList'] -join ';' $SetParams.RestrictedSenderList = $tempValue } Set-CsTeamsClientConfiguration @SetParams } function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [System.String] [ValidateSet('Global')] $Identity, [Parameter()] [System.Boolean] $AllowBox, [Parameter()] [System.Boolean] $AllowDropBox, [Parameter()] [System.Boolean] $AllowEmailIntoChannel, [Parameter()] [System.Boolean] $AllowGoogleDrive, [Parameter()] [System.Boolean] $AllowGuestUser, [Parameter()] [System.Boolean] $AllowOrganizationTab, [Parameter()] [System.Boolean] $AllowResourceAccountSendMessage, [Parameter()] [System.Boolean] $AllowScopedPeopleSearchandAccess, [Parameter()] [System.Boolean] $AllowShareFile, [Parameter()] [System.Boolean] $AllowSkypeBusinessInterop, [Parameter()] [System.Boolean] $AllowEgnyte, [Parameter()] [System.String] [ValidateSet('NotRequired', 'RequiredOutsideScheduleMeeting', 'AlwaysRequired')] $ContentPin = 'RequiredOutsideScheduledMeeting', [Parameter()] [System.String] [ValidateSet('NoAccess', 'PartialAccess', 'FullAccess')] $ResourceAccountContentAccess, [Parameter()] [System.String[]] $RestrictedSenderList = $null, [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.String] $CertificateThumbprint, [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 $excludedProperties = @() if ([System.String]::IsNullOrEmpty($RestrictedSenderList)) { $excludedProperties += 'RestrictedSenderList' } $result = Test-M365DSCTargetResource -DesiredValues $PSBoundParameters ` -ResourceName $($MyInvocation.MyCommand.Source).Replace('MSFT_', '') ` -ExcludedProperties $excludedProperties 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()] [Switch] $ManagedIdentity, [Parameter()] [System.String[]] $AccessTokens ) $ConnectionMode = New-M365DSCConnection -Workload 'MicrosoftTeams' ` -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 try { $dscContent = '' $params = @{ Identity = 'Global' Credential = $Credential ApplicationId = $ApplicationId TenantId = $TenantId CertificateThumbprint = $CertificateThumbprint ManagedIdentity = $ManagedIdentity.IsPresent AccessTokens = $AccessTokens } $Script:exportMode = $true $Results = Get-TargetResource @Params if ($Results -is [System.Collections.Hashtable] -and $Results.Count -gt 1) { if ($null -ne $Global:M365DSCExportResourceInstancesCount) { $Global:M365DSCExportResourceInstancesCount++ } $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 } 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 |