ApplicationInsightsDataClientExtensions.GetCustomEvents Method

Reference

Definition

Namespace:: Microsoft.Azure.ApplicationInsights

Assembly:: Microsoft.Azure.ApplicationInsights.dll

Package:: Microsoft.Azure.ApplicationInsights v0.9.0-preview

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Execute OData query for custom events

public static Microsoft.Azure.ApplicationInsights.Models.EventsResults<Microsoft.Azure.ApplicationInsights.Models.EventsCustomEventResult> GetCustomEvents (this Microsoft.Azure.ApplicationInsights.IApplicationInsightsDataClient operations, TimeSpan? 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);

static member GetCustomEvents : Microsoft.Azure.ApplicationInsights.IApplicationInsightsDataClient * Nullable<TimeSpan> * string * string * string * string * Nullable<int> * Nullable<int> * string * Nullable<bool> * string -> Microsoft.Azure.ApplicationInsights.Models.EventsResults<Microsoft.Azure.ApplicationInsights.Models.EventsCustomEventResult>

<Extension()>
Public Function GetCustomEvents (operations As IApplicationInsightsDataClient, Optional timespan As Nullable(Of TimeSpan) = 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) As EventsResults(Of EventsCustomEventResult)

Parameters

operations: IApplicationInsightsDataClient

The operations group for this extension method.

timespan: Nullable<TimeSpan>

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

Returns

EventsResults<EventsCustomEventResult>

Remarks

Executes an OData query for custom events

Applies to

Share via