Language

PrometheusMetricsSignal Class

Definition

A Prometheus Metrics Query signal instance assigned to an entity.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models.PrometheusMetricsSignalTypeConverter))]
public class PrometheusMetricsSignal : Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models.IPrometheusMetricsSignal, Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models.PrometheusMetricsSignalTypeConverter))>]
type PrometheusMetricsSignal = class
    interface IPrometheusMetricsSignal
    interface IJsonSerializable
    interface ISignalInstanceProperties
    interface IValidates
Public Class PrometheusMetricsSignal
Implements IPrometheusMetricsSignal, IValidates
Inheritance
PrometheusMetricsSignal
Attributes
Implements

Constructors

Name Description
PrometheusMetricsSignal()

Creates an new PrometheusMetricsSignal instance.

Properties

Name Description
DataUnit

Unit of the signal result (e.g. Bytes, MilliSeconds, Percent, Count))

DisplayName

Display name

EvaluationRule

Evaluation rules for the signal definition

Name

Unique name of the signal within the entity.

QueryText

Query text in PromQL syntax

RefreshInterval

Interval in which the signal is being evaluated. Defaults to PT1M (1 minute).

SignalDefinitionName

Optional reference to a signal definition that provides default values.

SignalKind

Kind of the signal instance

StatusAdditionalContext

Additional context as provided by the submitter

StatusError

Error message if the signal status cannot be retrieved

StatusHealthState

Health state of this signal

StatusReportedAt

Timestamp when the value was reported

StatusValue

Reported value of the signal

TimeGrain

Time range of signal. ISO duration format like PT10M.

Methods

Name Description
DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of PrometheusMetricsSignal.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of PrometheusMetricsSignal.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models.IPrometheusMetricsSignal.

FromJsonString(String)

Creates a new instance of PrometheusMetricsSignal, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of PrometheusMetricsSignal into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to