Skip to content

Commit

Permalink
[create-pull-request] automated change
Browse files Browse the repository at this point in the history
  • Loading branch information
merill authored and github-actions[bot] committed Feb 14, 2025
1 parent ce1481b commit 4199d7d
Show file tree
Hide file tree
Showing 12 changed files with 570 additions and 33 deletions.
6 changes: 0 additions & 6 deletions website/docs/commands/Get-MtLicenseInformation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,6 @@ This function retrieves the license information for a Microsoft 365 product from
Get-MtLicenseInformation -Product EntraID
```

### EXAMPLE 2

```powershell
Get-MtLicenseInformation -Product MdoV2
```

## PARAMETERS

### -Product
Expand Down
37 changes: 34 additions & 3 deletions website/docs/commands/Invoke-Maester.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@ Invoke-Maester [[-Path] <String>] [-Tag <String[]>] [-ExcludeTag <String[]>] [-O
[-OutputMarkdownFile <String>] [-OutputJsonFile <String>] [-OutputFolder <String>]
[-OutputFolderFileName <String>] [-PesterConfiguration <PesterConfiguration>] [-Verbosity <String>]
[-NonInteractive] [-PassThru] [-MailRecipient <String[]>] [-MailTestResultsUri <String>]
[-MailUserId <String>] [-TeamId <String>] [-TeamChannelId <String>] [-SkipGraphConnect] [-DisableTelemetry]
[-SkipVersionCheck] [-ProgressAction <ActionPreference>] [<CommonParameters>]
[-MailUserId <String>] [-TeamId <String>] [-TeamChannelId <String>] [-TeamChannelWebhookUri <String>]
[-SkipGraphConnect] [-DisableTelemetry] [-SkipVersionCheck] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -107,13 +108,21 @@ Runs all the tests and posts a summary of the results to a Teams channel.

### EXAMPLE 10

```powershell
Invoke-Maester -TeamChannelWebhookUri 'https://some-url.logic.azure.com/workflows/invoke?api-version=2016-06-01'
```

Runs all the tests and posts a summary of the results to a Teams channel.

### EXAMPLE 11

```powershell
Invoke-Maester -Verbosity Normal
```

Shows results of tests as they are run including details on failed tests.

### EXAMPLE 11
### EXAMPLE 12

```powershell
$configuration = New-PesterConfiguration
Expand Down Expand Up @@ -438,6 +447,28 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -TeamChannelWebhookUri
Optional.
The webhook Uri where the message should be posted.
e.g.
https://some-url/?value=123
To get the Webhook Uri, right-click on the channel in Teams and select 'Workflow'.
Create a workflow using the 'Post to a channel when a webhook request is received' template.
Use the value after complete
```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -SkipGraphConnect
Skip the graph connection check.
Expand Down
42 changes: 40 additions & 2 deletions website/docs/commands/Send-MtTeamsMessage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,20 @@ Send an adaptive card in a teams channel with the summary of the Maester test re

## SYNTAX

### MSGraph

```powershell
Send-MtTeamsMessage [-MaesterResults] <PSObject> [-TeamId] <String> [-TeamChannelId] <String>
[-Subject <String>] [-TestResultsUri <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### Webhook

```powershell
Send-MtTeamsMessage [-MaesterResults] <PSObject> [-TeamChannelWebhookUri] <String> [-Subject <String>]
[-TestResultsUri <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION

Uses Graph API to send an adaptive card in a teams channel with the summary of the Maester test results.
Expand All @@ -44,6 +53,14 @@ Send-MtTeamsMessage -MaesterResults $MaesterResults -TeamId '00000000-0000-0000-

Sends an Adaptive Card in a Teams Channel with the summary of the Maester test results to the specified channel along with the link to the detailed test results.

### EXAMPLE 2

```powershell
Send-MtTeamsMessage -MaesterResults $MaesterResults -TeamChannelWebhookUri 'https://some-url.logic.azure.com/workflows/invoke?api-version=2016-06-01' -Subject 'Maester Results' -TestResultsUri "https://github.com/contoso/maester/runs/123456789"
```

Sends an Adaptive Card in a Teams Channel with the summary of the Maester test results to the specified channel along with the link to the detailed test results.

## PARAMETERS

### -MaesterResults
Expand Down Expand Up @@ -72,7 +89,7 @@ e.g.
```yaml
Type: String
Parameter Sets: (All)
Parameter Sets: MSGraph
Aliases:

Required: True
Expand All @@ -94,7 +111,7 @@ e.g.
```yaml
Type: String
Parameter Sets: (All)
Parameter Sets: MSGraph
Aliases:

Required: True
Expand All @@ -104,6 +121,27 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -TeamChannelWebhookUri
The URL of the webhook where the message should be posted.
e.g.
'https://some-url.logic.azure.com/workflows/invoke?api-version=2016-06-01'
To get the webhook Url, right-click on the channel in Teams and select 'Workflow'.
Create a workflow using the 'Post to a channel when a webhook request is received' template.
Use the value after complete
```yaml
Type: String
Parameter Sets: Webhook
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Subject
The subject of the card.
Expand Down
69 changes: 69 additions & 0 deletions website/docs/commands/Test-MtCaMisconfiguredIDProtection.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
sidebar_class_name: hidden
description: Checks for common misconfigurations in Conditional Access: both user risk and sign-in risk are configured in one policy.
id: Test-MtCaMisconfiguredIDProtection
title: Test-MtCaMisconfiguredIDProtection
hide_title: false
hide_table_of_contents: false
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Test-MtCaMisconfiguredIDProtection.ps1
---

## SYNOPSIS

Checks for common misconfigurations in Conditional Access: both user risk and sign-in risk are configured in one policy.

## SYNTAX

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

## DESCRIPTION

Conditional Access policies' access controls are enforced only if ALL conditions are met.
Therefore, sign-in risk and user risk should be configured separately.

Learn more:
https://learn.microsoft.com/en-us/entra/id-protection/howto-identity-protection-configure-risk-policies

## EXAMPLES

### EXAMPLE 1

```powershell
Test-MtCaMisconfiguredIDProtection
```

## 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-MtCaMisconfiguredIDProtection](https://maester.dev/docs/commands/Test-MtCaMisconfiguredIDProtection)
Original file line number Diff line number Diff line change
@@ -1,46 +1,38 @@
---
sidebar_class_name: hidden
description: Converts Pester results to the Maester test results format which includes additional information.
id: ConvertTo-MtMaesterResult
title: ConvertTo-MtMaesterResult
description: Ensure communication with Skype users is disabled
id: Test-MtCisCommunicateWithSkypeUsers
title: Test-MtCisCommunicateWithSkypeUsers
hide_title: false
hide_table_of_contents: false
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/ConvertTo-MtMaesterResult.ps1
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Test-MtCisCommunicateWithSkypeUsers.ps1
---

## SYNOPSIS

Converts Pester results to the Maester test results format which includes additional information.
Ensure communication with Skype users is disabled

## SYNTAX

```powershell
ConvertTo-MtMaesterResult [-PesterResults] <PSObject> [-ProgressAction <ActionPreference>] [<CommonParameters>]
Test-MtCisCommunicateWithSkypeUsers [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION

\{\{ Fill in the Description \}\}
Communication with Skype users is disabled

## EXAMPLES

## PARAMETERS
### EXAMPLE 1

### -PesterResults
```powershell
Test-MtCisCommunicateWithSkypeUsers
```

The Pester test results returned from Invoke-Pester -PassThru
Returns true if communication with Skype users is disabled

```yaml
Type: PSObject
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
## PARAMETERS

### -ProgressAction

Expand All @@ -66,6 +58,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## OUTPUTS
### System.Boolean
## NOTES
## RELATED LINKS
[https://maester.dev/docs/commands/Test-MtCisCommunicateWithSkypeUsers](https://maester.dev/docs/commands/Test-MtCisCommunicateWithSkypeUsers)
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
sidebar_class_name: hidden
description: Ensure communication with unmanaged Teams users is disabled
id: Test-MtCisCommunicateWithUnmanagedTeamsUsers
title: Test-MtCisCommunicateWithUnmanagedTeamsUsers
hide_title: false
hide_table_of_contents: false
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Test-MtCisCommunicateWithUnmanagedTeamsUsers.ps1
---

## SYNOPSIS

Ensure communication with unmanaged Teams users is disabled

## SYNTAX

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

## DESCRIPTION

Communication with unmanaged Teams users is disabled

## EXAMPLES

### EXAMPLE 1

```powershell
Test-MtCisCommunicateWithUnmanagedTeamsUsers
```

Returns true if communication with unmanaged Teams users is disabled

## 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-MtCisCommunicateWithUnmanagedTeamsUsers](https://maester.dev/docs/commands/Test-MtCisCommunicateWithUnmanagedTeamsUsers)
Loading

0 comments on commit 4199d7d

Please sign in to comment.