Set-XdrConnectionSettings
SYNOPSIS
Creates XDR connection settings using authentication cookies.
SYNTAX
Manual
Set-XdrConnectionSettings -SccAuth <Object> [-Xsrf <Object>] [-TenantId <Object>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Websession
Set-XdrConnectionSettings [-TenantId <Object>] -WebSession <Object> [-ProgressAction <ActionPreference>]
[<CommonParameters>]
ResetWebSession
Set-XdrConnectionSettings [-TenantId <Object>] [-ResetWebSession] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION
Creates global session and headers variables for XDR API calls using the provided sccauth value and optionally an XSRF token value. If xsrf is not provided, the function will bootstrap the session against security.microsoft.com to obtain XSRF-TOKEN automatically.
EXAMPLES
EXAMPLE 1
Set-XdrConnectionSettings -sccauth "your_sccauth_value" -xsrf "your_xsrf_value"
Creates XDR connection settings using the provided authentication cookies.
EXAMPLE 2
Set-XdrConnectionSettings -sccauth "your_sccauth_value" -TenantId "your_tenant_id"
Creates XDR connection settings and automatically obtains XSRF-TOKEN.
PARAMETERS
-SccAuth
The sccauth cookie value from an authenticated session to security.microsoft.com.
Type: Object
Parameter Sets: Manual
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Xsrf
The XSRF-TOKEN cookie value from an authenticated session to security.microsoft.com. If not provided, XSRF-TOKEN is obtained automatically using the provided sccauth and an initial request to security.microsoft.com.
Type: Object
Parameter Sets: Manual
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TenantId
The Tenant ID to use for XDR API requests. If not provided, the Tenant ID will be determined automatically from the XDR portal.
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WebSession
An optional WebRequestSession object to use for the requests. If not provided, a new session will be created.
Type: Object
Parameter Sets: Websession
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ResetWebSession
If specified, resets the existing WebSession by creating a new one while retaining the existing authentication cookies.
Type: SwitchParameter
Parameter Sets: ResetWebSession
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
The ProgressAction parameter is a common parameter, not a cmdlet parameter. For more information, see about_CommonParameters.
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.