Skip to main content

Get-MtGraphScope

SYNOPSIS

Returns the list of Graph scopes required to run Maester.

SYNTAX

Get-MtGraphScope [-SendMail] [-SendTeamsMessage] [-Privileged] [-ProgressAction <ActionPreference>]
[<CommonParameters>]

DESCRIPTION

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

EXAMPLES

EXAMPLE 1

Connect-MgGraph -Scopes (Get-MtGraphScope)

Connects to Microsoft Graph with the required scopes to run Maester.

EXAMPLE 2

Connect-MgGraph -Scopes (Get-MtGraphScope -SendMail)

Connects to Microsoft Graph with the required scopes to run Maester and send email.

EXAMPLE 3

Connect-MgGraph -Scopes (Get-MtGraphScope -SendTeamsMessage)

Connects to Microsoft Graph with the required scopes to run Maester and send messages to a Teams Channel.

EXAMPLE 4

Connect-MgGraph -Scopes (Get-MtGraphScope -PrivilegedScopes)

Connects to Microsoft Graph with the required scopes to run Maester for all tests, including those requiring read write APIs.

PARAMETERS

-SendMail

If specified, the cmdlet will include the scope to send email (Mail.Send).

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-SendTeamsMessage

If specified, the cmdlet will include the scope to send Teams Channel Messages (ChannelMessage.Send).

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Privileged

If specified, the cmdlet will include the scope for read write endpoints.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

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.

INPUTS

OUTPUTS

NOTES

https://maester.dev/docs/commands/Get-MtGraphScope