Skip to content

Commit

Permalink
Merge pull request #268 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 Jun 23, 2024
2 parents b727664 + ffd2090 commit 3ae3f44
Show file tree
Hide file tree
Showing 9 changed files with 498 additions and 2 deletions.
38 changes: 36 additions & 2 deletions website/docs/commands/Connect-Maester.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ Connect-Maester [-SendMail] [-Privileged] [-UseDeviceCode] [[-Environment] <Stri

Use this cmdlet to connect to Microsoft Graph using Connect-MgGraph.

This command is completely optional if you are already connected to Microsoft Graph using Connect-MgGraph with the required scopes.
This command is completely optional if you are already connected to Microsoft Graph and other services using Connect-MgGraph with the required scopes.

```
Connect-MgGraph -Scopes (Get-MtGraphScope)
```
Expand All @@ -37,18 +38,49 @@ Connect-MgGraph -Scopes (Get-MtGraphScope)
Connect-Maester
```

Connects to Microsoft Graph using Connect-MgGraph with the required scopes.

### EXAMPLE 2

```powershell
Connect-Maester -Service All
```

Connects to Microsoft Graph, Azure, and Exchange Online.

### EXAMPLE 3

```powershell
Connect-Maester -Service Azure,Graph
```

Connects to Microsoft Graph and Azure.

### EXAMPLE 4

```powershell
Connect-Maester -UseDeviceCode
```

Connects to Microsoft Graph and Azure using the device code flow.
This will open a browser window to prompt for authentication.

### EXAMPLE 5

```powershell
Connect-Maester -SendMail
```

Connects to Microsoft Graph with the Mail.Send scope.

### EXAMPLE 6

```powershell
Connect-Maester -Privileged
```

Connects to Microsoft Graph with additional privileged scopes such as **RoleEligibilitySchedule.ReadWrite.Directory** that are required for querying global admin roles in Privileged Identity Management.

## PARAMETERS

### -SendMail
Expand All @@ -70,6 +102,7 @@ Accept wildcard characters: False
### -Privileged
If specified, the cmdlet will include the scopes for read write API endpoints.
This is currently required for querying global admin roles in PIM.
```yaml
Type: SwitchParameter
Expand All @@ -85,7 +118,8 @@ Accept wildcard characters: False
### -UseDeviceCode
If specified, the cmdlet will use the device code flow to authenticate.
If specified, the cmdlet will use the device code flow to authenticate to Graph and Azure.
This will open a browser window to prompt for authentication and is useful for non-interactive sessions and on Windows when SSO is not desired.
```yaml
Type: SwitchParameter
Expand Down
65 changes: 65 additions & 0 deletions website/docs/commands/Test-MtCisaAntiSpamAllowList.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
sidebar_class_name: hidden
description: Checks state of anti-spam policies
id: Test-MtCisaAntiSpamAllowList
title: Test-MtCisaAntiSpamAllowList
hide_title: false
hide_table_of_contents: false
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Test-MtCisaAntiSpamAllowList.ps1
---

## SYNOPSIS

Checks state of anti-spam policies

## SYNTAX

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

## DESCRIPTION

IP allow lists SHOULD NOT be created.

## EXAMPLES

### EXAMPLE 1

```powershell
Test-MtCisaAntiSpamAllowList
```

Returns true if no allowed IPs in anti-spam policy

## 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
65 changes: 65 additions & 0 deletions website/docs/commands/Test-MtCisaAntiSpamSafeList.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
sidebar_class_name: hidden
description: Checks state of anti-spam policies
id: Test-MtCisaAntiSpamSafeList
title: Test-MtCisaAntiSpamSafeList
hide_title: false
hide_table_of_contents: false
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Test-MtCisaAntiSpamSafeList.ps1
---

## SYNOPSIS

Checks state of anti-spam policies

## SYNTAX

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

## DESCRIPTION

Safe lists SHOULD NOT be enabled.

## EXAMPLES

### EXAMPLE 1

```powershell
Test-MtCisaAntiSpamSafeList
```

Returns true if Safe List is disabled in anti-spam policy

## 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
65 changes: 65 additions & 0 deletions website/docs/commands/Test-MtCisaCalendarSharing.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
sidebar_class_name: hidden
description: Checks state of sharing policies
id: Test-MtCisaCalendarSharing
title: Test-MtCisaCalendarSharing
hide_title: false
hide_table_of_contents: false
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Test-MtCisaCalendarSharing.ps1
---

## SYNOPSIS

Checks state of sharing policies

## SYNTAX

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

## DESCRIPTION

Calendar details SHALL NOT be shared with all domains.

## EXAMPLES

### EXAMPLE 1

```powershell
Test-MtCisaCalendarSharing
```

Returns true if no sharing policies allow uncontrolled calendar sharing.

## 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
65 changes: 65 additions & 0 deletions website/docs/commands/Test-MtCisaContactSharing.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
sidebar_class_name: hidden
description: Checks state of sharing policies
id: Test-MtCisaContactSharing
title: Test-MtCisaContactSharing
hide_title: false
hide_table_of_contents: false
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Test-MtCisaContactSharing.ps1
---

## SYNOPSIS

Checks state of sharing policies

## SYNTAX

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

## DESCRIPTION

Contact folders SHALL NOT be shared with all domains.

## EXAMPLES

### EXAMPLE 1

```powershell
Test-MtCisaContactSharing
```

Returns true if no sharing policies allow uncontrolled contact sharing.

## 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
Loading

0 comments on commit 3ae3f44

Please sign in to comment.