Merge pull request #183 from maester365/create-pull-request/patch

Update maester.dev powershell docs
maester365 · Jun 1, 2024 · 977c873 · 977c873
2 parents 49a456d + f32822c
commit 977c873
Show file tree

Hide file tree

Showing 6 changed files with 188 additions and 12 deletions.
diff --git a/website/docs/commands/Compare-MtTestResult.mdx b/website/docs/commands/Compare-MtTestResult.mdx
@@ -0,0 +1,129 @@
+---
+sidebar_class_name: hidden
+description: Compares Maester test result JSON files
+id: Compare-MtTestResult
+title: Compare-MtTestResult
+hide_title: false
+hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Compare-MtTestResult.ps1
+---
+
+## SYNOPSIS
+
+Compares Maester test result JSON files
+
+## SYNTAX
+
+### Directory
+
+```powershell
+Compare-MtTestResult [-BaseDir] <Object> [-ProgressAction <ActionPreference>] [<CommonParameters>]
+```
+
+### Files
+
+```powershell
+Compare-MtTestResult [-PriorTest] <Object> [-NewTest] <Object> [-ProgressAction <ActionPreference>]
+ [<CommonParameters>]
+```
+
+## DESCRIPTION
+
+Will compare the most recent two test result JSON outputs from prior Invoke-Maester
+runs, or will accept any two test result JSON files and provide the tests that have changed.
+
+## EXAMPLES
+
+### EXAMPLE 1
+
+```powershell
+Compare-MtTestResult -BaseDir .\test-results
+```
+
+### EXAMPLE 2
+
+```powershell
+$tests = @{
+    NewTest   = (Get-Content .\test-results\TestResults-2024-05-21-182925.json | ConvertFrom-Json)
+    PriorTest = (Get-Content .\test-results\TestResults-2024-05-20-182925.json | ConvertFrom-Json)
+}
+Compare-MtTestResult @tests
+```
+
+## PARAMETERS
+
+### -BaseDir
+
+\{\{ Fill BaseDir Description \}\}
+
+```yaml
+Type: Object
+Parameter Sets: Directory
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -PriorTest
+
+\{\{ Fill PriorTest Description \}\}
+
+```yaml
+Type: Object
+Parameter Sets: Files
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -NewTest
+
+\{\{ Fill NewTest Description \}\}
+
+```yaml
+Type: Object
+Parameter Sets: Files
+Aliases:
+
+Required: True
+Position: 2
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ProgressAction
+
+\{\{ Fill ProgressAction Description \}\}
+
+```yaml
+Type: ActionPreference
+Parameter Sets: (All)
+Aliases: proga
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+## OUTPUTS
+
+## NOTES
+
+## RELATED LINKS
diff --git a/website/docs/commands/Get-MtRoleMember.mdx b/website/docs/commands/Get-MtRoleMember.mdx
@@ -14,9 +14,22 @@ Returns all the members of a role.
 
 ## SYNTAX
 
+### Eligible
+
+```powershell
+Get-MtRoleMember [-roleId] <Guid> [-Eligible] [-ProgressAction <ActionPreference>] [<CommonParameters>]
+```
+
+### Active
+
+```powershell
+Get-MtRoleMember [-roleId] <Guid> [-Active] [-ProgressAction <ActionPreference>] [<CommonParameters>]
+```
+
+### All
+
 ```powershell
-Get-MtRoleMember [-roleId] <Guid> [-Eligible] [-Active] [-All] [-ProgressAction <ActionPreference>]
- [<CommonParameters>]
+Get-MtRoleMember [-roleId] <Guid> [-All] [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -55,10 +68,10 @@ Accept wildcard characters: False
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: (All)
+Parameter Sets: Eligible
 Aliases:
 
-Required: False
+Required: True
 Position: Named
 Default value: False
 Accept pipeline input: False
@@ -71,10 +84,10 @@ Accept wildcard characters: False
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: (All)
+Parameter Sets: Active
 Aliases:
 
-Required: False
+Required: True
 Position: Named
 Default value: False
 Accept pipeline input: False
@@ -87,10 +100,10 @@ Accept wildcard characters: False
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: (All)
+Parameter Sets: All
 Aliases:
 
-Required: False
+Required: True
 Position: Named
 Default value: False
 Accept pipeline input: False

diff --git a/website/docs/commands/Test-MtCisaManagedDevice.mdx b/website/docs/commands/Test-MtCisaManagedDevice.mdx
@@ -15,7 +15,7 @@ Checks if Conditional Access Policy requiring managed device is enabled
 ## SYNTAX
 
 ```powershell
-Test-MtCisaManagedDevice [-ProgressAction <ActionPreference>] [<CommonParameters>]
+Test-MtCisaManagedDevice [-SkipHybridJoinCheck] [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -34,6 +34,22 @@ Returns true if at least one policy requires managed devices
 
 ## PARAMETERS
 
+### -SkipHybridJoinCheck
+
+\{\{ Fill SkipHybridJoinCheck Description \}\}
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -ProgressAction
 
 \{\{ Fill ProgressAction Description \}\}

diff --git a/website/docs/commands/Test-MtCisaManagedDeviceRegistration.mdx b/website/docs/commands/Test-MtCisaManagedDeviceRegistration.mdx
@@ -15,7 +15,8 @@ Checks if a policy is enabled requiring a managed device for registration
 ## SYNTAX
 
 ```powershell
-Test-MtCisaManagedDeviceRegistration [-ProgressAction <ActionPreference>] [<CommonParameters>]
+Test-MtCisaManagedDeviceRegistration [-SkipHybridJoinCheck] [-ProgressAction <ActionPreference>]
+ [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -34,6 +35,22 @@ Returns true if at least one policy requires MFA for registration
 
 ## PARAMETERS
 
+### -SkipHybridJoinCheck
+
+\{\{ Fill SkipHybridJoinCheck Description \}\}
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -ProgressAction
 
 \{\{ Fill ProgressAction Description \}\}

diff --git a/website/docs/commands/Test-MtEidscaPR05.mdx b/website/docs/commands/Test-MtEidscaPR05.mdx
@@ -25,7 +25,7 @@ If an account locks repeatedly, this duration increases.
 
 Queries settings
 and returns the result of
- graph/settings.values | where-object name -eq 'LockoutDurationInSeconds' | select-object -expand value -eq '60'
+ graph/settings.values | where-object name -eq 'LockoutDurationInSeconds' | select-object -expand value -ge '60'
 
 ## EXAMPLES
 
@@ -35,7 +35,7 @@ and returns the result of
 Test-MtEidscaPR05
 ```
 
-Returns the result of graph.microsoft.com/beta/settings.values | where-object name -eq 'LockoutDurationInSeconds' | select-object -expand value -eq '60'
+Returns the result of graph.microsoft.com/beta/settings.values | where-object name -eq 'LockoutDurationInSeconds' | select-object -expand value -ge '60'
 
 ## PARAMETERS
 

diff --git a/website/docs/commands/docusaurus.sidebar.js b/website/docs/commands/docusaurus.sidebar.js
@@ -11,6 +11,7 @@
 module.exports = [
     'commands/Add-MtTestResultDetail',
     'commands/Clear-MtGraphCache',
+    'commands/Compare-MtTestResult',
     'commands/Connect-Maester',
     'commands/ConvertTo-MtMaesterResult',
     'commands/Disconnect-Maester',