Get-XdrAzureDataExplorerIngestionStatus
SYNOPSIS
Gets the status of queued Azure Data Explorer ingestion operations.
SYNTAX
Get-XdrAzureDataExplorerIngestionStatus [-TableName] <String> [-OperationId] <String[]> [-Details]
[-WaitForCompletion] [[-TimeoutMinutes] <Int32>] [[-PollingIntervalSeconds] <Int32>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
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.
EXAMPLES
EXAMPLE 1
Get-XdrAzureDataExplorerIngestionStatus -TableName "DeviceTimeline" -OperationId "ingest_op_12345"
Gets the current status of a queued-ingestion operation.
EXAMPLE 2
Get-XdrAzureDataExplorerIngestionStatus -TableName "DeviceTimeline" -OperationId "ingest_op_12345" -WaitForCompletion -Details
Waits for the queued-ingestion operation to finish and returns detailed blob status.
PARAMETERS
-TableName
The target Azure Data Explorer table name that the queued-ingestion operation targeted.
Type: String
Parameter Sets: (All)
Aliases: Table
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OperationId
One or more queued-ingestion operation IDs returned by Azure Data Explorer.
Type: String[]
Parameter Sets: (All)
Aliases: IngestionOperationId, Id
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Details
Includes per-blob details when the service returns them.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-WaitForCompletion
Polls the queued-ingestion status endpoint until all specified operations reach a terminal state or the timeout is reached.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-TimeoutMinutes
Maximum number of minutes to wait when -WaitForCompletion is specified.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 30
Accept pipeline input: False
Accept wildcard characters: False
-PollingIntervalSeconds
Number of seconds between queued-ingestion status polls when -WaitForCompletion is specified.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 15
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.