Skip to main content

Get-XdrTenantContext

SYNOPSIS

Retrieves the tenant context information from Microsoft Defender XDR.

SYNTAX

Get-XdrTenantContext [-Force] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Gets the tenant context information from the Microsoft Defender XDR portal, including tenant settings and configuration details. This function includes caching support with a 30-minute TTL to reduce API calls.

EXAMPLES

EXAMPLE 1

Get-XdrTenantContext
Retrieves the tenant context using cached data if available.

EXAMPLE 2

Get-XdrTenantContext -Force
Forces a fresh retrieval of the tenant context, bypassing the cache.

PARAMETERS

-Force

Bypasses the cache and forces a fresh retrieval from the API.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
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.

INPUTS

OUTPUTS

Object

Returns the tenant context configuration object.

NOTES