Test-DbaKerberos - Update documentation and examples, release from pipeline earlier #10071
+415
−395
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.
This pull request updates the
Test-DbaKerberosPowerShell function to improve its documentation, clarify its parameter usage, and refactor how check results are handled internally. The main changes include more detailed and accurate descriptions in the function's help section, updated usage examples, the removal of the-Detailedparameter, and a refactor to return check results directly instead of accumulating them in an array.Documentation and Usability Improvements:
.SYNOPSISand.DESCRIPTIONsections to accurately describe the number and categories of checks performed, clarify the output structure, and specify behavior when using-ComputerNameversus-SqlInstance..EXAMPLEsection to show more realistic usage scenarios, including credential handling and output filtering, and added new examples for result formatting and filtering by category.Parameter and Output Changes:
-Detailedparameter, simplifying the parameter list and focusing on structured output rather than verbose diagnostics.-Credentialparameter and its role in Active Directory and WinRM connections. [1] [2]Code Structure and Result Handling:
[PSCustomObject]directly, rather than adding it to an internal array, streamlining the output and improving pipeline compatibility. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]These updates make the function easier to use, provide clearer guidance to users, and improve the integration of results into PowerShell pipelines.