EventsOperations Class

EventsOperations operations.

Inheritance

builtins.object

EventsOperations

Constructor

EventsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Methods

get	Get an event. Gets the data for a single event.
get_by_type	Execute OData query. Executes an OData query for events.
get_odata_metadata	Get OData metadata. Gets OData EDMX metadata describing the event data model.

get

Get an event.

Gets the data for a single event.

get(app_id, event_type, event_id, timespan=None, custom_headers=None, raw=False, **operation_config)

Parameters

app_id

str

Required

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

event_type

str or EventType

Required

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'

event_id

str

Required

ID of event.

timespan

str

default value: None

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.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

EventsResults or ClientRawResponse if raw=true

Return type

EventsResults,

ClientRawResponse

Exceptions

ErrorResponseException

get_by_type

Execute OData query.

Executes an OData query for events.

get_by_type(app_id, event_type, timespan=None, filter=None, search=None, orderby=None, select=None, skip=None, top=None, format=None, count=None, apply=None, custom_headers=None, raw=False, **operation_config)

Parameters

app_id

str

Required

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

event_type

str or EventType

Required

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'

timespan

str

default value: None

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

str

default value: None

An expression used to filter the returned events

search

str

default value: None

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

orderby

str

default value: None

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

select

str

default value: None

Limits the properties to just those requested on each returned event

skip

int

default value: None

The number of items to skip over before returning events

top

int

default value: None

The number of events to return

format

str

default value: None

Format for the returned events

count

bool

default value: None

Request a count of matching items included with the returned events

apply

str

default value: None

An expression used for aggregation over returned events

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

EventsResults or ClientRawResponse if raw=true

Return type

EventsResults,

ClientRawResponse

Exceptions

ErrorResponseException

get_odata_metadata

Get OData metadata.

Gets OData EDMX metadata describing the event data model.

get_odata_metadata(app_id, custom_headers=None, raw=False, **operation_config)

Parameters

app_id

str

Required

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

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

object,

ClientRawResponse

Exceptions

ErrorResponseException

Attributes

models

models = <module 'azure.applicationinsights.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\applicationinsights\\models\\__init__.py'>