oci.Monitoring.getAlarm
Explore with Pulumi AI
This data source provides details about a specific Alarm resource in Oracle Cloud Infrastructure Monitoring service.
Gets the specified alarm. For more information, see Getting an Alarm. For important limits information, see Limits on Monitoring.
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testAlarm = oci.Monitoring.getAlarm({
    alarmId: testAlarmOciMonitoringAlarm.id,
});
import pulumi
import pulumi_oci as oci
test_alarm = oci.Monitoring.get_alarm(alarm_id=test_alarm_oci_monitoring_alarm["id"])
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/monitoring"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := monitoring.GetAlarm(ctx, &monitoring.GetAlarmArgs{
			AlarmId: testAlarmOciMonitoringAlarm.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() => 
{
    var testAlarm = Oci.Monitoring.GetAlarm.Invoke(new()
    {
        AlarmId = testAlarmOciMonitoringAlarm.Id,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Monitoring.MonitoringFunctions;
import com.pulumi.oci.Monitoring.inputs.GetAlarmArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var testAlarm = MonitoringFunctions.getAlarm(GetAlarmArgs.builder()
            .alarmId(testAlarmOciMonitoringAlarm.id())
            .build());
    }
}
variables:
  testAlarm:
    fn::invoke:
      function: oci:Monitoring:getAlarm
      arguments:
        alarmId: ${testAlarmOciMonitoringAlarm.id}
Using getAlarm
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getAlarm(args: GetAlarmArgs, opts?: InvokeOptions): Promise<GetAlarmResult>
function getAlarmOutput(args: GetAlarmOutputArgs, opts?: InvokeOptions): Output<GetAlarmResult>def get_alarm(alarm_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetAlarmResult
def get_alarm_output(alarm_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetAlarmResult]func LookupAlarm(ctx *Context, args *LookupAlarmArgs, opts ...InvokeOption) (*LookupAlarmResult, error)
func LookupAlarmOutput(ctx *Context, args *LookupAlarmOutputArgs, opts ...InvokeOption) LookupAlarmResultOutput> Note: This function is named LookupAlarm in the Go SDK.
public static class GetAlarm 
{
    public static Task<GetAlarmResult> InvokeAsync(GetAlarmArgs args, InvokeOptions? opts = null)
    public static Output<GetAlarmResult> Invoke(GetAlarmInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetAlarmResult> getAlarm(GetAlarmArgs args, InvokeOptions options)
public static Output<GetAlarmResult> getAlarm(GetAlarmArgs args, InvokeOptions options)
fn::invoke:
  function: oci:Monitoring/getAlarm:getAlarm
  arguments:
    # arguments dictionaryThe following arguments are supported:
getAlarm Result
The following output properties are available:
- AlarmId string
- AlarmSummary string
- Customizable alarm summary (alarmSummaryalarm message parameter). Optionally include dynamic variables. The alarm summary appears within the body of the alarm message and in responses to ListAlarmStatus GetAlarmHistory and RetrieveDimensionStates.
- Body string
- The human-readable content of the delivered alarm notification. Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution.
- CompartmentId string
- The OCID of the compartment containing the alarm.
- Dictionary<string, string>
- Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
- Destinations List<string>
- A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic. Supported destination services: Notifications, Streaming. Limit: One destination per supported destination service.
- DisplayName string
- A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
- EvaluationSlack stringDuration 
- Customizable slack period to wait for metric ingestion before evaluating the alarm. Specify a string in ISO 8601 format (PT10Mfor ten minutes orPT1Hfor one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. For more information about the slack period, see About the Internal Reset Period.
- 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"}
- Id string
- The OCID of the alarm.
- IsEnabled bool
- Whether the alarm is enabled. Example: true
- IsNotifications boolPer Metric Dimension Enabled 
- Whether the alarm sends a separate message for each metric stream. See Creating an Alarm That Splits Messages by Metric Stream. Example: true
- MessageFormat string
- The format to use for alarm notifications. The formats are:- RAW- Raw JSON blob. Default value. When the- destinationsattribute specifies- Streaming, all alarm notifications use this format.
- PRETTY_JSON: JSON with new lines and indents. Available when the- destinationsattribute specifies- Notificationsonly.
- ONS_OPTIMIZED: Simplified, user-friendly layout. Available when the- destinationsattribute specifies- Notificationsonly. Applies to Email subscription types only.
 
- MetricCompartment stringId 
- The OCID of the compartment containing the metric being evaluated by the alarm.
- MetricCompartment boolId In Subtree 
- When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false. Example: true
- Namespace string
- The source service or application emitting the metric that is evaluated by the alarm. Example: oci_computeagent
- NotificationTitle string
- Customizable notification title (titlealarm message parameter). Optionally include dynamic variables. The notification title appears as the subject line in a formatted email message and as the title in a Slack message.
- NotificationVersion string
- The version of the alarm notification to be delivered. Allowed value: 1.XThe value must start with a number (up to four digits), followed by a period and an uppercase X.
- Overrides
List<GetAlarm Override> 
- A set of overrides that control evaluations of the alarm.
- PendingDuration string
- The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
- Query string
- The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(),groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
- RepeatNotification stringDuration 
- The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4Hindicates four hours. Minimum: PT1M. Maximum: P30D.
- Resolution string
- The time between calculated aggregation windows for the alarm. Supported value: 1m
- ResourceGroup string
- Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: frontend-fleet
- RuleName string
- Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.
- Severity string
- The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL
- State string
- The current lifecycle state of the alarm. Example: DELETED
- Suppressions
List<GetAlarm Suppression> 
- The configuration details for suppressing an alarm.
- TimeCreated string
- The date and time the alarm was created. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
- TimeUpdated string
- The date and time the alarm was last updated. Format defined by RFC3339. Example: 2023-02-03T01:02:29.600Z
- AlarmId string
- AlarmSummary string
- Customizable alarm summary (alarmSummaryalarm message parameter). Optionally include dynamic variables. The alarm summary appears within the body of the alarm message and in responses to ListAlarmStatus GetAlarmHistory and RetrieveDimensionStates.
- Body string
- The human-readable content of the delivered alarm notification. Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution.
- CompartmentId string
- The OCID of the compartment containing the alarm.
- map[string]string
- Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
- Destinations []string
- A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic. Supported destination services: Notifications, Streaming. Limit: One destination per supported destination service.
- DisplayName string
- A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
- EvaluationSlack stringDuration 
- Customizable slack period to wait for metric ingestion before evaluating the alarm. Specify a string in ISO 8601 format (PT10Mfor ten minutes orPT1Hfor one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. For more information about the slack period, see About the Internal Reset Period.
- map[string]string
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
- Id string
- The OCID of the alarm.
- IsEnabled bool
- Whether the alarm is enabled. Example: true
- IsNotifications boolPer Metric Dimension Enabled 
- Whether the alarm sends a separate message for each metric stream. See Creating an Alarm That Splits Messages by Metric Stream. Example: true
- MessageFormat string
- The format to use for alarm notifications. The formats are:- RAW- Raw JSON blob. Default value. When the- destinationsattribute specifies- Streaming, all alarm notifications use this format.
- PRETTY_JSON: JSON with new lines and indents. Available when the- destinationsattribute specifies- Notificationsonly.
- ONS_OPTIMIZED: Simplified, user-friendly layout. Available when the- destinationsattribute specifies- Notificationsonly. Applies to Email subscription types only.
 
- MetricCompartment stringId 
- The OCID of the compartment containing the metric being evaluated by the alarm.
- MetricCompartment boolId In Subtree 
- When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false. Example: true
- Namespace string
- The source service or application emitting the metric that is evaluated by the alarm. Example: oci_computeagent
- NotificationTitle string
- Customizable notification title (titlealarm message parameter). Optionally include dynamic variables. The notification title appears as the subject line in a formatted email message and as the title in a Slack message.
- NotificationVersion string
- The version of the alarm notification to be delivered. Allowed value: 1.XThe value must start with a number (up to four digits), followed by a period and an uppercase X.
- Overrides
[]GetAlarm Override 
- A set of overrides that control evaluations of the alarm.
- PendingDuration string
- The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
- Query string
- The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(),groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
- RepeatNotification stringDuration 
- The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4Hindicates four hours. Minimum: PT1M. Maximum: P30D.
- Resolution string
- The time between calculated aggregation windows for the alarm. Supported value: 1m
- ResourceGroup string
- Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: frontend-fleet
- RuleName string
- Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.
- Severity string
- The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL
- State string
- The current lifecycle state of the alarm. Example: DELETED
- Suppressions
[]GetAlarm Suppression Type 
- The configuration details for suppressing an alarm.
- TimeCreated string
- The date and time the alarm was created. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
- TimeUpdated string
- The date and time the alarm was last updated. Format defined by RFC3339. Example: 2023-02-03T01:02:29.600Z
- alarmId String
- alarmSummary String
- Customizable alarm summary (alarmSummaryalarm message parameter). Optionally include dynamic variables. The alarm summary appears within the body of the alarm message and in responses to ListAlarmStatus GetAlarmHistory and RetrieveDimensionStates.
- body String
- The human-readable content of the delivered alarm notification. Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution.
- compartmentId String
- The OCID of the compartment containing the alarm.
- Map<String,String>
- Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
- destinations List<String>
- A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic. Supported destination services: Notifications, Streaming. Limit: One destination per supported destination service.
- displayName String
- A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
- evaluationSlack StringDuration 
- Customizable slack period to wait for metric ingestion before evaluating the alarm. Specify a string in ISO 8601 format (PT10Mfor ten minutes orPT1Hfor one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. For more information about the slack period, see About the Internal Reset Period.
- Map<String,String>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
- id String
- The OCID of the alarm.
- isEnabled Boolean
- Whether the alarm is enabled. Example: true
- isNotifications BooleanPer Metric Dimension Enabled 
- Whether the alarm sends a separate message for each metric stream. See Creating an Alarm That Splits Messages by Metric Stream. Example: true
- messageFormat String
- The format to use for alarm notifications. The formats are:- RAW- Raw JSON blob. Default value. When the- destinationsattribute specifies- Streaming, all alarm notifications use this format.
- PRETTY_JSON: JSON with new lines and indents. Available when the- destinationsattribute specifies- Notificationsonly.
- ONS_OPTIMIZED: Simplified, user-friendly layout. Available when the- destinationsattribute specifies- Notificationsonly. Applies to Email subscription types only.
 
- metricCompartment StringId 
- The OCID of the compartment containing the metric being evaluated by the alarm.
- metricCompartment BooleanId In Subtree 
- When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false. Example: true
- namespace String
- The source service or application emitting the metric that is evaluated by the alarm. Example: oci_computeagent
- notificationTitle String
- Customizable notification title (titlealarm message parameter). Optionally include dynamic variables. The notification title appears as the subject line in a formatted email message and as the title in a Slack message.
- notificationVersion String
- The version of the alarm notification to be delivered. Allowed value: 1.XThe value must start with a number (up to four digits), followed by a period and an uppercase X.
- overrides
List<GetAlarm Override> 
- A set of overrides that control evaluations of the alarm.
- pendingDuration String
- The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
- query String
- The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(),groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
- repeatNotification StringDuration 
- The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4Hindicates four hours. Minimum: PT1M. Maximum: P30D.
- resolution String
- The time between calculated aggregation windows for the alarm. Supported value: 1m
- resourceGroup String
- Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: frontend-fleet
- ruleName String
- Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.
- severity String
- The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL
- state String
- The current lifecycle state of the alarm. Example: DELETED
- suppressions
List<GetAlarm Suppression> 
- The configuration details for suppressing an alarm.
- timeCreated String
- The date and time the alarm was created. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
- timeUpdated String
- The date and time the alarm was last updated. Format defined by RFC3339. Example: 2023-02-03T01:02:29.600Z
- alarmId string
- alarmSummary string
- Customizable alarm summary (alarmSummaryalarm message parameter). Optionally include dynamic variables. The alarm summary appears within the body of the alarm message and in responses to ListAlarmStatus GetAlarmHistory and RetrieveDimensionStates.
- body string
- The human-readable content of the delivered alarm notification. Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution.
- compartmentId string
- The OCID of the compartment containing the alarm.
- {[key: string]: string}
- Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
- destinations string[]
- A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic. Supported destination services: Notifications, Streaming. Limit: One destination per supported destination service.
- displayName string
- A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
- evaluationSlack stringDuration 
- Customizable slack period to wait for metric ingestion before evaluating the alarm. Specify a string in ISO 8601 format (PT10Mfor ten minutes orPT1Hfor one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. For more information about the slack period, see About the Internal Reset Period.
- {[key: string]: string}
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
- id string
- The OCID of the alarm.
- isEnabled boolean
- Whether the alarm is enabled. Example: true
- isNotifications booleanPer Metric Dimension Enabled 
- Whether the alarm sends a separate message for each metric stream. See Creating an Alarm That Splits Messages by Metric Stream. Example: true
- messageFormat string
- The format to use for alarm notifications. The formats are:- RAW- Raw JSON blob. Default value. When the- destinationsattribute specifies- Streaming, all alarm notifications use this format.
- PRETTY_JSON: JSON with new lines and indents. Available when the- destinationsattribute specifies- Notificationsonly.
- ONS_OPTIMIZED: Simplified, user-friendly layout. Available when the- destinationsattribute specifies- Notificationsonly. Applies to Email subscription types only.
 
- metricCompartment stringId 
- The OCID of the compartment containing the metric being evaluated by the alarm.
- metricCompartment booleanId In Subtree 
- When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false. Example: true
- namespace string
- The source service or application emitting the metric that is evaluated by the alarm. Example: oci_computeagent
- notificationTitle string
- Customizable notification title (titlealarm message parameter). Optionally include dynamic variables. The notification title appears as the subject line in a formatted email message and as the title in a Slack message.
- notificationVersion string
- The version of the alarm notification to be delivered. Allowed value: 1.XThe value must start with a number (up to four digits), followed by a period and an uppercase X.
- overrides
GetAlarm Override[] 
- A set of overrides that control evaluations of the alarm.
- pendingDuration string
- The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
- query string
- The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(),groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
- repeatNotification stringDuration 
- The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4Hindicates four hours. Minimum: PT1M. Maximum: P30D.
- resolution string
- The time between calculated aggregation windows for the alarm. Supported value: 1m
- resourceGroup string
- Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: frontend-fleet
- ruleName string
- Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.
- severity string
- The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL
- state string
- The current lifecycle state of the alarm. Example: DELETED
- suppressions
GetAlarm Suppression[] 
- The configuration details for suppressing an alarm.
- timeCreated string
- The date and time the alarm was created. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
- timeUpdated string
- The date and time the alarm was last updated. Format defined by RFC3339. Example: 2023-02-03T01:02:29.600Z
- alarm_id str
- alarm_summary str
- Customizable alarm summary (alarmSummaryalarm message parameter). Optionally include dynamic variables. The alarm summary appears within the body of the alarm message and in responses to ListAlarmStatus GetAlarmHistory and RetrieveDimensionStates.
- body str
- The human-readable content of the delivered alarm notification. Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution.
- compartment_id str
- The OCID of the compartment containing the alarm.
- Mapping[str, str]
- Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
- destinations Sequence[str]
- A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic. Supported destination services: Notifications, Streaming. Limit: One destination per supported destination service.
- display_name str
- A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
- evaluation_slack_ strduration 
- Customizable slack period to wait for metric ingestion before evaluating the alarm. Specify a string in ISO 8601 format (PT10Mfor ten minutes orPT1Hfor one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. For more information about the slack period, see About the Internal Reset Period.
- Mapping[str, str]
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
- id str
- The OCID of the alarm.
- is_enabled bool
- Whether the alarm is enabled. Example: true
- is_notifications_ boolper_ metric_ dimension_ enabled 
- Whether the alarm sends a separate message for each metric stream. See Creating an Alarm That Splits Messages by Metric Stream. Example: true
- message_format str
- The format to use for alarm notifications. The formats are:- RAW- Raw JSON blob. Default value. When the- destinationsattribute specifies- Streaming, all alarm notifications use this format.
- PRETTY_JSON: JSON with new lines and indents. Available when the- destinationsattribute specifies- Notificationsonly.
- ONS_OPTIMIZED: Simplified, user-friendly layout. Available when the- destinationsattribute specifies- Notificationsonly. Applies to Email subscription types only.
 
- metric_compartment_ strid 
- The OCID of the compartment containing the metric being evaluated by the alarm.
- metric_compartment_ boolid_ in_ subtree 
- When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false. Example: true
- namespace str
- The source service or application emitting the metric that is evaluated by the alarm. Example: oci_computeagent
- notification_title str
- Customizable notification title (titlealarm message parameter). Optionally include dynamic variables. The notification title appears as the subject line in a formatted email message and as the title in a Slack message.
- notification_version str
- The version of the alarm notification to be delivered. Allowed value: 1.XThe value must start with a number (up to four digits), followed by a period and an uppercase X.
- overrides
Sequence[GetAlarm Override] 
- A set of overrides that control evaluations of the alarm.
- pending_duration str
- The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
- query str
- The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(),groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
- repeat_notification_ strduration 
- The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4Hindicates four hours. Minimum: PT1M. Maximum: P30D.
- resolution str
- The time between calculated aggregation windows for the alarm. Supported value: 1m
- resource_group str
- Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: frontend-fleet
- rule_name str
- Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.
- severity str
- The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL
- state str
- The current lifecycle state of the alarm. Example: DELETED
- suppressions
Sequence[GetAlarm Suppression] 
- The configuration details for suppressing an alarm.
- time_created str
- The date and time the alarm was created. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
- time_updated str
- The date and time the alarm was last updated. Format defined by RFC3339. Example: 2023-02-03T01:02:29.600Z
- alarmId String
- alarmSummary String
- Customizable alarm summary (alarmSummaryalarm message parameter). Optionally include dynamic variables. The alarm summary appears within the body of the alarm message and in responses to ListAlarmStatus GetAlarmHistory and RetrieveDimensionStates.
- body String
- The human-readable content of the delivered alarm notification. Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution.
- compartmentId String
- The OCID of the compartment containing the alarm.
- Map<String>
- Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
- destinations List<String>
- A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic. Supported destination services: Notifications, Streaming. Limit: One destination per supported destination service.
- displayName String
- A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
- evaluationSlack StringDuration 
- Customizable slack period to wait for metric ingestion before evaluating the alarm. Specify a string in ISO 8601 format (PT10Mfor ten minutes orPT1Hfor one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. For more information about the slack period, see About the Internal Reset Period.
- Map<String>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
- id String
- The OCID of the alarm.
- isEnabled Boolean
- Whether the alarm is enabled. Example: true
- isNotifications BooleanPer Metric Dimension Enabled 
- Whether the alarm sends a separate message for each metric stream. See Creating an Alarm That Splits Messages by Metric Stream. Example: true
- messageFormat String
- The format to use for alarm notifications. The formats are:- RAW- Raw JSON blob. Default value. When the- destinationsattribute specifies- Streaming, all alarm notifications use this format.
- PRETTY_JSON: JSON with new lines and indents. Available when the- destinationsattribute specifies- Notificationsonly.
- ONS_OPTIMIZED: Simplified, user-friendly layout. Available when the- destinationsattribute specifies- Notificationsonly. Applies to Email subscription types only.
 
- metricCompartment StringId 
- The OCID of the compartment containing the metric being evaluated by the alarm.
- metricCompartment BooleanId In Subtree 
- When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false. Example: true
- namespace String
- The source service or application emitting the metric that is evaluated by the alarm. Example: oci_computeagent
- notificationTitle String
- Customizable notification title (titlealarm message parameter). Optionally include dynamic variables. The notification title appears as the subject line in a formatted email message and as the title in a Slack message.
- notificationVersion String
- The version of the alarm notification to be delivered. Allowed value: 1.XThe value must start with a number (up to four digits), followed by a period and an uppercase X.
- overrides List<Property Map>
- A set of overrides that control evaluations of the alarm.
- pendingDuration String
- The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
- query String
- The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(),groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
- repeatNotification StringDuration 
- The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4Hindicates four hours. Minimum: PT1M. Maximum: P30D.
- resolution String
- The time between calculated aggregation windows for the alarm. Supported value: 1m
- resourceGroup String
- Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: frontend-fleet
- ruleName String
- Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.
- severity String
- The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL
- state String
- The current lifecycle state of the alarm. Example: DELETED
- suppressions List<Property Map>
- The configuration details for suppressing an alarm.
- timeCreated String
- The date and time the alarm was created. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
- timeUpdated String
- The date and time the alarm was last updated. Format defined by RFC3339. Example: 2023-02-03T01:02:29.600Z
Supporting Types
GetAlarmOverride  
- Body string
- The human-readable content of the delivered alarm notification. Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution.
- PendingDuration string
- The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
- Query string
- The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(),groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
- RuleName string
- Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.
- Severity string
- The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL
- Body string
- The human-readable content of the delivered alarm notification. Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution.
- PendingDuration string
- The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
- Query string
- The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(),groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
- RuleName string
- Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.
- Severity string
- The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL
- body String
- The human-readable content of the delivered alarm notification. Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution.
- pendingDuration String
- The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
- query String
- The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(),groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
- ruleName String
- Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.
- severity String
- The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL
- body string
- The human-readable content of the delivered alarm notification. Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution.
- pendingDuration string
- The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
- query string
- The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(),groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
- ruleName string
- Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.
- severity string
- The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL
- body str
- The human-readable content of the delivered alarm notification. Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution.
- pending_duration str
- The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
- query str
- The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(),groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
- rule_name str
- Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.
- severity str
- The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL
- body String
- The human-readable content of the delivered alarm notification. Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution.
- pendingDuration String
- The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
- query String
- The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(),groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
- ruleName String
- Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.
- severity String
- The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL
GetAlarmSuppression  
- Description string
- Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information.
- TimeSuppress stringFrom 
- The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
- TimeSuppress stringUntil 
- The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z
- Description string
- Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information.
- TimeSuppress stringFrom 
- The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
- TimeSuppress stringUntil 
- The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z
- description String
- Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information.
- timeSuppress StringFrom 
- The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
- timeSuppress StringUntil 
- The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z
- description string
- Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information.
- timeSuppress stringFrom 
- The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
- timeSuppress stringUntil 
- The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z
- description str
- Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information.
- time_suppress_ strfrom 
- The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
- time_suppress_ struntil 
- The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z
- description String
- Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information.
- timeSuppress StringFrom 
- The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
- timeSuppress StringUntil 
- The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.