services_metric_metadata

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

Overview

Name	services_metric_metadata
Type	Resource
Id	azure.ad_hybrid_health_service.services_metric_metadata

Fields

The following fields are returned by SELECT queries:

get

The metric metadata for a given metric.

Name	Datatype	Description
displayName	string	The display name for the metric.
groupings	array	The groupings for the metrics.
isDefault	boolean	Indicates if the metric is a default metric or not.
isDevOps	boolean	Indicates if the metric is visible to DevOps or not.
isPerfCounter	boolean	Indicates if the metric is a performance counter metric or not.
kind	string	Indicates whether the dashboard to represent the metric is a line, bar,pie, area or donut chart.
maxValue	integer	The maximum value.
metricName	string	The metric name
metricsProcessorClassName	string	The name of the class which retrieve and process the metric.
minValue	integer	The minimum value.
valueKind	string	Indicates if the metrics is a rate,value, percent or duration type.

list

The list of metric metadata for a given service.

Name	Datatype	Description
displayName	string	The display name for the metric.
groupings	array	The groupings for the metrics.
isDefault	boolean	Indicates if the metric is a default metric or not.
isDevOps	boolean	Indicates if the metric is visible to DevOps or not.
isPerfCounter	boolean	Indicates if the metric is a performance counter metric or not.
kind	string	Indicates whether the dashboard to represent the metric is a line, bar,pie, area or donut chart.
maxValue	integer	The maximum value.
metricName	string	The metric name
metricsProcessorClassName	string	The name of the class which retrieve and process the metric.
minValue	integer	The minimum value.
valueKind	string	Indicates if the metrics is a rate,value, percent or duration type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	serviceName, metricName		Gets the service related metrics information.
list	select	serviceName	$filter, perfCounter	Gets the service related metrics information.

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
metricName	string	The metric name
serviceName	string	The name of the service.
$filter	string	The metric metadata property filter to apply.
perfCounter	boolean	Indicates if only performance counter metrics are requested.

SELECT examples

get

Gets the service related metrics information.

SELECT
displayName,
groupings,
isDefault,
isDevOps,
isPerfCounter,
kind,
maxValue,
metricName,
metricsProcessorClassName,
minValue,
valueKind
FROM azure.ad_hybrid_health_service.services_metric_metadata
WHERE serviceName = '{{ serviceName }}' -- required
AND metricName = '{{ metricName }}' -- required
;

list

Gets the service related metrics information.

SELECT
displayName,
groupings,
isDefault,
isDevOps,
isPerfCounter,
kind,
maxValue,
metricName,
metricsProcessorClassName,
minValue,
valueKind
FROM azure.ad_hybrid_health_service.services_metric_metadata
WHERE serviceName = '{{ serviceName }}' -- required
AND $filter = '{{ $filter }}'
AND perfCounter = '{{ perfCounter }}'
;