External/powershell-scripts
1
0
Fork 0
mirror of https://github.com/admindroid-community/powershell-scripts.git synced 2025-12-17 08:25:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Private Channel Management and Reporting

Browse Source 
Added certificate based authentication support and a few usability enhancements
This commit is contained in:
AdminDroid 2024-11-13 15:34:10 +05:30
parent 1bf08556af
commit 78397007fc
1 changed files with 96 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

203
Microsoft Teams-Private Channel Management/PrivateChannelManagement.ps1
View File

@ -1,11 +1,9 @@
<# <#
============================================================================================= =============================================================================================
Name: PrivateChannelManagement Name: Private Channel Management & Reporting Using PowerShell
Description: This script performs Private Channel related management actions and reporting Description: This script performs Private Channel related management actions and reporting
Version: 1.0 Version: 2.0
Released date: 18/11/2019 Script by: AdminDroid Team
website: blog.admindroid.com
Script by: AdminDroid Team (Proud Creators of AdminDroid Office 365 Reporting Tool)
To run the script To run the script
@ -14,8 +12,20 @@ To run the script
To schdeule/run the script by explicitly mentioning credential To schdeule/run the script by explicitly mentioning credential
./PrivateChannelManagement.ps1 -UserName <UserName> -Password <Password> ./PrivateChannelManagement.ps1 -UserName <UserName> -Password <Password>
To run the script with MFA enabled account To run the script with certificate based authentication
./PrivateChannelManagement.ps1 -MFA ./PrivateChannelManagement.ps1 -TenantId <TenantId> -AppId <AppId> -CertificateThumbPrint <CertThumbPrint>
To run a specific action directly
./PrivateChannelManagement.ps1 -Action 7
Change Log
~~~~~~~~~~
V1.0 (Nov 18, 2019) - File created
V2.0 (Nov 13, 2024) - Added support for certificate-based authentication, removed older PowerShell modules, and a few minor usability enhancements
For detailed script execution steps: https://blog.admindroid.com/managing-private-channels-in-microsoft-teams/
============================================================================================ ============================================================================================
#> #>
@ -23,97 +33,86 @@ To run the script with MFA enabled account
param( param(
[string]$UserName, [string]$UserName,
[string]$Password, [string]$Password,
[switch]$MFA, [string]$TenantId,
[string]$AppId,
[string]$CertificateThumbprint,
[int]$Action [int]$Action
) )
#install latest Microsoft Teams module from PowerShell Test Gallery Function MSTeam_PSModule
$Module=Get-Module -Name MicrosoftTeams -ListAvailable
if($Module.count -eq 0)
{
$Confirm= Read-Host Are you sure you want to install Microsoft Teams module? [Y] Yes [N] No
if($Confirm -match "[y]")
{
Register-PSRepository -Name PSGalleryInt -SourceLocation https://www.poshtestgallery.com/ -InstallationPolicy Trusted
Install-Module -Name MicrosoftTeams -Repository PSGalleryInt -Force
Write-Host Installing Microsoft Teams Module...
}
else
{
Write-Host `nNeed Microsoft Teams PowerShell module. Please install the latest module from PowerShell Test Gallery -ForegroundColor Yellow
exit
}
}
#Check for latest Microsoft Teams PowerShell Module
elseif((Get-module -Name MicrosoftTeams -ListAvailable).version -lt "1.0.18")
{ {
Write-Host `nTo manage Private Channel, you must install lastest version of MicrosoftTeams PowerShell module from PowerShell Test Gallery #Check for MS Teams PowerShell module availability
$Confirm= Read-Host `nAre you sure you want to uninstall old version ? [Y] Yes [N] No $Module=Get-Module -Name MicrosoftTeams -ListAvailable
if($Confirm -match "[y]") if($Module.count -eq 0)
{ {
Uninstall-Module -Name MicrosoftTeams Write-Host MicrosoftTeams module is not available -ForegroundColor yellow
$Confirm= Read-Host Are you sure you want to install module? [Y] Yes [N] No
if($Confirm -match "[yY]")
{
Install-Module MicrosoftTeams -Scope CurrentUser
}
else
{
Write-Host MicrosoftTeams module is required.Please install module using Install-Module MicrosoftTeams cmdlet.
Exit
}
}
Write-Host Connecting to Microsoft Teams... -ForegroundColor Yellow
#Authentication using non-MFA
#Storing credential in script for scheduling purpose/ Passing credential as parameter
if(($UserName -ne "") -and ($Password -ne ""))
{
$SecuredPassword = ConvertTo-SecureString -AsPlainText $Password -Force
$Credential = New-Object System.Management.Automation.PSCredential $UserName,$SecuredPassword
$Team=Connect-MicrosoftTeams -Credential $Credential
}
elseif(($TenantId -ne "") -and ($ClientId -ne "") -and ($CertificateThumbprint -ne ""))
{
$Team=Connect-MicrosoftTeams -TenantId $TenantId -ApplicationId $AppId -CertificateThumbprint $CertificateThumbprint
} }
else else
{ {
Write-Host Please install latest version of Microsoft Teams PowerShell module from PowerShell Test Gallery -ForegroundColor Yellow $Team=Connect-MicrosoftTeams
exit
} }
$Confirm= Read-Host `nAre you sure you want to install latest version of Microsoft Teams module? [Y] Yes [N] No
if($Confirm -match "[y]")
{ #Check for Teams connectivity
Register-PSRepository -Name PSGalleryInt -SourceLocation https://www.poshtestgallery.com/ -InstallationPolicy Trusted If($Team -eq $null)
Install-Module -Name MicrosoftTeams -Repository PSGalleryInt -Force
Write-Host Installing Microsoft Teams Module...
}
else
{ {
Write-Host `nPlease install latest version of Microsoft Teams PowerShell module from PowerShell Test Gallery -ForegroundColor Yellow Write-Host Error occurred while creating Teams session. Please try again -ForegroundColor Red
exit exit
} }
} }
Function Open_Output
{
if((Test-Path -Path $Path) -eq "True")
{
Write-Host `nThe exported report available in: -NoNewline -Foregroundcolor Yellow; Write-Host $ExportCSV
#Check Skype for Business Online module Write-Host `n~~ Script prepared by AdminDroid Community ~~`n -ForegroundColor Green
$Module=Get-Module -Name SkypeOnlineConnector -ListAvailable Write-Host "~~ Check out " -NoNewline -ForegroundColor Green; Write-Host "admindroid.com" -ForegroundColor Yellow -NoNewline; Write-Host " to get access to 1800+ Microsoft 365 reports. ~~" -ForegroundColor Green `n`n
if($Module.count -eq 0)
{ $Prompt = New-Object -ComObject wscript.shell
Write-Host `nPlease install Skype for Business Online PowerShell Module -ForegroundColor yellow $UserInput = $Prompt.popup("Do you want to open output file?",`
Write-Host `nYou can download the Skype Online PowerShell module directly using below url: https://download.microsoft.com/download/2/0/5/2050B39B-4DA5-48E0-B768-583533B42C3B/SkypeOnlinePowerShell.Exe 0,"Open Output File",4)
Write-Host `nAfter installing module, Please close all existing PowerShell sessions. Start new PowerShell console and rerun this script. If ($UserInput -eq 6)
exit {
} Invoke-Item "$Path"
Write-Host Preparing required PowerShell Modules... }
Get-PSSession | Remove-PSSession }
#Authentication using MFA else
if($MFA.IsPresent) {
{ Write-Host No data found.
Write-Host Importing Skype for Business Online PowerShell Module... }
$sfbSession = New-CsOnlineSession }
Import-PSSession $sfbSession -AllowClobber | Out-Null
Write-Host Importing Microsoft Teams PowerShell Module...
Connect-MicrosoftTeams | Out-Null
}
#Authentication using non-MFA MSTeam_PSModule
else $Location=Get-Location
{
#Storing credential in script for scheduling purpose/ Passing credential as parameter
if(($UserName -ne "") -and ($Password -ne ""))
{
$SecuredPassword = ConvertTo-SecureString -AsPlainText $Password -Force
$Credential = New-Object System.Management.Automation.PSCredential $UserName,$SecuredPassword
}
else
{
$Credential=Get-Credential -Credential $null
}
Write-Host Importing Skype for Business Online PowerShell Module...
$sfbSession = New-CsOnlineSession -Credential $Credential
Import-PSSession $sfbSession -AllowClobber -WarningAction SilentlyContinue | Out-Null
Write-Host Importing Microsoft Teams PowerShell Module...
Connect-MicrosoftTeams -Credential $Credential | Out-Null
}
[boolean]$Delay=$false [boolean]$Delay=$false
Do { Do {
if($Action -eq "") if($Action -eq "")
@ -187,7 +186,7 @@ Do {
{ {
New-CsTeamsChannelsPolicy -Identity "Allow Private Channel Creation" -AllowPrivateChannelCreation $True New-CsTeamsChannelsPolicy -Identity "Allow Private Channel Creation" -AllowPrivateChannelCreation $True
} }
Write-Host `nThe file must follow the format: Users"'" UPN separated by new line without header -ForegroundColor Magenta Write-Host `nThe file must follow the format: Users"'" UPN separated by new line -ForegroundColor Magenta
$UserNamesFile=Read-Host Enter CSV/txt file path"(Eg:C:\Users\Desktop\UserNames.txt)" $UserNamesFile=Read-Host Enter CSV/txt file path"(Eg:C:\Users\Desktop\UserNames.txt)"
$Users=@() $Users=@()
$Users=Import-Csv -Header "UserPrincipalName" $UserNamesFile $Users=Import-Csv -Header "UserPrincipalName" $UserNamesFile
@ -223,13 +222,13 @@ Do {
7 { 7 {
$Result="" $Result=""
$Results=@() $Results=@()
$Path="./AllPrivateChannels_$((Get-Date -format yyyy-MMM-dd-ddd` hh-mm` tt).ToString()).csv" $Path="$Location/PrivateChannelsReport_$((Get-Date -format yyyy-MMM-dd-ddd` hh-mm` tt).ToString()).csv"
Write-Host Exporting Private Channels report... Write-Host Exporting Private Channels report...
$Count=0 $Count=0
Get-Team | foreach { Get-Team | foreach {
$TeamName=$_.DisplayName $TeamName=$_.DisplayName
Write-Progress -Activity "`n Processed Teams count: $Count "`n" Currently Processing: $TeamName"
$Count++ $Count++
Write-Progress -Activity "`n Processed Teams count: $Count "`n" Currently Processing: $TeamName"
$GroupId=$_.GroupId $GroupId=$_.GroupId
$PrivateChannels=(Get-TeamChannel -GroupId $GroupId -MembershipType Private).DisplayName $PrivateChannels=(Get-TeamChannel -GroupId $GroupId -MembershipType Private).DisplayName
foreach($PrivateChannel in $PrivateChannels) foreach($PrivateChannel in $PrivateChannels)
@ -240,22 +239,16 @@ Do {
} }
} }
Write-Progress -Activity "`n Processed Teams count: $Count "`n" Currently Processing: $TeamName" -Completed Write-Progress -Activity "`n Processed Teams count: $Count "`n" Currently Processing: $TeamName" -Completed
if((Test-Path -Path $Path) -eq "True") Open_Output
{
Write-Host `nReport available in $Path -ForegroundColor Green
}
} }
8 { 8 {
$TeamName=Read-Host Enter Teams name "(Case Sensitive)": $TeamName=Read-Host Enter Teams name "(Case Sensitive)":
Write-Host Exporting Private Channel report... Write-Host Exporting Private Channel report...
$GroupId=(Get-Team -DisplayName $TeamName).GroupId $GroupId=(Get-Team -DisplayName $TeamName).GroupId
$Path=".\Private Channels available in $TeamName$((Get-Date -format yyyy-MMM-dd-ddd` hh-mm` tt).ToString()).csv" $Path="$Location\Private Channels available in $TeamName$((Get-Date -format yyyy-MMM-dd-ddd` hh-mm` tt).ToString()).csv"
Get-TeamChannel -GroupId $GroupId -MembershipType Private | select DisplayName | Export-Csv $Path -NoTypeInformation Get-TeamChannel -GroupId $GroupId -MembershipType Private | select DisplayName | Export-Csv $Path -NoTypeInformation
if((Test-Path -Path $Path) -eq "True") Open_Output
{
Write-Host `nReport available in $Path -ForegroundColor Green
}
} }
9{ 9{
@ -263,15 +256,15 @@ Do {
$Results=@() $Results=@()
Write-Host Exporting all Private Channel"'s" Members and Owners report... Write-Host Exporting all Private Channel"'s" Members and Owners report...
$Count=0 $Count=0
$Path="./AllPrivateChannels Members and Owners Report_$((Get-Date -format yyyy-MMM-dd-ddd` hh-mm` tt).ToString()).csv" $Path="$Location/AllPrivateChannels Members and Owners Report_$((Get-Date -format yyyy-MMM-dd-ddd` hh-mm` tt).ToString()).csv"
Get-Team | foreach { Get-Team | foreach {
$TeamName=$_.DisplayName $TeamName=$_.DisplayName
$GroupId=$_.GroupId $GroupId=$_.GroupId
$PrivateChannels=(Get-TeamChannel -GroupId $GroupId -MembershipType Private).DisplayName $PrivateChannels=(Get-TeamChannel -GroupId $GroupId -MembershipType Private).DisplayName
foreach($PrivateChannel in $PrivateChannels) foreach($PrivateChannel in $PrivateChannels)
{ {
Write-Progress -Activity "`n Processed Private Channel count: $Count "`n" Currently Processing: $PrivateChannel"
$Count++ $Count++
Write-Progress -Activity "`n Processed Private Channel count: $Count "`n" Currently Processing: $PrivateChannel"
Get-TeamChannelUser -GroupId $GroupId -DisplayName $PrivateChannel | foreach { Get-TeamChannelUser -GroupId $GroupId -DisplayName $PrivateChannel | foreach {
$Name=$_.Name $Name=$_.Name
$UPN=$_.User $UPN=$_.User
@ -283,10 +276,7 @@ Do {
} }
} }
Write-Progress -Activity "`n Processed Private Channel count: $Count "`n" Currently Processing: $PrivateChannel" -Completed Write-Progress -Activity "`n Processed Private Channel count: $Count "`n" Currently Processing: $PrivateChannel" -Completed
if((Test-Path -Path $Path) -eq "True") Open_Output
{
Write-Host `nReport available in $Path -ForegroundColor Green
}
} }
10 { 10 {
@ -296,7 +286,7 @@ Do {
$ChannelName=Read-Host Enter Private Channel name $ChannelName=Read-Host Enter Private Channel name
$GroupId=(Get-Team -DisplayName $TeamName).GroupId $GroupId=(Get-Team -DisplayName $TeamName).GroupId
Write-Host Exporting $ChannelName"'s" Members and Owners report... Write-Host Exporting $ChannelName"'s" Members and Owners report...
$Path=".\MembersOf $ChannelName$((Get-Date -format yyyy-MMM-dd-ddd` hh-mm` tt).ToString()).csv" $Path="$Location\MembersOf $ChannelName$((Get-Date -format yyyy-MMM-dd-ddd` hh-mm` tt).ToString()).csv"
Get-TeamChannelUser -GroupId $GroupId -DisplayName $ChannelName | foreach { Get-TeamChannelUser -GroupId $GroupId -DisplayName $ChannelName | foreach {
$Name=$_.Name $Name=$_.Name
$UPN=$_.User $UPN=$_.User
@ -305,15 +295,14 @@ Do {
$Results= New-Object psobject -Property $Result $Results= New-Object psobject -Property $Result
$Results | select 'Teams Name','Private Channel Name',UPN,'User Display Name',Role | Export-Csv $Path -NoTypeInformation -Append $Results | select 'Teams Name','Private Channel Name',UPN,'User Display Name',Role | Export-Csv $Path -NoTypeInformation -Append
} }
if((Test-Path -Path $Path) -eq "True") Open_Output
{
Write-Host `nReport available in $Path -ForegroundColor Green
}
} }
} }
if($Action -ne "") if($Action -ne "")
{exit} {exit}
} }
While ($i -ne 0) While ($i -ne 0)
Clear-Host