reports

Creates, updates, deletes, gets or lists a reports resource.

Overview

Name	reports
Type	Resource
Id	azure.front_door.reports

Fields

The following fields are returned by SELECT queries:

get_timeseries

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
aggregationInterval	string	The aggregation interval of the Timeseries. Known values are: "Hourly" and "Daily". (Hourly, Daily)
country	string	The country associated with the Timeseries. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html _.
endDateTimeUTC	string	The end DateTime of the Timeseries in UTC.
endpoint	string	The endpoint associated with the Timeseries data point.
location	string	Resource location.
startDateTimeUTC	string	The start DateTime of the Timeseries in UTC.
tags	object	Resource tags.
timeseriesData	array	The set of data points for the timeseries.
timeseriesType	string	The type of Timeseries. Known values are: "MeasurementCounts", "LatencyP50", "LatencyP75", and "LatencyP95". (MeasurementCounts, LatencyP50, LatencyP75, LatencyP95)
type	string	Resource type.

get_latency_scorecards

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
country	string	The country associated with the Latency Scorecard. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html _.
description	string	The description of the Latency Scorecard.
endDateTimeUTC	string (date-time)	The end time of the Latency Scorecard in UTC.
endpointA	string	The A endpoint in the scorecard.
endpointB	string	The B endpoint in the scorecard.
latencyMetrics	array	The latency metrics of the Latency Scorecard.
location	string	Resource location.
startDateTimeUTC	string (date-time)	The start time of the Latency Scorecard in UTC.
tags	object	Resource tags.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_timeseries	select	resource_group_name, profile_name, experiment_name, subscription_id, startDateTimeUTC, endDateTimeUTC, aggregationInterval, timeseriesType	endpoint, country	Gets a Timeseries for a given Experiment. Gets a Timeseries for a given Experiment.
get_latency_scorecards	select	resource_group_name, profile_name, experiment_name, subscription_id, aggregationInterval	endDateTimeUTC, country	Gets a Latency Scorecard for a given Experiment. Gets a Latency Scorecard for a given Experiment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
aggregationInterval	string	The aggregation interval of the Latency Scorecard. Known values are: "Daily", "Weekly", and "Monthly". Required.
endDateTimeUTC	string (date-time)	The end DateTime of the Timeseries in UTC. Required.
experiment_name	string	The Experiment identifier associated with the Experiment. Required.
profile_name	string	The Profile identifier associated with the Tenant and Partner. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
startDateTimeUTC	string (date-time)	The start DateTime of the Timeseries in UTC. Required.
subscription_id	string
timeseriesType	string	The type of Timeseries. Known values are: "MeasurementCounts", "LatencyP50", "LatencyP75", and "LatencyP95". Required.
country	string	The country associated with the Latency Scorecard. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html _. Default value is None.
endDateTimeUTC	string	The end DateTime of the Latency Scorecard in UTC. Default value is None.
endpoint	string	The specific endpoint. Default value is None.

SELECT examples

get_timeseries

Gets a Timeseries for a given Experiment. Gets a Timeseries for a given Experiment.

SELECT
id,
name,
aggregationInterval,
country,
endDateTimeUTC,
endpoint,
location,
startDateTimeUTC,
tags,
timeseriesData,
timeseriesType,
type
FROM azure.front_door.reports
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND experiment_name = '{{ experiment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND startDateTimeUTC = '{{ startDateTimeUTC }}' -- required
AND endDateTimeUTC = '{{ endDateTimeUTC }}' -- required
AND aggregationInterval = '{{ aggregationInterval }}' -- required
AND timeseriesType = '{{ timeseriesType }}' -- required
AND endpoint = '{{ endpoint }}'
AND country = '{{ country }}'
;

get_latency_scorecards

Gets a Latency Scorecard for a given Experiment. Gets a Latency Scorecard for a given Experiment.

SELECT
id,
name,
country,
description,
endDateTimeUTC,
endpointA,
endpointB,
latencyMetrics,
location,
startDateTimeUTC,
tags,
type
FROM azure.front_door.reports
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND experiment_name = '{{ experiment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND aggregationInterval = '{{ aggregationInterval }}' -- required
AND endDateTimeUTC = '{{ endDateTimeUTC }}'
AND country = '{{ country }}'
;