Connect-IRTExchange
SYNOPSIS
Connects to Exchange Online.
SYNTAX
Connect-IRTExchange [-TenantId] <String> [[-UserPrincipalName] <String>] [-GCCHigh] [-DeviceCode]
[[-AccessToken] <String>] [[-Browser] <String>] [-Private] [-Force] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION
{{ Fill in the Description }}
EXAMPLES
Example 1
PS C:\> {{ Add example code here }}
{{ Add example description here }}
PARAMETERS
-TenantId
The TenantId GUID for the environment you want to connect to.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-UserPrincipalName
Optional. The UserPrincipalName (Email) for the user account. When provided with -AccessToken (e.g. in runspace re-connections), this value is passed to Connect-ExchangeOnline. For interactive flows the UPN is derived from the MSAL token result automatically.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-GCCHigh
Connect to a GCC High tenant environment.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-DeviceCode
Use device code authentication flow.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-AccessToken
A pre-existing access token to use for connection. Intended for use within runspaces where interactive authentication is not possible.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Browser
Browser to use for device code login. Valid values: msedge, chrome, firefox, brave, default.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: $Global:IRT_Config.Browser
Accept pipeline input: False
Accept wildcard characters: False
-Private
Open the browser in private/incognito mode.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Force
{{ Fill Force Description }}
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
Version: 3.0.0