oci.Monitoring.getAlarms
Explore with Pulumi AI
This data source provides the list of Alarms in Oracle Cloud Infrastructure Monitoring service.
Lists the alarms for the specified compartment. 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
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testAlarms = Oci.Monitoring.GetAlarms.Invoke(new()
{
CompartmentId = @var.Compartment_id,
CompartmentIdInSubtree = @var.Alarm_compartment_id_in_subtree,
DisplayName = @var.Alarm_display_name,
State = @var.Alarm_state,
});
});
package main
import (
"github.com/pulumi/pulumi-oci/sdk/go/oci/Monitoring"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Monitoring.GetAlarms(ctx, &monitoring.GetAlarmsArgs{
CompartmentId: _var.Compartment_id,
CompartmentIdInSubtree: pulumi.BoolRef(_var.Alarm_compartment_id_in_subtree),
DisplayName: pulumi.StringRef(_var.Alarm_display_name),
State: pulumi.StringRef(_var.Alarm_state),
}, nil)
if err != nil {
return err
}
return nil
})
}
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.GetAlarmsArgs;
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 testAlarms = MonitoringFunctions.getAlarms(GetAlarmsArgs.builder()
.compartmentId(var_.compartment_id())
.compartmentIdInSubtree(var_.alarm_compartment_id_in_subtree())
.displayName(var_.alarm_display_name())
.state(var_.alarm_state())
.build());
}
}
import pulumi
import pulumi_oci as oci
test_alarms = oci.Monitoring.get_alarms(compartment_id=var["compartment_id"],
compartment_id_in_subtree=var["alarm_compartment_id_in_subtree"],
display_name=var["alarm_display_name"],
state=var["alarm_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testAlarms = oci.Monitoring.getAlarms({
compartmentId: _var.compartment_id,
compartmentIdInSubtree: _var.alarm_compartment_id_in_subtree,
displayName: _var.alarm_display_name,
state: _var.alarm_state,
});
variables:
testAlarms:
fn::invoke:
Function: oci:Monitoring:getAlarms
Arguments:
compartmentId: ${var.compartment_id}
compartmentIdInSubtree: ${var.alarm_compartment_id_in_subtree}
displayName: ${var.alarm_display_name}
state: ${var.alarm_state}
Using getAlarms
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 getAlarms(args: GetAlarmsArgs, opts?: InvokeOptions): Promise<GetAlarmsResult>
function getAlarmsOutput(args: GetAlarmsOutputArgs, opts?: InvokeOptions): Output<GetAlarmsResult>
def get_alarms(compartment_id: Optional[str] = None,
compartment_id_in_subtree: Optional[bool] = None,
display_name: Optional[str] = None,
filters: Optional[Sequence[_monitoring.GetAlarmsFilter]] = None,
state: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAlarmsResult
def get_alarms_output(compartment_id: Optional[pulumi.Input[str]] = None,
compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
display_name: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[_monitoring.GetAlarmsFilterArgs]]]] = None,
state: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAlarmsResult]
func GetAlarms(ctx *Context, args *GetAlarmsArgs, opts ...InvokeOption) (*GetAlarmsResult, error)
func GetAlarmsOutput(ctx *Context, args *GetAlarmsOutputArgs, opts ...InvokeOption) GetAlarmsResultOutput
> Note: This function is named GetAlarms
in the Go SDK.
public static class GetAlarms
{
public static Task<GetAlarmsResult> InvokeAsync(GetAlarmsArgs args, InvokeOptions? opts = null)
public static Output<GetAlarmsResult> Invoke(GetAlarmsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAlarmsResult> getAlarms(GetAlarmsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:Monitoring/getAlarms:getAlarms
arguments:
# arguments dictionary
The following arguments are supported:
- Compartment
Id string The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID
- Compartment
Id boolIn Subtree When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId 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, returns resources from only the compartment specified in compartmentId. Default is false.
- Display
Name string A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
- Filters
List<Get
Alarms Filter> - State string
A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.
- Compartment
Id string The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID
- Compartment
Id boolIn Subtree When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId 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, returns resources from only the compartment specified in compartmentId. Default is false.
- Display
Name string A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
- Filters
[]Get
Alarms Filter - State string
A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.
- compartment
Id String The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID
- compartment
Id BooleanIn Subtree When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId 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, returns resources from only the compartment specified in compartmentId. Default is false.
- display
Name String A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
- filters
List<Get
Alarms Filter> - state String
A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.
- compartment
Id string The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID
- compartment
Id booleanIn Subtree When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId 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, returns resources from only the compartment specified in compartmentId. Default is false.
- display
Name string A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
- filters
Get
Alarms Filter[] - state string
A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.
- compartment_
id str The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID
- compartment_
id_ boolin_ subtree When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId 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, returns resources from only the compartment specified in compartmentId. Default is false.
- display_
name str A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
- filters
Get
Alarms Filter] - state str
A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.
- compartment
Id String The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID
- compartment
Id BooleanIn Subtree When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId 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, returns resources from only the compartment specified in compartmentId. Default is false.
- display
Name String A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
- filters List<Property Map>
- state String
A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.
getAlarms Result
The following output properties are available:
- Alarms
List<Get
Alarms Alarm> The list of alarms.
- Compartment
Id string The OCID of the compartment containing the alarm.
- Id string
The provider-assigned unique ID for this managed resource.
- Compartment
Id boolIn Subtree - Display
Name string A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
- Filters
List<Get
Alarms Filter> - State string
The current lifecycle state of the alarm. Example:
DELETED
- Alarms
[]Get
Alarms Alarm The list of alarms.
- Compartment
Id string The OCID of the compartment containing the alarm.
- Id string
The provider-assigned unique ID for this managed resource.
- Compartment
Id boolIn Subtree - Display
Name string A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
- Filters
[]Get
Alarms Filter - State string
The current lifecycle state of the alarm. Example:
DELETED
- alarms
List<Get
Alarms Alarm> The list of alarms.
- compartment
Id String The OCID of the compartment containing the alarm.
- id String
The provider-assigned unique ID for this managed resource.
- compartment
Id BooleanIn Subtree - display
Name String A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
- filters
List<Get
Alarms Filter> - state String
The current lifecycle state of the alarm. Example:
DELETED
- alarms
Get
Alarms Alarm[] The list of alarms.
- compartment
Id string The OCID of the compartment containing the alarm.
- id string
The provider-assigned unique ID for this managed resource.
- compartment
Id booleanIn Subtree - display
Name string A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
- filters
Get
Alarms Filter[] - state string
The current lifecycle state of the alarm. Example:
DELETED
- alarms
Get
Alarms Alarm] The list of alarms.
- compartment_
id str The OCID of the compartment containing the alarm.
- id str
The provider-assigned unique ID for this managed resource.
- compartment_
id_ boolin_ subtree - display_
name str A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
- filters
Get
Alarms Filter] - state str
The current lifecycle state of the alarm. Example:
DELETED
- alarms List<Property Map>
The list of alarms.
- compartment
Id String The OCID of the compartment containing the alarm.
- id String
The provider-assigned unique ID for this managed resource.
- compartment
Id BooleanIn Subtree - display
Name String A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
- filters List<Property Map>
- state String
The current lifecycle state of the alarm. Example:
DELETED
Supporting Types
GetAlarmsAlarm
- Body string
The human-readable content of the notification delivered. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Example:
High CPU usage alert. Follow runbook instructions for resolution.
- Compartment
Id string The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID
- Dictionary<string, object>
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"Operations.CostCenter": "42"}
- Destinations List<string>
A list of destinations to which the notifications for this alarm will be delivered. Each destination is represented by an OCID related to the supported destination service. For example, a destination using the Notifications service is represented by a topic OCID. Supported destination services: Notifications Service. Limit: One destination per supported destination service.
- Display
Name string A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
- Dictionary<string, object>
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.
- Is
Enabled bool Whether the alarm is enabled. Example:
true
- Is
Notifications boolPer Metric Dimension Enabled When set to
true
, splits notifications per metric stream. When set tofalse
, groups notifications across metric streams. Example:true
- Message
Format string The format to use for notification messages sent from this alarm. The formats are:
- Metric
Compartment stringId 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 string
The source service or application emitting the metric that is evaluated by the alarm. Example:
oci_computeagent
- Pending
Duration 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. Supported grouping functions:
grouping()
,groupBy()
. For details about Monitoring Query Language (MQL), see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.- Repeat
Notification stringDuration The frequency at which notifications are re-submitted, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example,
PT4H
indicates four hours. Minimum: PT1M. Maximum: P30D.- Resolution string
The time between calculated aggregation windows for the alarm. Supported value:
1m
- Resource
Group string Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. 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
- Severity string
The perceived type of response required when the alarm is in the "FIRING" state. Example:
CRITICAL
- State string
A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.
- Suppressions
List<Get
Alarms Alarm Suppression> The configuration details for suppressing an alarm.
- Time
Created string The date and time the alarm was created. Format defined by RFC3339. Example:
2019-02-01T01:02:29.600Z
- Time
Updated string The date and time the alarm was last updated. Format defined by RFC3339. Example:
2019-02-03T01:02:29.600Z
- Body string
The human-readable content of the notification delivered. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Example:
High CPU usage alert. Follow runbook instructions for resolution.
- Compartment
Id string The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID
- map[string]interface{}
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"Operations.CostCenter": "42"}
- Destinations []string
A list of destinations to which the notifications for this alarm will be delivered. Each destination is represented by an OCID related to the supported destination service. For example, a destination using the Notifications service is represented by a topic OCID. Supported destination services: Notifications Service. Limit: One destination per supported destination service.
- Display
Name string A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
- map[string]interface{}
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.
- Is
Enabled bool Whether the alarm is enabled. Example:
true
- Is
Notifications boolPer Metric Dimension Enabled When set to
true
, splits notifications per metric stream. When set tofalse
, groups notifications across metric streams. Example:true
- Message
Format string The format to use for notification messages sent from this alarm. The formats are:
- Metric
Compartment stringId 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 string
The source service or application emitting the metric that is evaluated by the alarm. Example:
oci_computeagent
- Pending
Duration 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. Supported grouping functions:
grouping()
,groupBy()
. For details about Monitoring Query Language (MQL), see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.- Repeat
Notification stringDuration The frequency at which notifications are re-submitted, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example,
PT4H
indicates four hours. Minimum: PT1M. Maximum: P30D.- Resolution string
The time between calculated aggregation windows for the alarm. Supported value:
1m
- Resource
Group string Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. 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
- Severity string
The perceived type of response required when the alarm is in the "FIRING" state. Example:
CRITICAL
- State string
A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.
- Suppressions
[]Get
Alarms Alarm Suppression The configuration details for suppressing an alarm.
- Time
Created string The date and time the alarm was created. Format defined by RFC3339. Example:
2019-02-01T01:02:29.600Z
- Time
Updated string The date and time the alarm was last updated. Format defined by RFC3339. Example:
2019-02-03T01:02:29.600Z
- body String
The human-readable content of the notification delivered. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Example:
High CPU usage alert. Follow runbook instructions for resolution.
- compartment
Id String The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID
- Map<String,Object>
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"Operations.CostCenter": "42"}
- destinations List<String>
A list of destinations to which the notifications for this alarm will be delivered. Each destination is represented by an OCID related to the supported destination service. For example, a destination using the Notifications service is represented by a topic OCID. Supported destination services: Notifications Service. Limit: One destination per supported destination service.
- display
Name String A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
- Map<String,Object>
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.
- is
Enabled Boolean Whether the alarm is enabled. Example:
true
- is
Notifications BooleanPer Metric Dimension Enabled When set to
true
, splits notifications per metric stream. When set tofalse
, groups notifications across metric streams. Example:true
- message
Format String The format to use for notification messages sent from this alarm. The formats are:
- metric
Compartment StringId The OCID of the compartment containing the metric being evaluated by the alarm.
- metric
Compartment 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
- pending
Duration 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. Supported grouping functions:
grouping()
,groupBy()
. For details about Monitoring Query Language (MQL), see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.- repeat
Notification StringDuration The frequency at which notifications are re-submitted, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example,
PT4H
indicates four hours. Minimum: PT1M. Maximum: P30D.- resolution String
The time between calculated aggregation windows for the alarm. Supported value:
1m
- resource
Group String Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. 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
- severity String
The perceived type of response required when the alarm is in the "FIRING" state. Example:
CRITICAL
- state String
A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.
- suppressions
List<Get
Alarms Alarm Suppression> The configuration details for suppressing an alarm.
- time
Created String The date and time the alarm was created. Format defined by RFC3339. Example:
2019-02-01T01:02:29.600Z
- time
Updated String The date and time the alarm was last updated. Format defined by RFC3339. Example:
2019-02-03T01:02:29.600Z
- body string
The human-readable content of the notification delivered. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Example:
High CPU usage alert. Follow runbook instructions for resolution.
- compartment
Id string The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID
- {[key: string]: any}
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"Operations.CostCenter": "42"}
- destinations string[]
A list of destinations to which the notifications for this alarm will be delivered. Each destination is represented by an OCID related to the supported destination service. For example, a destination using the Notifications service is represented by a topic OCID. Supported destination services: Notifications Service. Limit: One destination per supported destination service.
- display
Name string A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
- {[key: string]: any}
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.
- is
Enabled boolean Whether the alarm is enabled. Example:
true
- is
Notifications booleanPer Metric Dimension Enabled When set to
true
, splits notifications per metric stream. When set tofalse
, groups notifications across metric streams. Example:true
- message
Format string The format to use for notification messages sent from this alarm. The formats are:
- metric
Compartment stringId The OCID of the compartment containing the metric being evaluated by the alarm.
- metric
Compartment 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
- pending
Duration 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. Supported grouping functions:
grouping()
,groupBy()
. For details about Monitoring Query Language (MQL), see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.- repeat
Notification stringDuration The frequency at which notifications are re-submitted, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example,
PT4H
indicates four hours. Minimum: PT1M. Maximum: P30D.- resolution string
The time between calculated aggregation windows for the alarm. Supported value:
1m
- resource
Group string Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. 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
- severity string
The perceived type of response required when the alarm is in the "FIRING" state. Example:
CRITICAL
- state string
A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.
- suppressions
Get
Alarms Alarm Suppression[] The configuration details for suppressing an alarm.
- time
Created string The date and time the alarm was created. Format defined by RFC3339. Example:
2019-02-01T01:02:29.600Z
- time
Updated string The date and time the alarm was last updated. Format defined by RFC3339. Example:
2019-02-03T01:02:29.600Z
- body str
The human-readable content of the notification delivered. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Example:
High CPU usage alert. Follow runbook instructions for resolution.
- compartment_
id str The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID
- Mapping[str, Any]
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"Operations.CostCenter": "42"}
- destinations Sequence[str]
A list of destinations to which the notifications for this alarm will be delivered. Each destination is represented by an OCID related to the supported destination service. For example, a destination using the Notifications service is represented by a topic OCID. Supported destination services: Notifications Service. Limit: One destination per supported destination service.
- display_
name str A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
- Mapping[str, Any]
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 When set to
true
, splits notifications per metric stream. When set tofalse
, groups notifications across metric streams. Example:true
- message_
format str The format to use for notification messages sent from this alarm. The formats are:
- 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
- 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. Supported grouping functions:
grouping()
,groupBy()
. For details about Monitoring Query Language (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 at which notifications are re-submitted, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example,
PT4H
indicates 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 to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. 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
- severity str
The perceived type of response required when the alarm is in the "FIRING" state. Example:
CRITICAL
- state str
A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.
- suppressions
Get
Alarms Alarm Suppression] The configuration details for suppressing an alarm.
- time_
created str The date and time the alarm was created. Format defined by RFC3339. Example:
2019-02-01T01:02:29.600Z
- time_
updated str The date and time the alarm was last updated. Format defined by RFC3339. Example:
2019-02-03T01:02:29.600Z
- body String
The human-readable content of the notification delivered. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Example:
High CPU usage alert. Follow runbook instructions for resolution.
- compartment
Id String The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID
- Map<Any>
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"Operations.CostCenter": "42"}
- destinations List<String>
A list of destinations to which the notifications for this alarm will be delivered. Each destination is represented by an OCID related to the supported destination service. For example, a destination using the Notifications service is represented by a topic OCID. Supported destination services: Notifications Service. Limit: One destination per supported destination service.
- display
Name String A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
- Map<Any>
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.
- is
Enabled Boolean Whether the alarm is enabled. Example:
true
- is
Notifications BooleanPer Metric Dimension Enabled When set to
true
, splits notifications per metric stream. When set tofalse
, groups notifications across metric streams. Example:true
- message
Format String The format to use for notification messages sent from this alarm. The formats are:
- metric
Compartment StringId The OCID of the compartment containing the metric being evaluated by the alarm.
- metric
Compartment 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
- pending
Duration 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. Supported grouping functions:
grouping()
,groupBy()
. For details about Monitoring Query Language (MQL), see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.- repeat
Notification StringDuration The frequency at which notifications are re-submitted, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example,
PT4H
indicates four hours. Minimum: PT1M. Maximum: P30D.- resolution String
The time between calculated aggregation windows for the alarm. Supported value:
1m
- resource
Group String Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. 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
- severity String
The perceived type of response required when the alarm is in the "FIRING" state. Example:
CRITICAL
- state String
A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.
- suppressions List<Property Map>
The configuration details for suppressing an alarm.
- time
Created String The date and time the alarm was created. Format defined by RFC3339. Example:
2019-02-01T01:02:29.600Z
- time
Updated String The date and time the alarm was last updated. Format defined by RFC3339. Example:
2019-02-03T01:02:29.600Z
GetAlarmsAlarmSuppression
- Description string
Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information.
- Time
Suppress stringFrom The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example:
2019-02-01T01:02:29.600Z
- Time
Suppress stringUntil The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example:
2019-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.
- Time
Suppress stringFrom The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example:
2019-02-01T01:02:29.600Z
- Time
Suppress stringUntil The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example:
2019-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.
- time
Suppress StringFrom The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example:
2019-02-01T01:02:29.600Z
- time
Suppress StringUntil The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example:
2019-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.
- time
Suppress stringFrom The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example:
2019-02-01T01:02:29.600Z
- time
Suppress stringUntil The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example:
2019-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:
2019-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:
2019-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.
- time
Suppress StringFrom The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example:
2019-02-01T01:02:29.600Z
- time
Suppress StringUntil The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example:
2019-02-01T02:02:29.600Z
GetAlarmsFilter
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.