UpdaDocs: Added prerequisites (PS7+, EXO V3) and hybrid usage example…#2519
Open
cliffordodendaal wants to merge 1 commit intomicrosoft:mainfrom
Open
UpdaDocs: Added prerequisites (PS7+, EXO V3) and hybrid usage example…#2519cliffordodendaal wants to merge 1 commit intomicrosoft:mainfrom
cliffordodendaal wants to merge 1 commit intomicrosoft:mainfrom
Conversation
… to FreeBusyChecker.ps1te FreeBusyChecker.ps1 Improved documentation in FreeBusyChecker.ps1 by clarifying prerequisites (PowerShell 7+, Exchange Online PowerShell V3 module) and adding a hybrid usage example for admins running OAuth checks in hybrid environments.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
… to FreeBusyChecker.ps1te FreeBusyChecker.ps1
Improved documentation in FreeBusyChecker.ps1 by clarifying prerequisites (PowerShell 7+, Exchange Online PowerShell V3 module) and adding a hybrid usage example for admins running OAuth checks in hybrid environments.
Issue:
The FreeBusyChecker.ps1 script header did not clearly state that PowerShell 7+ and the Exchange Online PowerShell V3 module are required to run successfully. Additionally, there was no example provided for hybrid administrators showing how to connect to Exchange Online before running the script with specific parameters. This lack of clarity could cause confusion or failed runs for admins who are new to the tool or working in hybrid environments.
Reason:
The change was made to improve clarity and usability of the FreeBusyChecker.ps1 script. By explicitly listing prerequisites (PowerShell 7+ and the Exchange Online PowerShell V3 module), administrators will know the required environment before running the script. Adding a hybrid usage example helps admins working in hybrid Exchange deployments understand the correct sequence of connecting to Exchange Online and running the script with parameters. These updates reduce confusion, prevent failed runs, and make the script more accessible to both new and experienced Exchange admins.
Fix:
Updated the FreeBusyChecker.ps1 script header to include a "Prerequisites" section that specifies PowerShell 7+ and the Exchange Online PowerShell V3 module as required. Added a hybrid usage example under the .EXAMPLE section to demonstrate the correct workflow for administrators in hybrid environments (connecting to Exchange Online with the EO prefix, then running the script with -Org ExchangeOnPremise -Auth OAuth). These changes improve clarity and usability without altering the script’s core functionality.
Validation:
The documentation changes were reviewed to ensure accuracy and alignment with the existing Quick Start guide and Exchange Online PowerShell V3 module requirements. The hybrid usage example was tested in a lab environment by first connecting to Exchange Online with the EO prefix and then running the script using -Org ExchangeOnPremise -Auth OAuth. The script executed successfully, confirming that the added example reflects the correct workflow. Since the update is documentation-only, no functional changes to the script logic were introduced.