← All XDRInternals commands

POWERSHELL COMMAND

Get-XdrAzureDataExplorerIngestionStatus

Gets the status of queued Azure Data Explorer ingestion operations.

View source ↗

Queries the Azure Data Explorer queued-ingestion status REST endpoint for one or more ingestion operation IDs. Use this cmdlet after Export-XdrAzureDataExplorer -TrackIngestion, or use -WaitForCompletion to block until the queued-ingestion operations finish.

Requires Set-XdrAzureDataExplorerConnection to be called first.

Syntax

Get-XdrAzureDataExplorerIngestionStatus [-TableName] <string> [-OperationId] <string[]> [[-TimeoutMinutes] <int>] [[-PollingIntervalSeconds] <int>] [-Details] [-WaitForCompletion] [<CommonParameters>]

Parameters

-TableName

Property Value
Type String
Required Yes
Position 1
Pipeline input No
Default Not documented

The target Azure Data Explorer table name that the queued-ingestion operation targeted.

-OperationId

Property Value
Type String[]
Required Yes
Position 2
Pipeline input true (ByValue, ByPropertyName)
Default Not documented

One or more queued-ingestion operation IDs returned by Azure Data Explorer.

-Details

Property Value
Type SwitchParameter
Required No
Position named
Pipeline input No
Default False

Includes per-blob details when the service returns them.

-WaitForCompletion

Property Value
Type SwitchParameter
Required No
Position named
Pipeline input No
Default False

Polls the queued-ingestion status endpoint until all specified operations reach a terminal state or the timeout is reached.

-TimeoutMinutes

Property Value
Type Int32
Required No
Position 3
Pipeline input No
Default 30

Maximum number of minutes to wait when -WaitForCompletion is specified.

-PollingIntervalSeconds

Property Value
Type Int32
Required No
Position 4
Pipeline input No
Default 15

Number of seconds between queued-ingestion status polls when -WaitForCompletion is specified.

Examples

Get-XdrAzureDataExplorerIngestionStatus -TableName "DeviceTimeline" -OperationId "ingest_op_12345"

Gets the current status of a queued-ingestion operation.

Get-XdrAzureDataExplorerIngestionStatus -TableName "DeviceTimeline" -OperationId "ingest_op_12345" -WaitForCompletion -Details

Waits for the queued-ingestion operation to finish and returns detailed blob status.

Output

Type: PSCustomObject[]

Returns one status object per queued-ingestion operation.

View source