Skip to content

Commit

Permalink
Simplified navigation
Browse files Browse the repository at this point in the history
  • Loading branch information
merill committed Mar 17, 2024
1 parent 2b68fcc commit b16a6a1
Show file tree
Hide file tree
Showing 146 changed files with 169 additions and 26 deletions.
2 changes: 1 addition & 1 deletion build/Build-CommandReference.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ $cmdMarkdownFiles = Get-ChildItem ./docs/docs/commands
foreach ($file in $cmdMarkdownFiles) {
$content = Get-Content $file
$synopsis = $content[($content.IndexOf("## SYNOPSIS") + 2)] # Get the synopsis
$updatedContent = $content.Replace("id:", "description: $($synopsis)`nid:")
$updatedContent = $content.Replace("id:", "sidebar_class_name: hidden`ndescription: $($synopsis)`nid:")
Set-Content $file $updatedContent
}
2 changes: 1 addition & 1 deletion docs/docs/automation/azure-devops.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: Azure DevOps
sidebar_position: 1
sidebar_position: 2
title: Azure DevOps
---

Expand Down
3 changes: 2 additions & 1 deletion docs/docs/commands-overview.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
id: commands-overview
title: Maester PowerShell commands
---

```mdx-code-block
import DocLinkList from '@site/src/components/DocLinkList/DocLinkList';
# Maester - Command Reference
# Maester - PowerShell Commands
## Overview
This page lists the commands available in the Maester module and provides a reference of the helper methods that have been created to help you define and run tests on your Microsoft 365 cloud configuration.
Expand Down
1 change: 1 addition & 0 deletions docs/docs/commands/Clear-MtGraphCache.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Resets the local cache of Graph API calls.
id: Clear-MtGraphCache
title: Clear-MtGraphCache
Expand Down
1 change: 1 addition & 0 deletions docs/docs/commands/Connect-MtGraph.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Helper method to connect to Microsoft Graph using Connect-MgGraph with the required scopes.
id: Connect-MtGraph
title: Connect-MtGraph
Expand Down
1 change: 1 addition & 0 deletions docs/docs/commands/Export-MtHtmlReport.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Generates a formatted html report using the xml output from unit test frameworks like Pester.
id: Export-MtHtmlReport
title: Export-MtHtmlReport
Expand Down
1 change: 1 addition & 0 deletions docs/docs/commands/Get-MtConditionalAccessPolicies.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Returns all the conditional access policies in the tenant.
id: Get-MtConditionalAccessPolicies
title: Get-MtConditionalAccessPolicies
Expand Down
1 change: 1 addition & 0 deletions docs/docs/commands/Get-MtGraphScopes.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Returns the list of Graph scopes required to run Maester.
id: Get-MtGraphScopes
title: Get-MtGraphScopes
Expand Down
1 change: 1 addition & 0 deletions docs/docs/commands/Invoke-MtGraphRequest.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Enhanced version of Invoke-MgGraphRequest that supports paging, batching and caching.
id: Invoke-MtGraphRequest
title: Invoke-MtGraphRequest
Expand Down
1 change: 1 addition & 0 deletions docs/docs/commands/Test-MtAppManagementPolicyEnabled.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Checks if the default app management policy is enabled.
id: Test-MtAppManagementPolicyEnabled
title: Test-MtAppManagementPolicyEnabled
Expand Down
1 change: 1 addition & 0 deletions docs/docs/commands/Test-MtCaAllAppsExists.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Checks if the tenant has at least one fallback policy targetting All Apps and All Users.
id: Test-MtCaAllAppsExists
title: Test-MtCaAllAppsExists
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Checks if the tenant has at least one conditional access policy is configured to enable application enforced restrictions
id: Test-MtCaApplicationEnforcedRestrictions
title: Test-MtCaApplicationEnforcedRestrictions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Checks if the tenant has at least one conditional access policy that blocks legacy authentication for Exchange Active Sync authentication.
id: Test-MtCaBlockLegacyExchangeActiveSyncAuthentication
title: Test-MtCaBlockLegacyExchangeActiveSyncAuthentication
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Checks if the tenant has at least one conditional access policy that blocks legacy authentication.
id: Test-MtCaBlockLegacyOtherAuthentication
title: Test-MtCaBlockLegacyOtherAuthentication
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Checks if the tenant has at least one Conditional Access policy is configured to block access for unknown or unsupported device platforms
id: Test-MtCaBlockUnknownOrUnsupportedDevicePlatforms
title: Test-MtCaBlockUnknownOrUnsupportedDevicePlatforms
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Checks if the tenant has at least one conditional access policy requiring device compliance for admins.
id: Test-MtCaDeviceComplianceAdminsExists
title: Test-MtCaDeviceComplianceAdminsExists
Expand Down
1 change: 1 addition & 0 deletions docs/docs/commands/Test-MtCaDeviceComplianceExists.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Checks if the tenant has at least one conditional access policy requiring device compliance.
id: Test-MtCaDeviceComplianceExists
title: Test-MtCaDeviceComplianceExists
Expand Down
1 change: 1 addition & 0 deletions docs/docs/commands/Test-MtCaEmergencyAccessExists.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Checks if the tenant has at least one emergency/break glass account or account group excluded from all conditional access policies
id: Test-MtCaEmergencyAccessExists
title: Test-MtCaEmergencyAccessExists
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Checks if the tenant has at least one conditional access policy enforcing non persistent browser session
id: Test-MtCaEnforceNonPersistentBrowserSession
title: Test-MtCaEnforceNonPersistentBrowserSession
Expand Down
1 change: 1 addition & 0 deletions docs/docs/commands/Test-MtCaEnforceSignInFrequency.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Checks if the tenant has at least one conditional access policy enforcing sign-in frequency for non-corporate devices
id: Test-MtCaEnforceSignInFrequency
title: Test-MtCaEnforceSignInFrequency
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Checks if all conditional access policies scoped to all cloud apps exclude the directory synchronization accounts
id: Test-MtCaExclusionForDirectorySyncAccounts
title: Test-MtCaExclusionForDirectorySyncAccounts
Expand Down
1 change: 1 addition & 0 deletions docs/docs/commands/Test-MtCaMfaForAdminManagement.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Checks if the tenant has at least one conditional access policy requiring multifactor authentication to access Azure management.
id: Test-MtCaMfaForAdminManagement
title: Test-MtCaMfaForAdminManagement
Expand Down
1 change: 1 addition & 0 deletions docs/docs/commands/Test-MtCaMfaForAdmins.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Checks if the tenant has at least one conditional access policy requiring MFA for admins
id: Test-MtCaMfaForAdmins
title: Test-MtCaMfaForAdmins
Expand Down
1 change: 1 addition & 0 deletions docs/docs/commands/Test-MtCaMfaForAllUsers.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Checks if the tenant has at least one conditional access policy requiring multifactor authentication for all users
id: Test-MtCaMfaForAllUsers
title: Test-MtCaMfaForAllUsers
Expand Down
1 change: 1 addition & 0 deletions docs/docs/commands/Test-MtCaMfaForGuests.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Checks if the tenant has at least one conditional access policy requiring multifactor authentication for all guest users.
id: Test-MtCaMfaForGuests
title: Test-MtCaMfaForGuests
Expand Down
1 change: 1 addition & 0 deletions docs/docs/commands/Test-MtCaMfaForRiskySignIns.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Checks if the tenant has at least one conditional access policy requiring multifactor authentication for risky sign-ins.
id: Test-MtCaMfaForRiskySignIns
title: Test-MtCaMfaForRiskySignIns
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Checks if the tenant has at least one conditional access policy requiring password change for high user risk.
id: Test-MtCaRequirePasswordChangeForHighUserRisk
title: Test-MtCaRequirePasswordChangeForHighUserRisk
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_class_name: hidden
description: Checks if the tenant has at least one conditional access policy securing security info registration.
id: Test-MtCaSecureSecurityInfoRegistration
title: Test-MtCaSecureSecurityInfoRegistration
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tests/eidsca-overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: eidsca-overview
title: Entra ID - Security Config Analyzer Tests
sidebar_label: EIDSCA Tests Overview
sidebar_label: Entra ID SCA Tests
description: Overview of the Entra ID Security Config Analyzer tests
---

Expand Down
1 change: 1 addition & 0 deletions docs/docs/tests/eidsca/@template.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: %DisplayName% (%Name%)
slug: /tests/%DocName%
sidebar_class_name: hidden
---

# %DisplayName%
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Enable directory level idle timeout (WebSessionIdleTimeout)
slug: /tests/EIDSCA.activityBasedTimeoutPolicies.WebSessionIdleTimeout
sidebar_class_name: hidden
---

# Enable directory level idle timeout
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Allow external users to use email OTP (allowExternalIdToUseEmailOtp)
slug: /tests/EIDSCA.authenticationMethodsPolicy.allowExternalIdToUseEmailOtp
sidebar_class_name: hidden
---

# Allow external users to use email OTP
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Registration campaign - Excluded users/groups (authenticationMethodsRegistrationCampaignExcluded)
slug: /tests/EIDSCA.authenticationMethodsPolicy.authenticationMethodsRegistrationCampaignExcluded
sidebar_class_name: hidden
---

# Registration campaign - Excluded users/groups
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Registration campaign - Included users/groups (authenticationMethodsRegistrationCampaignIncluded)
slug: /tests/EIDSCA.authenticationMethodsPolicy.authenticationMethodsRegistrationCampaignIncluded
sidebar_class_name: hidden
---

# Registration campaign - Included users/groups
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Registration campaign - Days allowed to snooze (authenticationMethodsRegistrationCampaignSnoozeDurationInDays)
slug: /tests/EIDSCA.authenticationMethodsPolicy.authenticationMethodsRegistrationCampaignSnoozeDurationInDays
sidebar_class_name: hidden
---

# Registration campaign - Days allowed to snooze
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Registration campaign - State (authenticationMethodsRegistrationCampaignState)
slug: /tests/EIDSCA.authenticationMethodsPolicy.authenticationMethodsRegistrationCampaignState
sidebar_class_name: hidden
---

# Registration campaign - State
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Registration campaign - Authentication Method (authenticationMethodsRegistrationCampaignTargetedAuthenticationMethod)
slug: /tests/EIDSCA.authenticationMethodsPolicy.authenticationMethodsRegistrationCampaignTargetedAuthenticationMethod
sidebar_class_name: hidden
---

# Registration campaign - Authentication Method
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Authentication binding - Rules (authenticationModeConfiguration.rules)
slug: /tests/EIDSCA.authenticationMethodsPolicy.authenticationModeConfiguration.rules
sidebar_class_name: hidden
---

# Authentication binding - Rules
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Authentication binding - Protected Level (authenticationModeConfiguration.x509CertificateAuthenticationDefaultMode)
slug: /tests/EIDSCA.authenticationMethodsPolicy.authenticationModeConfiguration.x509CertificateAuthenticationDefaultMode
sidebar_class_name: hidden
---

# Authentication binding - Protected Level
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Length (defaultLength)
slug: /tests/EIDSCA.authenticationMethodsPolicy.defaultLength
sidebar_class_name: hidden
---

# Length
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Default lifetime (defaultLifetimeInMinutes)
slug: /tests/EIDSCA.authenticationMethodsPolicy.defaultLifetimeInMinutes
sidebar_class_name: hidden
---

# Default lifetime
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Show application name in push and passwordless notifications (displayAppInformationRequiredState)
slug: /tests/EIDSCA.authenticationMethodsPolicy.displayAppInformationRequiredState
sidebar_class_name: hidden
---

# Show application name in push and passwordless notifications
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Excluded users/groups to show application name in push and passwordless notifications (displayAppInformationRequiredStateExcluded)
slug: /tests/EIDSCA.authenticationMethodsPolicy.displayAppInformationRequiredStateExcluded
sidebar_class_name: hidden
---

# Excluded users/groups to show application name in push and passwordless notifications
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Included users/groups to show application name in push and passwordless notifications (displayAppInformationRequiredStateIncluded)
slug: /tests/EIDSCA.authenticationMethodsPolicy.displayAppInformationRequiredStateIncluded
sidebar_class_name: hidden
---

# Included users/groups to show application name in push and passwordless notifications
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Excluded users/groups to show geographic location in push and passwordless notifications (displayLocationInformationRequiredExcluded)
slug: /tests/EIDSCA.authenticationMethodsPolicy.displayLocationInformationRequiredExcluded
sidebar_class_name: hidden
---

# Excluded users/groups to show geographic location in push and passwordless notifications
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Show geographic location in push and passwordless notifications (displayLocationInformationRequiredState)
slug: /tests/EIDSCA.authenticationMethodsPolicy.displayLocationInformationRequiredState
sidebar_class_name: hidden
---

# Show geographic location in push and passwordless notifications
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Included users/groups to show geographic location in push and passwordless notifications (displayLocationInformationRequiredStateIncluded)
slug: /tests/EIDSCA.authenticationMethodsPolicy.displayLocationInformationRequiredStateIncluded
sidebar_class_name: hidden
---

# Included users/groups to show geographic location in push and passwordless notifications
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Excluded users/group from CBA (excludeTargets)
slug: /tests/EIDSCA.authenticationMethodsPolicy.excludeTargets
sidebar_class_name: hidden
---

# Excluded users/group from CBA
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Included users/groups from CBA (includeTargets)
slug: /tests/EIDSCA.authenticationMethodsPolicy.includeTargets
sidebar_class_name: hidden
---

# Included users/groups from CBA
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Enforce attestation (isAttestationEnforced)
slug: /tests/EIDSCA.authenticationMethodsPolicy.isAttestationEnforced
sidebar_class_name: hidden
---

# Enforce attestation
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Phone Options - Office (isOfficePhoneAllowed)
slug: /tests/EIDSCA.authenticationMethodsPolicy.isOfficePhoneAllowed
sidebar_class_name: hidden
---

# Phone Options - Office
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Allow self-service set up (isSelfServiceRegistrationAllowed)
slug: /tests/EIDSCA.authenticationMethodsPolicy.isSelfServiceRegistrationAllowed
sidebar_class_name: hidden
---

# Allow self-service set up
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Allow use of Microsoft Authenticator OTP (isSoftwareOathEnabled)
slug: /tests/EIDSCA.authenticationMethodsPolicy.isSoftwareOathEnabled
sidebar_class_name: hidden
---

# Allow use of Microsoft Authenticator OTP
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: One-time (isUsableOnce)
slug: /tests/EIDSCA.authenticationMethodsPolicy.isUsableOnce
sidebar_class_name: hidden
---

# One-time
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Restricted (keyRestrictions.aaGuids)
slug: /tests/EIDSCA.authenticationMethodsPolicy.keyRestrictions.aaGuids
sidebar_class_name: hidden
---

# Restricted
Expand Down
Loading

0 comments on commit b16a6a1

Please sign in to comment.