MC910986 – (Updated) Microsoft Exchange Online: Optional Help file parameter in Microsoft PowerShell will change

Microsoft Exchange Logo

check before: 2024-11-01

Product:

Exchange

Platform:

Online, World tenant

Status:

Change type:

Admin impact, Feature update, Updated message

Links:

Details:

Summary:
The message details changes in Microsoft Exchange Online PowerShell V3.7, where the Help file will not load by default, and a new parameter '-LoadCmdletHelp' will be needed to use 'Get-Help'. This update will be globally available in early November 2024. Users must update documentation accordingly.

Details:
Updated October 16, 2024: We have updated the content. Thank you for your patience.
In Exchange Online PowerShell (EXO) V3.0, we introduced the Connect-ExchangeOnline cmdlet to connect to the Microsoft Exchange Online environment through Microsoft PowerShell, which loads the help file by default. This help file is required for running the Get-Help cmdlet. However, not many customers used the Get-Help cmdlet. In EXO V3.3, we added the -SkipLoadingCmdletHelp parameter. When -SkipLoadingCmdletHelp is used with Connect-ExchangeOnline, help files do not load the on the customer system, which saves resources.
However, starting with EXO V3.7, we are changing this default behavior. The Help file will not be loaded by default, and a new parameter -LoadCmdletHelp will be required to load the cmdlet help and use the Get-Help cmdlet. To avoid breaking existing scripts, the -SkipLoadingCmdletHelp parameter will continue exist, but will not function.
[When this will happen:]
General Availability (Worldwide): The changes will be available in EXO V3.7 (the next release of our EXO V3 module) in early November 2024.

Change Category:
XXXXXXX ... free basic plan only

Scope:
XXXXXXX ... free basic plan only

Release Phase:

Created:
2024-10-15

updated:
2024-10-17

Task Type

XXXXXXX ... free basic plan only

Docu to Check

XXXXXXX ... free basic plan only

MS How does it affect me

XXXXXXX ... free basic plan only

MS Preperations

XXXXXXX ... free basic plan only

MS Urgency

XXXXXXX ... free basic plan only

MS workload name

XXXXXXX ... free basic plan only

summary for non-techies**

XXXXXXX ... free basic plan only

Direct effects for Operations**

Change in Help File Loading Behavior
The Help file will not load by default, requiring users to use the new parameter '-LoadCmdletHelp' to access help documentation, potentially leading to confusion and errors in script execution.
   - roles: IT Administrators, PowerShell Users
   - references: https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell?view=exchange-ps, https://learn.microsoft.com/powershell/module/microsoft.powershell.core/get-help?view=powershell-7.4

Script Compatibility Issues
Existing scripts that rely on the automatic loading of help files may fail or produce errors, impacting automation processes and user productivity.
   - roles: IT Administrators, Developers
   - references: https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell?view=exchange-ps, https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.6.0

Need for Documentation Updates
Organizations will need to update their internal documentation and notify users about the changes, which may lead to temporary disruptions in workflow and user experience.
   - roles: IT Administrators, End Users
   - references: https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell?view=exchange-ps, https://learn.microsoft.com/powershell/module/microsoft.powershell.core/get-help?view=powershell-7.4

Configutation Options**

XXXXXXX ... paid membership only

Opportunities**

XXXXXXX ... free basic plan only

Potentional Risks**

XXXXXXX ... paid membership only

IT Security**

XXXXXXX ... paid membership only

explanation for non-techies**

In the world of Microsoft Exchange Online, a small but significant change is coming to how help files are accessed in PowerShell. Imagine you're at a library where you can either have a guidebook with you at all times or choose to leave it on the shelf to save space in your bag. Previously, when you connected to Exchange Online using PowerShell, it was like automatically having that guidebook with you. This guidebook, or help file, was always loaded by default, ready to assist if you needed to look up information using the Get-Help command.

However, not everyone found themselves needing the guidebook, and carrying it around consumed resources. So, a while back, Microsoft introduced an option to leave the guidebook on the shelf unless you specifically asked for it. This was done through a parameter called -SkipLoadingCmdletHelp, which allowed users to connect without loading the help files, thus saving resources.

Now, with the upcoming version 3.7 of Exchange Online PowerShell, Microsoft is flipping the default setting. By default, the guidebook will stay on the shelf, and if you want to use it, you'll need to ask for it explicitly using a new parameter called -LoadCmdletHelp. This means that if you want to use the Get-Help command, you'll need to remember to include this new parameter when you connect.

This change is like switching from automatically carrying the guidebook to having to request it when you need it. It's a small adjustment, but one that requires users to update their habits and any scripts they use to ensure they still have access to the help they need.

For those using older versions of the Exchange Online module, nothing changes. But for those upgrading to version 3.7, it's important to be aware of this shift and prepare accordingly. The rollout will happen automatically, so it's a good idea to review your current setup and notify users about this change. Just like updating a library's catalog, updating your documentation to reflect this new parameter will help keep everything running smoothly.

** AI generated content. This information must be reviewed before use.

a free basic plan is required to see more details. Sign up here


A cloudsocut.one plan is required to see all the changed details. If you are already a customer, choose login.
If you are new to cloudscout.one please choose a plan.



change history

DatePropertyoldnew
2024-10-17MC MessagesIn Exchange Online PowerShell (EXO) V3.0, we introduced the Connect-ExchangeOnline cmdlet to connect to the Microsoft Exchange Online environment through Microsoft PowerShell, which loads the help file by default. This help file is required for running the Get-Help cmdlet. However, not many customers used the Get-Help cmdlet. In EXO V3.3, we added the -SkipLoadingCmldteHelp parameter. When -SkipLoadingCmldteHelp is used with Connect-ExchangeOnline, help files do not load the on the customer system, which saves resources.
However, starting with EXO V3.7, we are changing this default behavior. The Help file will not be loaded by default, and a new parameter -LoadCmdletHelp will be required to load the cmdlet help and use the Get-Help cmdlet. To avoid breaking existing scripts, the -SkipLoadingCmldteHelp parameter will continue exist, but will not function.
[When this will happen:]
General Availability (Worldwide): The changes will be available in EXO V3.7 (the next release of our EXO V3 module) in early November 2024.
Updated October 16, 2024: We have updated the content. Thank you for your patience.
In Exchange Online PowerShell (EXO) V3.0, we introduced the Connect-ExchangeOnline cmdlet to connect to the Microsoft Exchange Online environment through Microsoft PowerShell, which loads the help file by default. This help file is required for running the Get-Help cmdlet. However, not many customers used the Get-Help cmdlet. In EXO V3.3, we added the -SkipLoadingCmdletHelp parameter. When -SkipLoadingCmdletHelp is used with Connect-ExchangeOnline, help files do not load the on the customer system, which saves resources.
However, starting with EXO V3.7, we are changing this default behavior. The Help file will not be loaded by default, and a new parameter -LoadCmdletHelp will be required to load the cmdlet help and use the Get-Help cmdlet. To avoid breaking existing scripts, the -SkipLoadingCmdletHelp parameter will continue exist, but will not function.
[When this will happen:]
General Availability (Worldwide): The changes will be available in EXO V3.7 (the next release of our EXO V3 module) in early November 2024.
2024-10-17MC TitleMicrosoft Exchange Online: Optional Help file parameter in Microsoft PowerShell will change(Updated) Microsoft Exchange Online: Optional Help file parameter in Microsoft PowerShell will change
2024-10-17MC Last Updated10/15/2024 00:58:202024-10-17T01:29:53Z
2024-10-17MC MessageTagNamesFeature update, Admin impactUpdated message, Feature update, Admin impact
2024-10-17MC SummaryIn Exchange Online PowerShell V3.7, the Help file will not load by default, and a new parameter, `-LoadCmdletHelp`, is required to use `Get-Help`. The `-SkipLoadingCmldteHelp` parameter will remain but won't function. These changes take effect in early November 2024 and apply only to customers upgrading to EXO module version 3.7.0.The message details changes in Microsoft Exchange Online PowerShell V3.7, where the Help file will not load by default, and a new parameter '-LoadCmdletHelp' will be needed to use 'Get-Help'. This update will be globally available in early November 2024. Users must update documentation accordingly.

Last updated 3 weeks ago

Share to MS Teams

Login to your account

Welcome Back, We Missed You!