Azure plugin

Data streams standardize data from all the different shapes and formats your tools use into a straightforward tabular format.

While creating a tile you can tweak data streams by grouping or aggregating specific columns.

Depending on the kind of data, SquaredUp will automatically suggest how to visualize the result, for example as a table or line graph.

Data streams can be either global or scoped:

• Global data streams are unscoped and return information of a general nature (e.g. "Get the current number of unused hosts").
• A scoped data stream gets information relevant to the specific set objects supplied in the tile scope (e.g. "Get the current session count for these hosts").

See Data Streams for more information.

Allows you to run an Application Insights KQL query. This data stream calls the api.applicationinsights.io endpoint, and allows you to enter a custom application insights KQL query.

1. Scope to a Azure workspace, object that supports KQL queries, or the data source instance itself.

   If you scope to an Azure Application Insights workspace, the name of the data stream will be KQL Query. If you scope to an Azure object or the data source itself, the name of the data stream will be Application Insights Query.

2. Depending on what you have scoped to, select Application Insights Query or KQL Query from the data stream list.
3. For a Application Insights Query select an Application Insights Workspace Name from the dropdown. This the name of the workspace that you wish to query. You will not need to select a name if you have already scoped to a workspace.
4. KQL Query:
   Mustache parameters are only supported if you have scoped to an Azure object and selected the Application Insights Query. Mustache parameters are not supported if you have scoped to a workspace or the data source instance itself.
   Supports mustache parameters

   A mustache parameter is a dynamic value, the actual value will be inserted to replace the field in curly braces. For example, {{timeframe.start}} will insert the start time based on the timeframe configured within the tile, or {{name}} will insert the name of the object(s) in scope.

   This data stream supplies scoped objects individually for mustache parameters. When there are multiple objects in scope this data source will send the query multiple times, once for each object. The results are then displayed together, for example in a single table.

   You can use properties of objects and write them in between curly braces e.g {{name}} to use them as mustache parameters. Whenever you use mustache parameters, you need to use a scope of objects that contain the property you're referencing.

   For example, if objects of type "host" have a property called name, you can use {{name}}. This will resolve {{name}} to the value of the name property of the different "host" objects used in the scope.

5. Optionally, enter a Timeframe, for example: PT12H.
   You must also tick Ignore dashboard timeframe if you want to use the custom timeframe you have entered here.
   ignoreTimeFrame parameter

   Ticking Ignore dashboard timeframe adds the ignoreTimeFrame parameter to the data stream.

   You can add the ignoreTimeFrame parameter and set it to true if you want the query to ignore the current dashboard timeframe of a dashboard.
   If ignoreTimeFrame is left out or set to false, the query will use the current dashboard timeframe.

   What is the dashboard timeframe?

   The dashboard timeframe setting lets you choose the time span that a dashboard displays data for. For example, instead of showing data from the last 12 hours, you can choose to show data from the last 7 days.

   Tiles on a dashboard inherit that dashboard's timeframe by default, meaning that the tile data shown changes whenever you change the dashboard timeframe. However, you can instead choose to set a fixed timeframe for a tile via its timeframe setting.

   Fixed-timeframe tiles display their set timeframe in a bubble next to their title and the tile data does not change when the dashboard timeframe is changed.

   

   If all the tiles on a dashboard use a fixed timeframe then the timeframe dropdown is disabled. Likewise, if a specific timeframe is unsupported then it is disabled in the dropdown.

   You should indicate if a tile's timeframe can be changed in the name of a tile. For example, naming a tile Performance during the last week indicated that the tile always displays data for the last week.

   Setting a default timeframe

   To set the default timeframe for a dashboard, click the pin

   next to an option in the timeframe dropdown. This sets the initial timeframe for all viewers of the dashboard, including shared dashboards.

   

   Cache refresh intervals

   As well as determining the period for the data that displays, the dashboard timeframe also controls the cache refresh frequency of that data. In other words, the timeframe you pick also affects how "fresh" that data is.

   Dashboard timeframe	Cache expiry
   1 hour	1 minute
   12 hours	5 minutes
   24 hours	15 minutes
   7 days	6 hours
   30 days	12 hours
   Up to 6 months	24 hours
   Over 6 months	7 days

6. Optionally, enter an API Version, for example: 2017-10-01.

   If an API Version is specified, the data stream will call the endpoint https://management.azure.com/{{workspace ID}}/query.

Scope

• For an individual budget
• For a scope that a budget can apply to:
  • Subscription
  • Resource Group
  • Billing Profile
  • etc.

This data stream gives you the daily cost over the timeframe you selected for your objects in your scope. You are able to get the total cost of the timeframe for the objects in your scope by grouping them together.

This data stream calls the Azure Cost Management query Microsoft: Query - Usage - REST API (Azure Cost Management).

1. Select the configurableCost data stream (indicated by the Configurable data stream cog). Click Next to go to the Objects tab.
2. On the Objects tab scope to Azure subscriptions, resource groups or management groups. Click Next to go to the Query tab.
3. Optionally, select a Group By entry from the dropdown. You can group the data by any dimension/s, for example ResourceGroupName.
4. Optionally, select a Filter from the dropdown. By default the data is not being filtered. Create a filter if you want to filter data to a specific type of Resources.
5. Select Granularity from the dropdown. Available options are: Daily and None. Daily granularity is useful for when you want to see cost over time in the form of a line graph. None should be selected if you want to show the total cost in the form of donuts and bar charts.

• Includes costs that are paid up front for the year/month/etc.
• If $365 is paid up front, $1 per day is added to the cost to give a more representative view of what something is costing the organization.

• Similar to the 'Invoice details' cost view in the Azure portal
• Configurable
  • Amortized or Actual cost

• Cost broken down by Service/Service Family
• Configurable
  • Amortized or Actual cost

• Cost broken down by Location
• Configurable
  • Amortized or Actual cost

• Cost broken down by tag
• Configurable
  • Group by specific tag key
  • (Optional) Filter by tag value
  • Amortized or Actual cost

For the Cost - Forecast data stream to work you will need to set it to a date in the future, for example: This Month, This Quarter, This Year. The line graph will show 2 lines:

• Daily cost over the selected time as Active cost up to today’s date.
• Forecast line for the rest of the period.

Targets each node in the scope and shows actual and forecast accumulated cost over time. Each day is summary of the total cost so far. Set this data stream to a date in the future like: This Month, This Quarter, This Year. Shows the Actual cost for the timeline in the past and Forecast for the timeline in the future.

Scope

• Billing Account
• Billing Profile

The breakdown of what a user has been charged by Microsoft

• Tax break down
• Free credit deductions
• etc.

Scope

• Billing Account
• Billing Profile

The breakdown of what a user has paid to Microsoft

• The type of payment
• Installments

This data stream calls the api.loganalytics.io endpoint, and allows you to enter a custom log analytics KQL query.

1. In the tile editor, filter by the Azure data source, select KQL (Logs) from the data stream list and then click Next.
2. Select the objects that you want to use and then click Next.
3. Configure the data stream:
   1. KQL Query:
      Enter a KQL query to retrieve log analytics data.
      

      It is recommended that you first run the query in Azure DevOps 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.

      Supports mustache parameters supplied in an array

      A mustache parameter is a dynamic value, the actual value will be inserted to replace the field in curly braces. For example, {{timeframe.start}} will insert the start time based on the timeframe configured within the tile, or {{name}} will insert the name of the object(s) in scope.

      This data stream supplies scoped objects in an array for mustache parameters. When there are multiple objects in scope this data source will send the query once with all the objects in an array.

      When the scoped objects are supplied in an array the normal mustache syntax, for example {{name}}, must be contained between {{#.}} and {{/.}} (the full-stop indicates that the whole object should be used, in this case the array of objects in scope).

      For example, a query where clause might look like:

      Copy

      | where ComputerName in (  {{#.}}    '{{name}}',    {{/.}} '' )

      • The {{#.}} and {{/.}} indicate that what is contained within is expanded for each element in the array of objects.
      • You can use properties of objects and write them in between curly braces e.g {{name}} to use them as mustache parameters. For example, if objects of type "host" have a property called name, you can use {{name}}. This will resolve {{name}} to the value of the name property of the different "host" objects used in the scope.
      • '{{name}}', means that the name property is expanded inside single-quotes with a trailing comma.
      • The trailing single quotes '' are necessary to stop the query being rejected because a trailing comma is disallowed.
      • Whenever you use mustache parameters, you need to use a scope of objects that contain the property you're referencing.

   2. Optionally, enter a Timeframe, for example: PT12H.
      You must also tick Ignore dashboard timeframe if you want to use the custom timeframe you have entered here.
      ignoreTimeFrame parameter

      Ticking Ignore dashboard timeframe adds the ignoreTimeFrame parameter to the data stream.

      You can add the ignoreTimeFrame parameter and set it to true if you want the query to ignore the current dashboard timeframe of a dashboard.
      If ignoreTimeFrame is left out or set to false, the query will use the current dashboard timeframe.

      What is the dashboard timeframe?

      The dashboard timeframe setting lets you choose the time span that a dashboard displays data for. For example, instead of showing data from the last 12 hours, you can choose to show data from the last 7 days.

      Tiles on a dashboard inherit that dashboard's timeframe by default, meaning that the tile data shown changes whenever you change the dashboard timeframe. However, you can instead choose to set a fixed timeframe for a tile via its timeframe setting.

      Fixed-timeframe tiles display their set timeframe in a bubble next to their title and the tile data does not change when the dashboard timeframe is changed.

      

      If all the tiles on a dashboard use a fixed timeframe then the timeframe dropdown is disabled. Likewise, if a specific timeframe is unsupported then it is disabled in the dropdown.

      You should indicate if a tile's timeframe can be changed in the name of a tile. For example, naming a tile Performance during the last week indicated that the tile always displays data for the last week.

      Setting a default timeframe

      To set the default timeframe for a dashboard, click the pin

      next to an option in the timeframe dropdown. This sets the initial timeframe for all viewers of the dashboard, including shared dashboards.

      

      Cache refresh intervals

      As well as determining the period for the data that displays, the dashboard timeframe also controls the cache refresh frequency of that data. In other words, the timeframe you pick also affects how "fresh" that data is.

      Dashboard timeframe	Cache expiry
      1 hour	1 minute
      12 hours	5 minutes
      24 hours	15 minutes
      7 days	6 hours
      30 days	12 hours
      Up to 6 months	24 hours
      Over 6 months	7 days

This data stream allows you to enter a custom KQL query.

1. In the tile editor, filter by the Azure data source, select KQL (Resource Graph) from the data stream list and then click Next.
2. Select the objects that you want to use and then click Next.
3. Configure the data stream:
   1. KQL Query:
      Enter a KQL query to retrieve data from the the Azure resource graph.
      

      It is recommended that you first run the query in Azure DevOps 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.

   2. Optionally, enter an API Version, for example: 2017-10-01.

Queries Azure Metrics. This data stream calls the /{{sourceId}}/providers/microsoft.insights/metrics endpoint, and allows you to select a custom metric name.

1. Scope to an Azure object.
2. Select Monitor Metric from the data stream list.
3. Select the objects you want to use then click Next.
4. Configure the data stream:
   1. Metric Name:
      Select a metric from the dropdown, for example: TotalRequests.

      Any data stream you have created can later be edited from Settings > Data Streams. For example, you may wish to change the shape for timeseries metrics from number to milliseconds.

   2. Aggregation:
      Optionally, select an aggregation to group the data by.
   3. Split/Filter:
      Optionally, select this check box if you want to apply splitting or filtering to the results, then configure the following settings:
      1. Apply Splitting:
         Select the property to split by. For example, StatusCode.
      2. Split Limit:
         Enter a value to limit the number of split results by.
      3. Sort:
         Select whether to display results by Ascending or Descending order. This option is set to Descending by default.
      4. Filter to property:
         Select a property to filter results by. For example, OperationType.
      5. Filter Value:
         Specify values for the filtered property to filter by. For example, ReadFeed and read.
      6. Roll-up filter:
         Select to merge results. For example, this would merge results with the same status codes.

Scope

• Reservation
• Billing Profile
• Billing Account

Gets a historical summary of how a reservation has been applied to other resources.

• e.g. what virtual machine has this reduced the cost of

Scope

• Reservation
• Billing Profile
• Billing Account

Gets a historical summary of how effectively a reservation (or group of reservations) is being used.

Scope

• Subscription
• Resource Group
• Billing Profile

Get recommendations for how to save costs using recommendations.

Configurable

• Scope
  • A single use reservation or a shared reservation
• Resource type
  • Virtual Machine
  • Database
  • etc.

Similar to Reservation Percent Utilization History.

Similar to Reservation Recommendations, with the main difference being that savings plans only support Compute so you don’t get a choice of type.

Configurable

• Scope
  • A single use plan or a shared plan
• Term
  • A 1 year or a 3 year plan

Scope

• For Subscriptions when billing types are imported
• For ‘Billing types’ that support them
  • Billing Accounts
  • Billing Profiles
  • Invoice Sections
  • Customers

Gets a quick now and next view of charges last month and this month

• Intended to be a faster and more reliable replacement to cost where a 'total cost' is required.

Scope

• Billing Accounts
• Billing Profiles
• Invoice Sections
• Customers

The breakdown of charges that have (or will go into) an invoice.

Scope

• Reservations
• Savings Plans

Gets a summary of how effectively you are currently using your reservations.