Get-XdrIdentityOnboardingStatus
SYNOPSIS
Retrieves the onboarding status of Microsoft Defender for Identity.
SYNTAX
Get-XdrIdentityOnboardingStatus [-Force] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Gets the onboarding status of Microsoft Defender for Identity (MDI) for the current tenant. Returns a boolean value indicating whether MDI is onboarded or not. This function includes caching support with a 30-minute TTL to reduce API calls.
EXAMPLES
EXAMPLE 1
Get-XdrIdentityOnboardingStatus
Retrieves the MDI onboarding status using cached data if available.
EXAMPLE 2
Get-XdrIdentityOnboardingStatus -Force
Forces a fresh retrieval of the MDI onboarding status, bypassing the cache.
EXAMPLE 3
if (Get-XdrIdentityOnboardingStatus)
Write-Host "Microsoft Defender for Identity is onboarded"
Checks if MDI is onboarded and displays a message.
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.