Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Events

Package version

Class representing a Events.

Hierarchy

  • Events

Index

Constructors

Methods

Constructors

constructor

Methods

get

  • get(appId: string, eventType: Models.EventType, eventId: string, options?: Models.EventsGetOptionalParams): Promise<Models.EventsGetResponse>
  • get(appId: string, eventType: Models.EventType, eventId: string, callback: msRest.ServiceCallback<EventsResults>): void
  • get(appId: string, eventType: Models.EventType, eventId: string, options: EventsGetOptionalParams, callback: msRest.ServiceCallback<EventsResults>): void

  • Gets the data for a single event

    summary

    Get an event

    Parameters

    • appId: string

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

    • eventType: Models.EventType

      The type of events to query; either a standard event type (traces, customEvents, pageViews, requests, dependencies, exceptions, availabilityResults) or $all to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'

    • eventId: string

      ID of event.

    • Optional options: Models.EventsGetOptionalParams

    Returns Promise<Models.EventsGetResponse>

    Promise<Models.EventsGetResponse>

  • Parameters

    • appId: string

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

    • eventType: Models.EventType

      The type of events to query; either a standard event type (traces, customEvents, pageViews, requests, dependencies, exceptions, availabilityResults) or $all to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'

    • eventId: string

      ID of event.

    • callback: msRest.ServiceCallback<EventsResults>

      The callback

    Returns void

  • Parameters

    • appId: string

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

    • eventType: Models.EventType

      The type of events to query; either a standard event type (traces, customEvents, pageViews, requests, dependencies, exceptions, availabilityResults) or $all to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'

    • eventId: string

      ID of event.

    • options: EventsGetOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<EventsResults>

      The callback

    Returns void

getByType

  • getByType(appId: string, eventType: Models.EventType, options?: Models.EventsGetByTypeOptionalParams): Promise<Models.EventsGetByTypeResponse>
  • getByType(appId: string, eventType: Models.EventType, callback: msRest.ServiceCallback<EventsResults>): void
  • getByType(appId: string, eventType: Models.EventType, options: EventsGetByTypeOptionalParams, callback: msRest.ServiceCallback<EventsResults>): void

  • Executes an OData query for events

    summary

    Execute OData query

    Parameters

    • appId: string

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

    • eventType: Models.EventType

      The type of events to query; either a standard event type (traces, customEvents, pageViews, requests, dependencies, exceptions, availabilityResults) or $all to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'

    • Optional options: Models.EventsGetByTypeOptionalParams

    Returns Promise<Models.EventsGetByTypeResponse>

    Promise<Models.EventsGetByTypeResponse>

  • Parameters

    • appId: string

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

    • eventType: Models.EventType

      The type of events to query; either a standard event type (traces, customEvents, pageViews, requests, dependencies, exceptions, availabilityResults) or $all to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'

    • callback: msRest.ServiceCallback<EventsResults>

      The callback

    Returns void

  • Parameters

    • appId: string

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

    • eventType: Models.EventType

      The type of events to query; either a standard event type (traces, customEvents, pageViews, requests, dependencies, exceptions, availabilityResults) or $all to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'

    • options: EventsGetByTypeOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<EventsResults>

      The callback

    Returns void

Generated using TypeDoc