Class CreateAlarmSuppressionDetails

The configuration details for creating an alarm suppression.

Inheritance

object

CreateAlarmSuppressionDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.MonitoringService.Models

Assembly: OCI.DotNetSDK.Monitoring.dll

Syntax

public class CreateAlarmSuppressionDetails

Properties

AlarmSuppressionTarget

Declaration

[Required(ErrorMessage = "AlarmSuppressionTarget is required.")]
[JsonProperty(PropertyName = "alarmSuppressionTarget")]
public AlarmSuppressionTarget AlarmSuppressionTarget { get; set; }

Property Value

Type	Description
AlarmSuppressionTarget

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information. Oracle recommends including tracking information for the event or associated work, such as a ticket number. Example: Planned outage due to change IT-1234.

Dimensions

Declaration

[JsonProperty(PropertyName = "dimensions")]
public Dictionary<string, string> Dimensions { get; set; }

Property Value

Type Description

Type	Description
Dictionary<string, string>	A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify {"availabilityDomain": "phx-ad-1"} and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}, then this alarm will be included for suppression. This is required only when the value of level is `DIMENSION`. If required, the value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is `HTTP 400` with an "dimensions values are too long" message.

Dictionary<string, string>

A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify {"availabilityDomain": "phx-ad-1"} and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}, then this alarm will be included for suppression.
This is required only when the value of level is DIMENSION. If required, the value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is HTTP 400 with an "dimensions values are too long" message.

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.

Remarks

Required

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}

Level

Declaration

[JsonProperty(PropertyName = "level")]
[JsonConverter(typeof(StringEnumConverter))]
public AlarmSuppression.LevelEnum? Level { get; set; }

Property Value

Type	Description
AlarmSuppression.LevelEnum?	The level of this alarm suppression. `ALARM` indicates a suppression of the entire alarm, regardless of dimension. `DIMENSION` indicates a suppression configured for specified dimensions. Defaut: `DIMENSION`

SuppressionConditions

Declaration

[JsonProperty(PropertyName = "suppressionConditions")]
public List<SuppressionCondition> SuppressionConditions { get; set; }

Property Value

Type	Description
List<SuppressionCondition>	Array of all preconditions for alarm suppression. Example: [{ conditionType: "RECURRENCE", suppressionRecurrence: "FRQ=DAILY;BYHOUR=10", suppressionDuration: "PT1H"}]

TimeSuppressFrom

Declaration

[Required(ErrorMessage = "TimeSuppressFrom is required.")]
[JsonProperty(PropertyName = "timeSuppressFrom")]
public DateTime? TimeSuppressFrom { get; set; }

Property Value

Type	Description
DateTime?	The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z

Remarks

Required

TimeSuppressUntil

Declaration

[Required(ErrorMessage = "TimeSuppressUntil is required.")]
[JsonProperty(PropertyName = "timeSuppressUntil")]
public DateTime? TimeSuppressUntil { get; set; }

Property Value

Type	Description
DateTime?	The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z

Remarks

Required