Edit

Teams PowerShell Module - Supported Versions

  • Article
  • Applies to:
    Microsoft Teams

Microsoft Teams PowerShell Module (TPM) versions in the 4.x.x series or later are the only versions supported now. All earlier versions are fully retired.

It’s recommended to update to the latest Teams PowerShell Module version.

Important notes

  • Release notes for all the Teams PowerShell Module versions can be found at Teams PowerShell release notes.

  • To update any PowerShell module, you should use the same method used to install the module. For example, if you originally used Install-Module, then you should use Update-Module to get the latest version.

    Update-Module MicrosoftTeams

  • If updating from Teams PowerShell Module version 1.1.6, update your scripts to use Connect-MicrosoftTeams instead of New-CsOnlineSession.

  • During the update, it's suggested to not use TPM 4.x.x/3.x.x alongside versions earlier than 3.0.0. For example, using versions 4.x.x & 2.6.0 together for different admin operations in the same organization isn't recommended.

  • Related changes

    • Updates to Get-CsOnlineUser & Get-CsOnlineVoiceUser in TPM 3.x.x and later – more details in Get-CsOnlineUser & Get-CsOnlineVoiceUser (Message center post – MC340774/MC511150).

    • Changes coming to Phone number assignment - more details in Set-CsUser, Set-CsOnlineVoiceUser, Set-CsOnlineApplicationInstance & Set-CsOnlineVoiceApplicationInstance (Message center post – MC316139).

    • Parameter changes in Get-CsTenant - more details in Get-CsTenant (Message center post – MC365397).

    • If your scripts use New/Set of Policy or Configuration cmdlets with PSListModifier type parameters, it’s recommended to use the latest version (4.2.0 or later). Message center post for reference - MC397428.

    • [New|Get]-CsCloudCallDataConnection cmdlets are now supported from versions 4.6.0 or later (Message center post - MC408993).

    • [New|Remove]-CsHybridTelephoneNumber cmdlets are now supported from versions 4.5.0 or later in GCC High and DoD environments.

  • While using TPM 4.x.x or later, it's recommended to not use any of the deprecated or unsupported cmdlets.

Deprecated cmdlets

  • Following are some of the cmdlets that were deprecated recently. Details on the same can be found in the respective documentations.

    Cmdlets Notes / Suggested alternatives
    Get-CsOnlineVoiceUser Deprecated only in commercial & GCC environments currently
    Get-CsOnlineTelephoneNumber
    Get-CsOnlineDialInConferencingUserInfo & Get-CsOnlineDialInConferencingUserState Get-CsOnlineDialInConferencingUser
    [Enable|Disable]-CsOnlineDialInConferencingUser To enable/disable Audio Conferencing for a user, assign/unassign the Audio Conferencing license, more information at Assign licenses to users
    Get-CsOnlineDirectoryTenant
    New-CsOnlineAudioFile Import-CsOnlineAudioFile
    Get-CsOnlineApplicationEndpoint Get-CsOnlineApplicationInstance
    Set-CsOnlineApplicationEndpoint Set-CsOnlineApplicationInstance, Set-CsPhoneNumberAssignment, Remove-CsPhoneNumberAssignment
    New-CsOnlineApplicationEndpoint New-CsOnlineApplicationInstance
    [Remove|Switch]-CsOnlineApplicationEndpoint
    Get-CsOnlineTelephoneNumberInventoryCities, Get-CsOnlineTelephoneNumberInventoryAreas, Get-CsOnlineTelephoneNumberInventoryCountries, Get-CsOnlineTelephoneNumberInventoryRegions, Get-CsOnlineTelephoneNumberInventoryTypes, [Search|Select]-CsOnlineTelephoneNumberInventory, Get-CsOnlineTelephoneNumberAvailableCount, Clear-CsOnlineTelephoneNumberReservation, Get-CsOnlineTelephoneNumberReservationsInformation, Get-CsOnlineDirectoryTenantNumberCities New-CsOnlineTelephoneNumberOrder
    Set-CsTeamsAppSetupPolicy, New-CsTeamsAppSetupPolicy, Set-CsTeamsAppPermissionPolicy, New-CsTeamsAppPermissionPolicy
    Test-CsOnlineLisCivicAddress The validation checks are incorporated into New-CsOnlineLisCivicAddress

  • Cmdlets that aren't supported/relevant for Microsoft Teams scenarios.

    • [Get|Set]-CsUserPstnSettings
    • [Get|Set|Enable|Disable]-CsMeetingRoom
    • [Grant|Get|Set|New|Remove]-CsConferencingPolicy
    • [Grant|Get|Set|New|Remove]-CsClientPolicy
    • [Grant|Get]-CsHostedVoicemailPolicy
    • [Grant|Get|Set|New|Remove]-CsMobilityPolicy
    • [Grant|Get]-CsVoiceRoutingPolicy
    • [Grant|Get]-CsBroadcastMeetingPolicy
    • [Grant|Get]-CsCloudMeetingPolicy
    • [Grant|Get]-CsGraphPolicy
    • [Grant|Get|Set|New|Remove]-CsExternalUserCommunicationPolicy
    • [Grant|Get|Set]-CsIPPhonePolicy
    • Get-CsUserServicesPolicy
    • [Get|Set]-CsBroadcastMeetingConfiguration
    • [Get|Set]-CsOAuthConfiguration
    • [Get|Set]-CsMeetingConfiguration
    • [Get|Set]-CsTenantHybridConfiguration
    • [Get|Set]-CsPushNotificationConfiguration
    • [Get|Set]-CsUCPhoneConfiguration
    • Get-CsImFilterConfiguration
    • Get-CsAudioConferencingProvider
    • [Get|Set]-CsTenantPublicProvider
    • Get-CsHostingProvider
    • [Get|Set|Register|Unregister]-CsHybridPSTNAppliance
    • [Get|Set|New|Remove]-CsHybridPSTNSite
    • [Get|Set]-CsHybridMediationServer
    • [Get|Set|New|Remove]-CsTenantUpdateTimeWindow
    • Get-CsUserLocationStatus
    • Invoke-CsUcsRollback
    • [Get|Set|New|Remove]-CsTeamsPinnedApp
    • [Get|Set|New|Remove]-CsTenantCatalogApp
    • [Get|Set|New|Remove]-CsGlobalCatalogApp
    • [Get|Set|New|Remove]-CsDefaultCatalogApp
    • [Get|Set|New|Remove]-CsTeamsAppPreset
    • Invoke-CsUserPreferredDataLocationSync
    • [Get|Set]-CsTeamsUpgradeStatus
    • Grant-CsPolicy
    • Set-CsOnlineDirectoryUser

Teams PowerShell release notes

Install Microsoft Teams PowerShell

Manage Teams with Teams PowerShell

Microsoft Teams cmdlet reference

Skype for Business cmdlet reference