Skip to main content

Get-XdrTenantWorkloadStatus

SYNOPSIS

Retrieves and evaluates the workload status from Microsoft Defender XDR tenant context.

SYNTAX

Get-XdrTenantWorkloadStatus [[-Workload] <String>] [-Force] [-ProgressAction <ActionPreference>]
[<CommonParameters>]

DESCRIPTION

Gets the tenant context information and evaluates all properties named "Is*Active" to determine which Microsoft Defender workloads are active in the tenant. Provides friendly names and descriptions for known workloads.

EXAMPLES

EXAMPLE 1

Get-XdrTenantWorkloadStatus
Retrieves and evaluates all workload statuses using cached data if available.

EXAMPLE 2

Get-XdrTenantWorkloadStatus -Workload "IsMdeActive"
Retrieves only the Microsoft Defender for Endpoint workload status.

EXAMPLE 3

Get-XdrTenantWorkloadStatus -Workload "IsMdatpActive"
Retrieves the workload status using the original property name.

EXAMPLE 4

Get-XdrTenantWorkloadStatus -Workload "*Sentinel*"
Retrieves workload statuses that match the Sentinel pattern.

EXAMPLE 5

Get-XdrTenantWorkloadStatus -Force
Forces a fresh retrieval of the tenant context and evaluates workload statuses.

PARAMETERS

-Workload

Filter results to a specific workload. Can match either the OriginalProperty or WorkloadName. Supports wildcards.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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

Array

Returns an array of objects containing the workload name, status, and description.

NOTES