Skip to content

Commit

Permalink
Bot: Updating command reference
Browse files Browse the repository at this point in the history
  • Loading branch information
merill committed Apr 8, 2024
1 parent 5fac14d commit 7656ee7
Show file tree
Hide file tree
Showing 3 changed files with 210 additions and 0 deletions.
112 changes: 112 additions & 0 deletions website/docs/commands/Test-MtPimAlertsExists.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
---
sidebar_class_name: hidden
description: Checks if PIM alerts exists
id: Test-MtPimAlertsExists
title: Test-MtPimAlertsExists
hide_title: false
hide_table_of_contents: false
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Test-MtPimAlertsExists.ps1
---

## SYNOPSIS

Checks if PIM alerts exists

## SYNTAX

```powershell
Test-MtPimAlertsExists [-AlertId] <String[]> [[-FilteredAccessLevel] <String[]>]
[[-FilteredBreakGlass] <Object[]>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION

GET /beta/privilegedAccess/aadroles/resources/$tenantId/alerts

## EXAMPLES

### EXAMPLE 1

```powershell
Test-MtPimAlertsExists -FilteredAccessLevel "ControlPlane" -AlertId "RolesAssignedOutsidePimAlert"
```

## PARAMETERS

### -AlertId

\{\{ Fill AlertId Description \}\}

```yaml
Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```
### -FilteredAccessLevel
\{\{ Fill FilteredAccessLevel Description \}\}
```yaml
Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -FilteredBreakGlass
\{\{ Fill FilteredBreakGlass Description \}\}
```yaml
Type: Object[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: (Get-MtUser -UserType EmergencyAccess)
Accept pipeline input: True (ByPropertyName)
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
### System.Object
## NOTES
## RELATED LINKS
96 changes: 96 additions & 0 deletions website/docs/commands/Test-MtPrivPermanentDirectoryRole.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
---
sidebar_class_name: hidden
description: Checks if Permanent Assignments for Entra ID roles exists
id: Test-MtPrivPermanentDirectoryRole
title: Test-MtPrivPermanentDirectoryRole
hide_title: false
hide_table_of_contents: false
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Test-MtPrivPermanentDirectoryRole.ps1
---

## SYNOPSIS

Checks if Permanent Assignments for Entra ID roles exists

## SYNTAX

```powershell
Test-MtPrivPermanentDirectoryRole [[-FilteredAccessLevel] <String[]>] [-FilterPrincipal] <Object[]>
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION

GET /beta/roleManagement/directory/roleAssignments?$expand=principal

## EXAMPLES

### EXAMPLE 1

```powershell
Test-MtPrivPermanentDirectoryRole -FilteredAccessLevel "ControlPlane" -FilterPrincipal "ExternalUser"
```

## PARAMETERS

### -FilteredAccessLevel

\{\{ Fill FilteredAccessLevel Description \}\}

```yaml
Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -FilterPrincipal
\{\{ Fill FilterPrincipal Description \}\}
```yaml
Type: Object[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
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
### System.Boolean
## NOTES
## RELATED LINKS
2 changes: 2 additions & 0 deletions website/docs/commands/docusaurus.sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -88,5 +88,7 @@ module.exports = [
'commands/Test-MtEidscaPR06',
'commands/Test-MtEidscaST08',
'commands/Test-MtEidscaST09',
'commands/Test-MtPimAlertsExists',
'commands/Test-MtPrivPermanentDirectoryRole',
'commands/Update-MaesterTests'
];

0 comments on commit 7656ee7

Please sign in to comment.