Teamsのチームやチャネルで、ユーザーの追加や削除をどのように処理していますか?
少人数ならTeamsのクライアントアプリによるGUI操作でも良いですが、数十人単位になってくると非常に煩わしいものです。
コマンド操作で簡単に処理しましょう。
- はじめに
- Teams環境に接続する
- チームのIDを取得する
- チャネルの表示名を取得する
- チームにユーザーアカウントを追加/削除する
- チャネルにユーザーアカウントを追加/削除する
- チャネルを追加/削除する
- 接続を終了する
- おわりに
はじめに
コマンド操作するために必要なモジュールが組み込まれているか確認してください。
Windows PowerShellアプリを開き、以下コマンドを実行します。
Get-Module -Name MicrosoftTeams -ListAvailable | Select Name,Version
出力があればモジュールはインストール済みです。
何も出力がない場合は、以下コマンドでモジュールをインストールします。
Install-Module -Name MicrosoftTeams -RequiredVersion 5.2.0 -Scope CurrentUser
確認を求められるので、「Y」を選択して処理を進めます。
処理が完了すれば、現在操作しているユーザーアカウントに対して、MicrosoftTeams管理シェルがインストールされます。
念のため、最初に実行したGet-Moduleコマンドを実行して確認してください。
これでコマンド操作の準備が完了しました。
Teams環境に接続する
以下コマンドを実行し、Teams環境に接続します。
Connect-MicrosoftTeams
ウィンドウが開き、アカウント情報の入力を求められます。
サインインが成功すると接続できます。
チームのIDを取得する
Teamsのチームに対して操作をするには、チームのIDが必要になります。
Get-Teamコマンドで確認します。
オプションなしではエラー出力されるので、範囲指定が必要です。
私は、ユーザー名(メールアドレス)で絞り込む方法で対応しています。
Get-Team -User <メールアドレス>
他にチームの表示名やアーカイブの有無、プライバシー設定などで範囲指定することができます。
出力結果から目的のチームのGroupIDを控えてください。
参考:Get-Team (MicrosoftTeamsPowerShell) | Microsoft Learn
チャネルの表示名を取得する
チーム中のチャネルに対して操作をする場合、チャネルの表示名が必要になります。
以下コマンドで、チームのIDをオプション指定し実行します。
Get-TeamChannel -GroupId <チームのID>
出力結果から目的のチャネルのDisplayNameを控えてください。
(Idではありません)
チームにユーザーアカウントを追加/削除する
チームのIDを控えていることが前提です。
ユーザーアカウントの追加は、以下コマンドを実行します。
Add-TeamUser -GroupId <チームのID> -User <メールアドレス>
-Roleオプションで役割を付与することもできます。
-Role owner とすれば所有者役割を付与します。
-Roleオプションを省略した場合は、memberが割り当てされます。
ユーザーアカウントの削除は、以下コマンドになります。
Remove-TeamUser -GroupId <チームのID> -User <メールアドレス>
オプションの構成は追加時と変わりありません。
チャネルにユーザーアカウントを追加/削除する
チームのIDとチャネルの表示名を控えていることが前提です。
ユーザーアカウントの追加は、以下コマンドを実行します。
Add-TeamChannelUser -GroupId <チームのID> -DisplayName <チャネルの表示名> -User <メールアドレス>
このコマンドを利用するのは、Get-TeamChannelコマンド実行時のMemberShipTypeがPrivate(プライベート)もしくはShared(共有)のチャネルの場合かと思います。
削除する場合は、Remove-TeamChannelUserコマンドです。
必須オプションは、Add-TeamChannelUserコマンドと同じになります。
チャネルを追加/削除する
チームのIDとチャネルの表示名を控えていることが前提です。
チャネルの追加は、以下コマンドを実行します。
New-TeamChannel -GroupId <チームのID> -DisplayName <チャネルの表示名>
-MembershipType オプションで標準、プライベート、パブリックの指定ができます。
オプションの値は、「Standard」「Shared,」「Private」のいずれかを指定します。
チャネルの削除は以下コマンドを実行します。
Remove-TeamChannel -GroupId <チームのID> -DisplayName <チャネルの表示名>
接続を終了する
作業が終了した後は、以下コマンドで接続を切ります。
Disconnect-MicrosoftTeams
おわりに
コマンドでTeamsを操作する方法でした。
他のコマンドについては以下から確認可能です。
https://learn.microsoft.com/ja-jp/powershell/module/teams/?view=teams-ps