We are excited to announce the general availability of the Microsoft Teams PowerShell module. This PowerShell module, first released in Beta last year, allows you to manage the lifecycle of teams within your organization. As a Global Administrator or Teams Service Administrator, you can identify and manage teams on behalf of your users, and make bulk updates to teams faster – including changing memberships or managing team settings. This new version of our module leverages only 1.0 Graph APIs.
Going forward, we will be maintaining both a Preview and Generally Available versions of the Microsoft Teams PowerShell module. This will allow us to deliver new, preview functionality to our customers faster for testing, while ensuring that our Generally Available module continues to leverage only 1.0 APIs.
The following cmdlets are supported in our generally available module:
|
Cmdlet |
Description |
|
https://docs.microsoft.com/en-us/powershell/module/teams/Connect-MicrosoftTeams?view=teams-ps |
Connects an authenticated account to use for Microsoft Teams environment |
|
https://docs.microsoft.com/en-us/powershell/module/teams/Disconnect-MicrosoftTeams?view=teams-ps |
Disconnects from the Microsoft Teams environment |
|
https://docs.microsoft.com/en-us/powershell/module/teams/Get-Team?view=teams-ps |
Retrieves teams with particular properties or information |
|
https://docs.microsoft.com/en-us/powershell/module/teams/Get-TeamChannel?view=teams-ps |
Gets all the channels for a team |
|
https://docs.microsoft.com/en-us/powershell/module/teams/Get-TeamHelp?view=teams-ps |
Provides a list of commands for Microsoft Teams |
|
https://docs.microsoft.com/en-us/powershell/module/teams/Get-TeamUser?view=teams-ps |
Returns the users of a specific team |
|
https://docs.microsoft.com/en-us/powershell/module/teams/New-Team?view=teams-ps |
Provisions a new Team, or converts a group to a team |
|
https://docs.microsoft.com/en-us/powershell/module/teams/New-TeamChannel?view=teams-ps |
Adds a new channel to a team |
|
https://docs.microsoft.com/en-us/powershell/module/teams/Add-TeamUser?view=teams-ps |
Adds an owner or member to the team |
|
https://docs.microsoft.com/en-us/powershell/module/teams/Remove-Team?view=teams-ps |
Deletes a team |
|
https://docs.microsoft.com/en-us/powershell/module/teams/Remove-TeamChannel?view=teams-ps |
Deletes a channel |
|
https://docs.microsoft.com/en-us/powershell/module/teams/Remove-TeamUser?view=teams-ps |
Removes an owner or member from a team |
|
https://docs.microsoft.com/en-us/powershell/module/teams/Set-Team?view=teams-ps |
Updates properties of a team |
|
https://docs.microsoft.com/en-us/powershell/module/teams/Set-TeamChannel?view=teams-ps |
Updates Team channel information |
Additional Functionality in New Release
In addition to leveraging solely 1.0 APIs, we have made a few improvements to cmdlets in the Generally Available module:
Connect-MicrosoftTeams: You can now specify a Teams Government Environment (-TeamsEnvironmentName) that your organization is homed in.
Get-Team: We expanded the filter and selection criteria to include properties such as the Visibility or Archived state of the teams so that you can more easily identify teams that may require your attention
Simplified Experience
To improve the discoverability of certain team settings, we consolidated the functionality of the following cmdlets into the Get-Team and Set-Team cmdlets:
- Get-TeamFunSettings
- Get-TeamGuestSettings
- Get-TeamMemberSettings
- Get-TeamMessagingSettings
- Set-TeamFunSettings
- Set-TeamGuestSettings
- Set-TeamMemberSettings
- Set-TeamMessagingSettings
Note: These beta cmdlets will not be available in future module releases
Want to learn more about PowerShell?
Because Teams is built on top of different services, PowerShell controls for Teams are split across several modules. https://docs.microsoft.com/en-us/MicrosoftTeams/teams-powershell-overview (also includes links to the technical docs for individual cmdlets).
Let us know what you think!
If you have suggestions on how to make Teams better, please submit your idea via https://microsoftteams.uservoice.com/forums/555103-public or vote for existing ideas to help us prioritize the requests. We read every piece of feedback that we receive to make sure that Microsoft Teams meets your needs.
— Christopher Bryan, Microsoft Teams
