DynamicMetricCriteria Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.Monitor.Models
Assembly:
Azure.ResourceManager.Monitor.dll
Package:
Azure.ResourceManager.Monitor v1.3.1
Package:
Azure.ResourceManager.Monitor v1.4.0-beta.1
Source:
DynamicMetricCriteria.cs
Source:
DynamicMetricCriteria.cs

Criterion for dynamic threshold.

public class DynamicMetricCriteria : Azure.ResourceManager.Monitor.Models.MultiMetricCriteria, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Monitor.Models.DynamicMetricCriteria>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Monitor.Models.DynamicMetricCriteria>
type DynamicMetricCriteria = class
    inherit MultiMetricCriteria
    interface IJsonModel<DynamicMetricCriteria>
    interface IPersistableModel<DynamicMetricCriteria>
Public Class DynamicMetricCriteria
Inherits MultiMetricCriteria
Implements IJsonModel(Of DynamicMetricCriteria), IPersistableModel(Of DynamicMetricCriteria)
Inheritance
Object
MultiMetricCriteria
DynamicMetricCriteria
Implements
IJsonModel<DynamicMetricCriteria> IPersistableModel<DynamicMetricCriteria> IPersistableModel<T>

Constructors

DynamicMetricCriteria(String, String, MetricCriteriaTimeAggregationType, DynamicThresholdOperator, DynamicThresholdSensitivity, DynamicThresholdFailingPeriods)

Initializes a new instance of DynamicMetricCriteria.

Properties

AdditionalProperties

Additional Properties

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from MultiMetricCriteria)
AlertSensitivity

The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric series pattern.
Dimensions

List of dimension conditions.

(Inherited from MultiMetricCriteria)
FailingPeriods

The minimum number of violations required within the selected lookback time window required to raise an alert.
IgnoreDataBefore

Use this option to set the date from which to start learning the metric historical data and calculate the dynamic thresholds (in ISO8601 format).
MetricName

Name of the metric.

(Inherited from MultiMetricCriteria)
MetricNamespace

Namespace of the metric.

(Inherited from MultiMetricCriteria)
Name

Name of the criteria.

(Inherited from MultiMetricCriteria)
Operator

The operator used to compare the metric value against the threshold.
SkipMetricValidation

Allows creating an alert rule on a custom metric that isn't yet emitted, by causing the metric validation to be skipped.

(Inherited from MultiMetricCriteria)
TimeAggregation

the criteria time aggregation types.

(Inherited from MultiMetricCriteria)

Explicit Interface Implementations

IJsonModel<DynamicMetricCriteria>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<DynamicMetricCriteria>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IJsonModel<MultiMetricCriteria>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from MultiMetricCriteria)
IJsonModel<MultiMetricCriteria>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from MultiMetricCriteria)
IPersistableModel<DynamicMetricCriteria>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<DynamicMetricCriteria>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<DynamicMetricCriteria>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.
IPersistableModel<MultiMetricCriteria>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from MultiMetricCriteria)
IPersistableModel<MultiMetricCriteria>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from MultiMetricCriteria)
IPersistableModel<MultiMetricCriteria>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from MultiMetricCriteria)

Applies to