Skip to content

Commit

Permalink
Merge pull request #430 from maester365/create-pull-request/patch
Browse files Browse the repository at this point in the history
Update maester.dev powershell docs
  • Loading branch information
merill authored Aug 27, 2024
2 parents 33a6fb6 + f5a1bdc commit b7346e4
Show file tree
Hide file tree
Showing 5 changed files with 119 additions and 39 deletions.
Original file line number Diff line number Diff line change
@@ -1,40 +1,34 @@
---
sidebar_class_name: hidden
description: This function checks if all objects found in policy exclusions are found in policy inclusions.
id: Get-ObjectDifferences
title: Get-ObjectDifferences
description: This function compares to object arrays
id: Get-ObjectDifference
title: Get-ObjectDifference
hide_title: false
hide_table_of_contents: false
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Get-ObjectDifferences.ps1
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Get-ObjectDifference.ps1
---

## SYNOPSIS

This function checks if all objects found in policy exclusions are found in policy inclusions.
This function compares to object arrays

## SYNTAX

```powershell
Get-ObjectDifferences [[-excludedObjects] <ArrayList>] [[-includedObjects] <ArrayList>]
Get-ObjectDifference [[-excludedObjects] <ArrayList>] [[-includedObjects] <ArrayList>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION

Checks for gaps in conditional access policies, by looking for excluded objects which are not specifically inlcuded
in another conditional access policy.
Instead of looking at the historical sign-ins to find gaps, we try to spot possibly
overlooked exclusions which do not have a fallback.

Reference:
https://learn.microsoft.com/en-us/entra/identity/monitoring-health/workbook-conditional-access-gap-analyzer
Provides the differences in objects between two arrays of objects.

## EXAMPLES

### EXAMPLE 1

```powershell
Test-MtCaGaps
Get-ObjectDifference
```

## PARAMETERS
Expand Down Expand Up @@ -95,8 +89,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## OUTPUTS
### System.Object[]
## NOTES
## RELATED LINKS
[https://maester.dev/docs/commands/Test-MtCaGaps](https://maester.dev/docs/commands/Test-MtCaGaps)
[https://maester.dev/docs/commands/Get-ObjectDifference](https://maester.dev/docs/commands/Get-ObjectDifference)
Original file line number Diff line number Diff line change
@@ -1,30 +1,36 @@
---
sidebar_class_name: hidden
description: \{\{ Fill in the Synopsis \}\}
id: Get-RalatedPolicies
title: Get-RalatedPolicies
description: Provides MarkDown text for specific array of objects
id: Get-RelatedPolicy
title: Get-RelatedPolicy
hide_title: false
hide_table_of_contents: false
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Get-RalatedPolicies.ps1
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Get-RelatedPolicy.ps1
---

## SYNOPSIS

\{\{ Fill in the Synopsis \}\}
Provides MarkDown text for specific array of objects

## SYNTAX

```powershell
Get-RalatedPolicies [[-Arr] <ArrayList>] [[-ObjName] <String>] [-ProgressAction <ActionPreference>]
Get-RelatedPolicy [[-Arr] <ArrayList>] [[-ObjName] <String>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

## DESCRIPTION

\{\{ Fill in the Description \}\}
Returns a structured MarkDown string resolving objects

## EXAMPLES

### EXAMPLE 1

```powershell
Get-RelatedPolicy
```

## PARAMETERS

### -Arr
Expand All @@ -37,7 +43,7 @@ Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Expand All @@ -53,7 +59,7 @@ Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Expand Down Expand Up @@ -81,12 +87,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS
### None
## OUTPUTS
### System.Object
### System.String
## NOTES
## RELATED LINKS
[https://maester.dev/docs/commands/Get-RelatedPolicy](https://maester.dev/docs/commands/Get-RelatedPolicy)
68 changes: 68 additions & 0 deletions website/docs/commands/Test-MtCaGap.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
sidebar_class_name: hidden
description: This function checks if all objects found in policy exclusions are found in policy inclusions.
id: Test-MtCaGap
title: Test-MtCaGap
hide_title: false
hide_table_of_contents: false
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Test-MtCaGap.ps1
---

## SYNOPSIS

This function checks if all objects found in policy exclusions are found in policy inclusions.

## SYNTAX

```powershell
Test-MtCaGap [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION

Checks for gaps in conditional access policies, by looking for excluded objects which are not specifically inlcuded
in another conditional access policy.
Instead of looking at the historical sign-ins to find gaps, we try to spot possibly
overlooked exclusions which do not have a fallback.

## EXAMPLES

### EXAMPLE 1

```powershell
Test-MtCaGap
```

## PARAMETERS

### -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
### System.Boolean
## NOTES
## RELATED LINKS
[https://maester.dev/docs/commands/Test-MtCaGap](https://maester.dev/docs/commands/Test-MtCaGap)
Original file line number Diff line number Diff line change
@@ -1,29 +1,38 @@
---
sidebar_class_name: hidden
description: \{\{ Fill in the Synopsis \}\}
id: Test-MtCaGaps
title: Test-MtCaGaps
description: Checks if Global Admins are cloud users
id: Test-MtCisCloudAdmin
title: Test-MtCisCloudAdmin
hide_title: false
hide_table_of_contents: false
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Test-MtCaGaps.ps1
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Test-MtCisCloudAdmin.ps1
---

## SYNOPSIS

\{\{ Fill in the Synopsis \}\}
Checks if Global Admins are cloud users

## SYNTAX

```powershell
Test-MtCaGaps [-ProgressAction <ActionPreference>] [<CommonParameters>]
Test-MtCisCloudAdmin [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION

\{\{ Fill in the Description \}\}
Ensure Administrative accounts are separate and cloud-only
CIS Microsoft 365 Foundations Benchmark v3.1.0

## EXAMPLES

### EXAMPLE 1

```powershell
Test-MtCisCloudAdmin
```

Returns true if no global admins are hybrid sync

## PARAMETERS

### -ProgressAction
Expand All @@ -48,12 +57,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS
### None
## OUTPUTS
### System.Boolean
## NOTES
## RELATED LINKS
[https://maester.dev/docs/commands/Test-MtCisCloudAdmin](https://maester.dev/docs/commands/Test-MtCisCloudAdmin)
7 changes: 4 additions & 3 deletions website/docs/commands/docusaurus.sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ module.exports = [
'commands/Get-MtUser',
'commands/Get-MtUserAuthenticationMethod',
'commands/Get-MtUserAuthenticationMethodInfoByType',
'commands/Get-ObjectDifferences',
'commands/Get-RalatedPolicies',
'commands/Get-ObjectDifference',
'commands/Get-RelatedPolicy',
'commands/Install-MaesterTests',
'commands/Invoke-Maester',
'commands/Invoke-MtGraphRequest',
Expand All @@ -55,7 +55,7 @@ module.exports = [
'commands/Test-MtCaEnforceNonPersistentBrowserSession',
'commands/Test-MtCaEnforceSignInFrequency',
'commands/Test-MtCaExclusionForDirectorySyncAccount',
'commands/Test-MtCaGaps',
'commands/Test-MtCaGap',
'commands/Test-MtCaGroupsRestricted',
'commands/Test-MtCaLicenseUtilization',
'commands/Test-MtCaMfaForAdmin',
Expand Down Expand Up @@ -135,6 +135,7 @@ module.exports = [
'commands/Test-MtCisaSpfRestriction',
'commands/Test-MtCisaUnmanagedRoleAssignment',
'commands/Test-MtCisaWeakFactor',
'commands/Test-MtCisCloudAdmin',
'commands/Test-MtConditionalAccessWhatIf',
'commands/Test-MtConnection',
'commands/Test-MtEidscaAF01',
Expand Down

0 comments on commit b7346e4

Please sign in to comment.