Class MonitoringTemplate

Detailed information of the Monitoring Template

Inheritance

object

MonitoringTemplate

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.StackmonitoringService.Models

Assembly: OCI.DotNetSDK.Stackmonitoring.dll

Syntax

public class MonitoringTemplate

Properties

CompartmentId

Declaration

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

Property Value

Type	Description
string	The OCID of the compartment containing the monitoringTemplate.

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>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

Description

Declaration

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

Property Value

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

Destinations

Declaration

[Required(ErrorMessage = "Destinations is required.")]
[JsonProperty(PropertyName = "destinations")]
public List<string> Destinations { get; set; }

Property Value

Type	Description
List<string>	A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource.

Remarks

Required

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 monitoring template. It should be unique, and it's mutable in nature. 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: {"bar-key": "value"}

Id

Declaration

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

Property Value

Type	Description
string	The OCID of the monitoringTemplate

Remarks

Required

IsAlarmsEnabled

Declaration

[JsonProperty(PropertyName = "isAlarmsEnabled")]
public bool? IsAlarmsEnabled { get; set; }

Property Value

Type	Description
bool?	Whether the alarm is enabled or disabled. Default value is enabled.

IsSplitNotificationEnabled

Declaration

[JsonProperty(PropertyName = "isSplitNotificationEnabled")]
public bool? IsSplitNotificationEnabled { get; set; }

Property Value

Type	Description
bool?	Whether the alarm notification is enabled or disabled, it will be Enabled by default.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public MonitoringTemplateLifeCycleStates? LifecycleState { get; set; }

Property Value

Type	Description
MonitoringTemplateLifeCycleStates?	The current lifecycle state of the monitoring template.

Remarks

Required

Members

Declaration

[Required(ErrorMessage = "Members is required.")]
[JsonProperty(PropertyName = "members")]
public List<MemberReference> Members { get; set; }

Property Value

Type	Description
List<MemberReference>	List of members of this monitoring template.

Remarks

Required

MessageFormat

Declaration

[JsonProperty(PropertyName = "messageFormat")]
[JsonConverter(typeof(ResponseEnumConverter))]
public MessageFormat? MessageFormat { get; set; }

Property Value

Type	Description
MessageFormat?	The format to use for alarm notifications.

RepeatNotificationDuration

Declaration

[JsonProperty(PropertyName = "repeatNotificationDuration")]
public string RepeatNotificationDuration { get; set; }

Property Value

Type	Description
string	The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum- PT1M. Maximum - P30D.

Status

Declaration

[Required(ErrorMessage = "Status is required.")]
[JsonProperty(PropertyName = "status")]
[JsonConverter(typeof(ResponseEnumConverter))]
public MonitoringTemplateLifeCycleDetails? Status { get; set; }

Property Value

Type	Description
MonitoringTemplateLifeCycleDetails?	The current status of the monitoring template i.e. whether it is Applied or NotApplied.

Remarks

Required

SystemTags

Declaration

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

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TenantId

Declaration

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

Property Value

Type	Description
string	Tenant Identifier OCID

Remarks

Required

TimeCreated

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the monitoringTemplate was created. Format defined by RFC3339.

Remarks

Required

TimeUpdated

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the monitoringTemplate was last updated. Format defined by RFC3339.

Remarks

Required

TotalAlarmConditions

Declaration

[Required(ErrorMessage = "TotalAlarmConditions is required.")]
[JsonProperty(PropertyName = "totalAlarmConditions")]
public float? TotalAlarmConditions { get; set; }

Property Value

Type	Description
float?	Total Alarm Conditions

Remarks

Required

TotalAppliedAlarmConditions

Declaration

[Required(ErrorMessage = "TotalAppliedAlarmConditions is required.")]
[JsonProperty(PropertyName = "totalAppliedAlarmConditions")]
public float? TotalAppliedAlarmConditions { get; set; }

Property Value

Type	Description
float?	Total Applied Alarm Conditions

Remarks

Required