ExchangeOnlineManagement

2.0.3

This is a General Availability (GA) release of Exchange Online PowerShell V2 module.
Please check the documentation here - https://aka.ms/exops-docs.
For issues related to the module, contact Microsoft support.

Minimum PowerShell version

3.0

There is a newer prerelease version of this module available.
See the version list below for details.

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name ExchangeOnlineManagement -RequiredVersion 2.0.3

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name ExchangeOnlineManagement -Version 2.0.3

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Copyright

(c) 2020 Microsoft. All rights reserved.

Package Details

Author(s)

  • Microsoft Corporation

Tags

Exchange ExchangeOnline EXO EXOV2 Mailbox Management

Cmdlets

Get-EXOCasMailbox Get-EXOMailbox Get-EXOMailboxFolderPermission Get-EXOMailboxFolderStatistics Get-EXOMailboxPermission Get-EXOMailboxStatistics Get-EXOMobileDeviceStatistics Get-EXORecipient Get-EXORecipientPermission Get-UserBriefingConfig Set-UserBriefingConfig

Functions

Connect-ExchangeOnline Connect-IPPSSession Disconnect-ExchangeOnline

Dependencies

This module has no dependencies.

Release Notes


---------------------------------------------------------------------------------------------
Whats new in this release:
v2.0.3 :
   1. General availability of Certificate Based Authentication feature which enables using Modern Authentication in Unattended Scripting or background automation scenarios.
   2. Certificate Based Authentication accepts Certificate File directly from terminal thus enabling certificate files to be stored in Azure Key Vault and being fetched Just-In-Time for enhanced security. See parameter Certificate in Connect-ExchangeOnline.
   3. Connect with Exchange Online and Security Compliance Center simultaneously in a single PowerShell window.
   4. Ability to restrict the PowerShell cmdlets imported in a session using CommandName parameter, thus reducing memory footprint in case of high usage PowerShell applications.
   5. Get-ExoMailboxFolderPermission now supports ExternalDirectoryObjectID in the Identity parameter.
   6. Optimized latency of first V2 Cmdlet call. (Lab results show first call latency has been reduced from 8 seconds to ~1 seconds. Actual results will depend on result size and Tenant environment.)

---------------------------------------------------------------------------------------------
Previous Releases:

v2.0.1 :
   1. Support for App-Only Authentication -
       Automate your day-to-day exchange management tasks using app-only authentication. This requires setting up an Azure AD app and connecting to Exchange using certificate. Check out https://aka.ms/AzureAD-app for setting up the App and initial onboarding experience.
       Use below syntax for establishing the connection -
           Connect-ExchangeOnline -AppID '<AppId of client ID of the AAD app>' -Organization 'contoso.onmicrosoft.com' -CertificateFilePath '<Full path of the certificate>' -CertificatePassword '<a secure string password if the certificate file is encrypted>'

v1.0.1 :
   1. This is the General Availability (GA) version of EXO PowerShell V2 Module. It is stable and ready for being used in production environments.
   2. Get-ExoMobileDeviceStatistics cmdlet now supports Identity parameter.
   3. Improved reliability of session auto-connect in certain cases where script was executing for ~50minutes and threw "Cmdlet not found" error due to a bug in auto-reconnect logic.
   4. Fixed data-type issues of two commonly used attributed "User" and "MailboxFolderUser" for easy migration of scripts.
   5. Enhanced support for filters as it now supports 4 more operators - endswith, contains, not and notlike support. Please check online documentation for attributes which are not supported in filter string.

v0.4578.0 :
   1. Added support for configuring Briefing Email for your organization at the user level with "Set-UserBriefingConfig" and "Get-UserBriefingConfig" cmdlets.
   2. Support for session cleanup using Disconnect-ExchangeOnline cmdlet. This cmdlet is V2 equivalent of "Get-PSSession | Remove-PSSession". In addition to cleaning up session object and local files, it also removes access token from cache which is used for authenticating against V2 cmdlets.
   3. You can now use FolderId as identity parameter in Get-ExoMailboxFolderPermission. You can get folderId using Get-MailboxFolder cmdlet. Below are the supported syntax for getting folder permissions -
       a. Get-MailboxFolderPermission -Identity <UPN>:<Folder-Path>
       b. Get-MailboxFolderPermission -Identity <UPN>:\<Folder-Id>
   4. Improved reliability of Get-ExoMailboxStatistics cmdlet as certain request routing errors which led to failures have been resolved
   5. Optimized memory usage when session is created by re-using any existing module with a new session instead of creating a new one every time session is imported

v0.4368.1 :
   1. Added support for Exchange Online Protection (EOP) cmdlets using 'Connect-IPPSSession' cmdlet
   2. Hide announcement banner using 'ShowBanner' switch. Default value of this switch is $true. Use below syntax to hide the banner
       "Connect-ExchangeOnline -ShowBanner:$false"
   3. Terminate cmdlet execution on client exception
   4. RPS contained various Complex data types which was consciously not supported in EXO cmdlets for improving the performance. Differences in non-complex Data-types between RPS cmdlets and V2 cmdlets has been resolved to allow seamless migration of management scripts.

v0.3582.0 :
   1. Support for prefix during session creation
       i. You can create only 1 session at a time which can have prefixed cmdlets.
      ii. Note that the EXO V2 cmdlets will not be prefixed as they already have a prefix 'EXO' and hence please refrain from using 'EXO' as a prefix during session creation.
   2. Use EXO V2 cmdlets even if WinRM Basic Auth is disabled on client machine
   3. Identity parameter for V2 cmdlets now supports name and alias as well
       i. Please note that using alias or name slows down the performance of V2 cmdlets and hence it is not recommended to use this option
   4. Fixed issue where data-type of attributes returned by V2 cmdlet was different from Remote PowerShell cmdlets
   5. Fixed bug - Frequent sessions reconnects issue when Connect-ExchangeOnline was invoked with Credentials or UserPrincipalName

v0.3555.1 :
   1. Bug fixes and enhancements.

v0.3527.4 :
   1. Updated Get-Help.

v0.3527.3 :
   1. Added support for managing Exchange for a different tenant using delegation flow.
       Read more here: https://docs.microsoft.com/en-in/powershell/module/exchange/powershell-v2-module/connect-exchangeonline?view=exchange-ps#parameters
   2. Works in tandem with other PowerShell modules in a single PS window
   3. Added support for positional parameters
   4. Date Time field now supports client locale
   5. Fixed Bug : PSCredential getting empty when passed during Connect-ExchangeOnline
   6. Fixed Bug : Client module used to throw error when filter contained $null
   7. Sessions created internal to EXO V2 Module will now have names (Naming pattern : ExchangeOnlineInternalSession_%SomeNumber% )
   8. Fixed Bug : Remote PowerShell cmdlets resulting into intermittent failure due to difference of time between token expiry and PSSession getting Idle.
   9. Major security update
   10. Bug fixes and enhancements
---------------------------------------------------------------------------------------------

FileList

Version History

Version Downloads Last updated
3.4.2-Preview1 7,325 3/4/2024
3.4.1-Preview1 9,965 12/12/2023
3.4.0 7,187,657 10/10/2023
3.4.0-Preview1 1,878 9/25/2023
3.3.1-Preview1 765 9/18/2023
3.3.0 1,609,038 9/7/2023
3.3.0-Preview1 3,924 8/4/2023
3.2.0 1,531,161 6/21/2023
3.2.0-Preview4 4,547 5/26/2023
3.2.0-Preview3 5,050 4/28/2023
3.2.0-Preview2 4,729 3/20/2023
3.2.0-Preview1 2,891 2/27/2023
3.1.0 2,067,647 1/9/2023
3.1.0-Preview2 1,838 12/19/2022
3.1.0-Preview1 1,484 12/5/2022
3.0.1-Preview1 1,755 11/14/2022
3.0.0 7,440,480 9/19/2022
2.0.6-Preview8 4,075 9/9/2022
2.0.6-Preview7 1,580,290 8/13/2022
2.0.6-Preview6 49,740 5/20/2022
2.0.6-Preview5 49,723 3/17/2022
2.0.6-preview4 3,380 1/13/2022
2.0.6-Preview3 11,806 10/20/2021
2.0.5 7,173,468 5/11/2021
2.0.5-Preview2 637 4/30/2021
2.0.5-Preview1 949 4/21/2021
2.0.4 530,322 2/5/2021
2.0.4-Preview9 2,054 1/19/2021
2.0.4-Preview8 257 1/4/2021
2.0.4-Preview6 23,280 11/6/2020
2.0.4-Preview2 106,165 9/22/2020
2.0.3 (current version) 526,118 9/21/2020
2.0.3-Preview 8,843 6/30/2020
1.0.1 260,702 6/3/2020
0.4578.0 518,569 4/16/2020
0.4368.1 23,396 3/30/2020
0.3582.0 39,353 2/10/2020
0.3555.1 13,888 1/22/2020
0.3374.11 11,975 1/15/2020
0.3374.10 5,478 12/27/2019
0.3374.9 17,585 11/26/2019
0.3374.4 7,731 10/31/2019
0.3374.1 818 10/25/2019
0.3374.0 631 10/22/2019
Show less