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

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 late November 2024. Users must update documentation accordingly.

Details:
Updated November 19, 2024: We have updated the timeline below. 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 late November 2024 (previously early November).

Change Category:
XXXXXXX ... free basic plan only

Scope:
XXXXXXX ... free basic plan only

Release Phase:

Created:
2024-10-15

updated:
2024-11-20

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 inefficiency 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

Documentation Update Requirement
Organizations will need to update their internal documentation to reflect the changes in PowerShell commands, which may lead to temporary disruptions in user support and training.
   - roles: IT Support Staff, 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**

Documentation and Training Update
With the change in how the Help file is loaded, it's crucial to update internal documentation and training materials to reflect the new parameter '-LoadCmdletHelp'. This ensures that IT staff and end-users can effectively utilize the Get-Help cmdlet without confusion.
   - next-steps: Review and update all relevant documentation. Schedule training sessions for IT staff and end-users to familiarize them with the new cmdlet usage.
   - roles: IT Administrators, Support Staff, End Users
   - references: https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell?view=exchange-ps" target="_blank" rel="nofollow noopener noreferrer">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

Resource Optimization
By not loading the Help file by default, organizations can save system resources and improve performance. This is particularly beneficial for environments with limited resources or when running multiple scripts simultaneously.
   - next-steps: Assess current resource usage and performance metrics. Encourage users to adopt the new parameter only when necessary to optimize performance.
   - roles: IT Administrators, System Engineers, DevOps
   - references: https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell?view=exchange-ps" target="_blank" rel="nofollow noopener noreferrer">https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell?view=exchange-ps

Script Maintenance and Review
The change in cmdlet behavior necessitates a review of existing scripts that utilize the Get-Help cmdlet. This is an opportunity to clean up and optimize scripts, ensuring they are compliant with the new version and improving overall script performance.
   - next-steps: Conduct a comprehensive audit of existing PowerShell scripts that interact with Exchange Online. Update scripts to incorporate the new parameter and remove deprecated practices.
   - roles: Developers, IT Administrators, Scripting Teams
   - references: https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell?view=exchange-ps" target="_blank" rel="nofollow noopener noreferrer">https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell?view=exchange-ps

Potentional Risks**

XXXXXXX ... paid membership only

IT Security**

XXXXXXX ... paid membership only

explanation for non-techies**

XXXXXXX ... free basic plan only

** 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-11-20MC MessagesUpdated 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.
Updated November 19, 2024: We have updated the timeline below. 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 late November 2024 (previously early November).
2024-11-20MC Last Updated10/17/2024 01:29:532024-11-20T01:49:55Z
2024-11-20MC SummaryThe 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.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 late November 2024. Users must update documentation accordingly.
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 2 weeks ago

Share to MS Teams

Login to your account

Welcome Back, We Missed You!