Azure Data Stream Parameters

The Azure plugin provides configurable data streams to fetch cost data and service metrics.

Each configurable data stream exposes a set of parameters that lets you filter the data you retrieve. The following information describes the available configurable data streams and their parameters in detail.

Alerts

Returns Azure Monitor alerts for the resources in scope.

Parameter
Description
Monitor condition
Optionally, specify a monitor condition to filter results by.
Severity
Optionally, specify the severity of the alert to filter results by.

Availability History

Get the availability history of an item or set of items.

Parameter
Description
Column
Select the column the timeframe is applied to. Choose from:
  • Occured Time
  • Reported Time

Synapse Integration Runtime

Returns the state and usage of Synapse integration runtimes, the compute behind Synapse pipelines.

Parameter
Description
Request type
Select the type of runspace data to return. Choose from:
  • List: Returns a list of runspaces in a workspace.
  • Health: Retrains the health of the runspaces
  • Metrics: Returns runspace metrics.

Cost

Returns Azure cost grouped by a dimension you choose, optionally narrowed to one resource type.

Parameter
Description
Group By
Optionally, select a grouping dimension to organize cost data. The chosen fields determines how costs are aggregated and segmented.
Filter
Select a resource type to filter cost data by. This limits the data stream to costs associated only with the chosen Azure resource type, helping you focus on specific areas of spend.
Granularity
Choose the level of time detail for cost data. Granularity determines how costs are broken down over time. A finer granularity gives more detailed insights, while a coarser granularity provides broader cost trend
Metric type
Select the cost measurement to retrieve. Metric type determines whether the data stream returns actual usage-based costs, amortized costs, or other supported cost metrics, allowing you to analyze spend from different perspectives.

Cost (By Tag)

Returns Azure cost grouped by tag, for splitting spend across the teams or environments your tagging already separates.

Parameter
Description
Group by tag
Organize cost data based on up to two a specified tag keys. Costs are aggregated by the values of the selected tag, allowing you to analyze spending across categories.
Filter by tag
Optionally, select a tag value to filter by. This narrows the cost data to resources tagged with the chosen key, helping focus analysis on relevant groups. This field is only enabled when Group by tag is populated.
Metric type
Select the cost measurement to retrieve, allowing you to analyze spend from different perspectives. Choose from:
  • Actual cost: The real charges incurred for resources during the billing period. This reflects what you are actually billed for usage, without spreading costs across other resources.
  • Amortized cost: Costs distributed over time and across related resources. This spreads upfront or shared charges proportionally, giving a more accurate view of total resource usage costs.
Cumulative cost
Select to enable cumulative aggregation. When enabled, costs are summed over time to show running totals, providing a continuous view of spending trends rather than isolated intervals.

Cost (Invoice Details)

Returns Azure cost laid out the way an invoice presents it.

Parameter
Description
Metric type
Select the cost measurement to retrieve, allowing you to analyze spend from different perspectives. Choose from:
  • Actual cost: The real charges incurred for resources during the billing period. This reflects what you are actually billed for usage, without spreading costs across other resources.
  • Amortized cost: Costs distributed over time and across related resources. This spreads upfront or shared charges proportionally, giving a more accurate view of total resource usage costs.

Cost (Location)

Returns Azure cost by location, day by day.

Parameter
Description
Metric type
Select the cost measurement to retrieve, allowing you to analyze spend from different perspectives. Choose from:
  • Actual cost: The real charges incurred for resources during the billing period. This reflects what you are actually billed for usage, without spreading costs across other resources.
  • Amortized cost: Costs distributed over time and across related resources. This spreads upfront or shared charges proportionally, giving a more accurate view of total resource usage costs.

Cost (Service)

Returns Azure cost broken down by service.

Parameter
Description
Metric type
Select the cost measurement to retrieve, allowing you to analyze spend from different perspectives. Choose from:
  • Actual cost: The real charges incurred for resources during the billing period. This reflects what you are actually billed for usage, without spreading costs across other resources.
  • Amortized cost: Costs distributed over time and across related resources. This spreads upfront or shared charges proportionally, giving a more accurate view of total resource usage costs.

Data Explorer KQL Query

Returns the result of a KQL query against an Azure Data Explorer cluster and database.

Parameter
Description
Cluster
Select the cluster that contains the data you want to query. The cluster determines the endpoint where the KQL query will be executed.
Database
Choose the database within the selected cluster that holds the data. This scopes the query to a specific dataset and ensures accurate results.
KQL query
Enter the KQL query to retrieve and analyze data. The query defines the metrics, filters, and transformations applied to the selected database.
It is recommended that you first run the query in Azure to ensure that it isn't retrieving too many results. If the query displays the "Your query is consuming excessive resources" message in Azure, then the SquaredUp tile using that query will timeout.

Guest VM Metrics

Returns metrics from inside a virtual machine, such as those the host cannot see on its own. The Azure Diagnostics agent must be enabled on the VM.

Parameter
Description
Metric name
Select a metric name to return data for.

Log Analytics KQL Query (by resource)

Runs a KQL log query scoped to the resources on the dashboard, so one query can return different data for each.

Parameter
Description
KQL Query
Enter a KQL query to retrieve log analytics data.
It is recommended that you first run the query in Azure to ensure that it isn't retrieving too many results. If the query displays the "Your query is consuming excessive resources" message in Azure, then the SquaredUp tile using that query will timeout.

Log Analytics KQL Query (by workspace)

Runs a KQL query across whole Log Analytics workspaces rather than individual resources.

Parameter
Description
KQL Query
Enter a KQL query to retrieve log analytics data.
It is recommended that you first run the query in Azure to ensure that it isn't retrieving too many results. If the query displays the "Your query is consuming excessive resources" message in Azure, then the SquaredUp tile using that query will timeout.

Metrics

Returns any Azure Monitor metric for the resources in scope.

Parameter
Description
Metric mode
Choose whether to query a single metric or multiple metrics. Advanced options are only available when selecting a single metric.
Metric name
Select a metric from the dropdown to query, for example: TotalRequests.
Aggregation
Optionally, select an aggregation to group the data by.
Advanced (split and filter)
Select to display the Split by dimension and Filter by dimension field sections.
(Split by dimension) Dimension name
Select the Azure metric dimension you want to break down the data by. The dimension is added as a new column containing the dimension values.
Limit
Define the maximum number of dimension values to return. Useful when a dimension has many values but you only want to chart the top N.
(Filter by dimension) Dimension name
Choose the Azure metric dimension you want to filter on.
Dimension values
Select one or more specific values of the chosen dimension to include in your dataset. This helps narrow the data to only relevant subsets.
Roll up filtered values
Enable to roll up filtered values to the next level up. For example, if you are using a Count aggregation filtered to multiple dimension values, selecting this option will return a single aggregated Count across both values.

Reservation Recommendations

Returns Azure's reserved instance recommendations, based on the usage it has seen in scope.

Parameter
Description
Recommendation scope
Choose whether to view recommendations for a Single subscription or across Shared scope (multiple subscriptions).
Resource type
Specify the Azure resource type for which you want to see reservation recommendations.

Resource Compliance

Returns the Azure Policy compliance state of resources, showing what is failing policy.

Parameter
Description
Compliance state
Specify compliance states to filter results by.
Policy Assignments
Select policy assignments to filter results by.

Resource Graph KQL Query

Runs a KQL query against the Azure Resource Graph, for asking questions about resource configuration across subscriptions.

Parameter
Description
KQL Query
Enter the KQL query to retrieve and analyze data. The query defines the metrics, filters, and transformations applied to the selected database.
It is recommended that you first run the query in Azure to ensure that it isn't retrieving too many results. If the query displays the "Your query is consuming excessive resources" message in Azure, then the SquaredUp tile using that query will timeout.
API version
Optionally, enter an API Version to use for the query, for example: 2017-10-01.

Resource Graph KQL Query (object-aware)

The same as Resource Graph KQL Query, with the dashboard's objects available to the query.

Deprecated

This data stream is deprecated. Use Resource Graph KQL Query instead.

Parameter
Description
KQL Query
Enter the KQL query to retrieve and analyze data. The query defines the metrics, filters, and transformations applied to the selected database.
It is recommended that you first run the query in Azure to ensure that it isn't retrieving too many results. If the query displays the "Your query is consuming excessive resources" message in Azure, then the SquaredUp tile using that query will timeout.
API version
Optionally, enter an API Version to use for the query, for example: 2017-10-01.

Savings Plan Recommendations

Returns Azure's savings plan recommendations, based on the usage it has seen in scope.

Parameter
Description
Recommendation Scope
Select the type of scope to use in recommendations. Choose from:
  • Single
  • Shared
Recommendation Term
Select the length of the commitment.

Was this article helpful?

Have more questions or facing an issue?
Submit a ticket