MetricsOperations Class

MetricsOperations operations.

Inheritance

builtins.object

MetricsOperations

Constructor

MetricsOperations(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	Retrieve metric data. Gets metric values for a single metric.
get_metadata	Retrieve metric metatadata. Gets metadata describing the available metrics.
get_multiple	Retrieve metric data. Gets metric values for multiple metrics.

get

Retrieve metric data.

Gets metric values for a single metric.

get(app_id, metric_id, timespan=None, interval=None, aggregation=None, segment=None, top=None, orderby=None, filter=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.

metric_id

str or MetricId

Required

ID of the metric. This is either a standard AI metric, or an application-specific custom metric. Possible values include: 'requests/count', 'requests/duration', 'requests/failed', 'users/count', 'users/authenticated', 'pageViews/count', 'pageViews/duration', 'client/processingDuration', 'client/receiveDuration', 'client/networkDuration', 'client/sendDuration', 'client/totalDuration', 'dependencies/count', 'dependencies/failed', 'dependencies/duration', 'exceptions/count', 'exceptions/browser', 'exceptions/server', 'sessions/count', 'performanceCounters/requestExecutionTime', 'performanceCounters/requestsPerSecond', 'performanceCounters/requestsInQueue', 'performanceCounters/memoryAvailableBytes', 'performanceCounters/exceptionsPerSecond', 'performanceCounters/processCpuPercentage', 'performanceCounters/processIOBytesPerSecond', 'performanceCounters/processPrivateBytes', 'performanceCounters/processorCpuPercentage', 'availabilityResults/availabilityPercentage', 'availabilityResults/duration', 'billing/telemetryCount', 'customEvents/count'

timespan

str

default value: None

The timespan over which to retrieve metric values. This is an ISO8601 time period value. If timespan is omitted, a default time range of PT12H ("last 12 hours") is used. The actual timespan that is queried may be adjusted by the server based. In all cases, the actual time span used for the query is included in the response.

interval

<xref:timedelta>

default value: None

The time interval to use when retrieving metric values. This is an ISO8601 duration. If interval is omitted, the metric value is aggregated across the entire timespan. If interval is supplied, the server may adjust the interval to a more appropriate size based on the timespan used for the query. In all cases, the actual interval used for the query is included in the response.

aggregation

list[str or MetricsAggregation]

default value: None

The aggregation to use when computing the metric values. To retrieve more than one aggregation at a time, separate them with a comma. If no aggregation is specified, then the default aggregation for the metric is used.

segment

list[str or MetricsSegment]

default value: None

The name of the dimension to segment the metric values by. This dimension must be applicable to the metric you are retrieving. To segment by more than one dimension at a time, separate them with a comma (,). In this case, the metric data will be segmented in the order the dimensions are listed in the parameter.

top

int

default value: None

The number of segments to return. This value is only valid when segment is specified.

orderby

str

default value: None

The aggregation function and direction to sort the segments by. This value is only valid when segment is specified.

filter

str

default value: None

An expression used to filter the results. This value should be a valid OData filter expression where the keys of each clause should be applicable dimensions for the metric you are retrieving.

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

MetricsResult or ClientRawResponse if raw=true

Return type

MetricsResult,

ClientRawResponse

Exceptions

ErrorResponseException

get_metadata

Retrieve metric metatadata.

Gets metadata describing the available metrics.

get_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

get_multiple

Retrieve metric data.

Gets metric values for multiple metrics.

get_multiple(app_id, body, 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.

body

list[MetricsPostBodySchema]

Required

The batched metrics query.

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

list or ClientRawResponse if raw=true

Return type

list[MetricsResultsItem],

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'>