EventsExtensions.GetTraceEventsAsync Method

Definition

Execute OData query for trace events

public static System.Threading.Tasks.Task<Microsoft.Azure.ApplicationInsights.Query.Models.EventsResults<Microsoft.Azure.ApplicationInsights.Query.Models.EventsTraceResult>> GetTraceEventsAsync (this Microsoft.Azure.ApplicationInsights.Query.IEvents operations, string appId, string timespan = default, string filter = default, string search = default, string orderby = default, string select = default, int? skip = default, int? top = default, string format = default, bool? count = default, string apply = default, System.Threading.CancellationToken cancellationToken = default);
static member GetTraceEventsAsync : Microsoft.Azure.ApplicationInsights.Query.IEvents * string * string * string * string * string * string * Nullable<int> * Nullable<int> * string * Nullable<bool> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.ApplicationInsights.Query.Models.EventsResults<Microsoft.Azure.ApplicationInsights.Query.Models.EventsTraceResult>>
<Extension()>
Public Function GetTraceEventsAsync (operations As IEvents, appId As String, Optional timespan As String = Nothing, Optional filter As String = Nothing, Optional search As String = Nothing, Optional orderby As String = Nothing, Optional select As String = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional format As String = Nothing, Optional count As Nullable(Of Boolean) = Nothing, Optional apply As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of EventsResults(Of EventsTraceResult))

Parameters

operations
IEvents

The operations group for this extension method.

appId
String

ID of the application. This is Application ID from the API Access settings blade in the Azure portal.

timespan
String

Optional. The timespan over which to retrieve events. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the Odata expression.

filter
String

An expression used to filter the returned events

search
String

A free-text search expression to match for whether a particular event should be returned

orderby
String

A comma-separated list of properties with "asc" (the default) or "desc" to control the order of returned events

select
String

Limits the properties to just those requested on each returned event

skip
Nullable<Int32>

The number of items to skip over before returning events

top
Nullable<Int32>

The number of events to return

format
String

Format for the returned events

count
Nullable<Boolean>

Request a count of matching items included with the returned events

apply
String

An expression used for aggregation over returned events

cancellationToken
CancellationToken

The cancellation token.

Returns

Remarks

Executes an OData query for trace events

Applies to