Oracle Cloud Infrastructure v1.33.0, Apr 25 24

Oracle Cloud Infrastructure v1.33.0 published on Thursday, Apr 25, 2024 by Pulumi

oci.Monitoring.getAlarmSuppressions

Explore with Pulumi AI

Oracle Cloud Infrastructure v1.33.0 published on Thursday, Apr 25, 2024 by Pulumi

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 testAlarmSuppressions = oci.Monitoring.getAlarmSuppressions({
    alarmId: testAlarm.id,
    displayName: alarmSuppressionDisplayName,
    state: alarmSuppressionState,
});

import pulumi
import pulumi_oci as oci

test_alarm_suppressions = oci.Monitoring.get_alarm_suppressions(alarm_id=test_alarm["id"],
    display_name=alarm_suppression_display_name,
    state=alarm_suppression_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.GetAlarmSuppressions(ctx, &monitoring.GetAlarmSuppressionsArgs{
			AlarmId:     testAlarm.Id,
			DisplayName: pulumi.StringRef(alarmSuppressionDisplayName),
			State:       pulumi.StringRef(alarmSuppressionState),
		}, 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 testAlarmSuppressions = Oci.Monitoring.GetAlarmSuppressions.Invoke(new()
    {
        AlarmId = testAlarm.Id,
        DisplayName = alarmSuppressionDisplayName,
        State = alarmSuppressionState,
    });

});

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.GetAlarmSuppressionsArgs;
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 testAlarmSuppressions = MonitoringFunctions.getAlarmSuppressions(GetAlarmSuppressionsArgs.builder()
            .alarmId(testAlarm.id())
            .displayName(alarmSuppressionDisplayName)
            .state(alarmSuppressionState)
            .build());

    }
}

variables:
  testAlarmSuppressions:
    fn::invoke:
      Function: oci:Monitoring:getAlarmSuppressions
      Arguments:
        alarmId: ${testAlarm.id}
        displayName: ${alarmSuppressionDisplayName}
        state: ${alarmSuppressionState}

Using getAlarmSuppressions

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 getAlarmSuppressions(args: GetAlarmSuppressionsArgs, opts?: InvokeOptions): Promise<GetAlarmSuppressionsResult>
function getAlarmSuppressionsOutput(args: GetAlarmSuppressionsOutputArgs, opts?: InvokeOptions): Output<GetAlarmSuppressionsResult>

def get_alarm_suppressions(alarm_id: Optional[str] = None,
                           display_name: Optional[str] = None,
                           filters: Optional[Sequence[_monitoring.GetAlarmSuppressionsFilter]] = None,
                           state: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetAlarmSuppressionsResult
def get_alarm_suppressions_output(alarm_id: Optional[pulumi.Input[str]] = None,
                           display_name: Optional[pulumi.Input[str]] = None,
                           filters: Optional[pulumi.Input[Sequence[pulumi.Input[_monitoring.GetAlarmSuppressionsFilterArgs]]]] = None,
                           state: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetAlarmSuppressionsResult]

func GetAlarmSuppressions(ctx *Context, args *GetAlarmSuppressionsArgs, opts ...InvokeOption) (*GetAlarmSuppressionsResult, error)
func GetAlarmSuppressionsOutput(ctx *Context, args *GetAlarmSuppressionsOutputArgs, opts ...InvokeOption) GetAlarmSuppressionsResultOutput

> Note: This function is named GetAlarmSuppressions in the Go SDK.

public static class GetAlarmSuppressions 
{
    public static Task<GetAlarmSuppressionsResult> InvokeAsync(GetAlarmSuppressionsArgs args, InvokeOptions? opts = null)
    public static Output<GetAlarmSuppressionsResult> Invoke(GetAlarmSuppressionsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAlarmSuppressionsResult> getAlarmSuppressions(GetAlarmSuppressionsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:Monitoring/getAlarmSuppressions:getAlarmSuppressions
  arguments:
    # arguments dictionary

The following arguments are supported:

AlarmId string: The OCID of the alarm that is the target of the alarm suppression.
DisplayName string: A filter to return only resources that match the given display name exactly. Use this filter to list a alarm suppression by name. Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation.
Filters List<GetAlarmSuppressionsFilter>
State string: A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed.

AlarmId string: The OCID of the alarm that is the target of the alarm suppression.
DisplayName string: A filter to return only resources that match the given display name exactly. Use this filter to list a alarm suppression by name. Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation.
Filters []GetAlarmSuppressionsFilter
State string: A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed.

alarmId String: The OCID of the alarm that is the target of the alarm suppression.
displayName String: A filter to return only resources that match the given display name exactly. Use this filter to list a alarm suppression by name. Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation.
filters List<GetAlarmSuppressionsFilter>
state String: A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed.

alarmId string: The OCID of the alarm that is the target of the alarm suppression.
displayName string: A filter to return only resources that match the given display name exactly. Use this filter to list a alarm suppression by name. Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation.
filters GetAlarmSuppressionsFilter[]
state string: A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed.

alarm_id str: The OCID of the alarm that is the target of the alarm suppression.
display_name str: A filter to return only resources that match the given display name exactly. Use this filter to list a alarm suppression by name. Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation.
filters Sequence[monitoring.GetAlarmSuppressionsFilter]
state str: A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed.

alarmId String: The OCID of the alarm that is the target of the alarm suppression.
displayName String: A filter to return only resources that match the given display name exactly. Use this filter to list a alarm suppression by name. Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation.
filters List<Property Map>
state String: A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed.

getAlarmSuppressions Result

The following output properties are available:

AlarmId string: The OCID of the alarm that is the target of the alarm suppression.
AlarmSuppressionCollections List<GetAlarmSuppressionsAlarmSuppressionCollection>: The list of alarm_suppression_collection.
Id string: The provider-assigned unique ID for this managed resource.
DisplayName string: A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
Filters List<GetAlarmSuppressionsFilter>
State string: The current lifecycle state of the alarm suppression. Example: DELETED

AlarmId string: The OCID of the alarm that is the target of the alarm suppression.
AlarmSuppressionCollections []GetAlarmSuppressionsAlarmSuppressionCollection: The list of alarm_suppression_collection.
Id string: The provider-assigned unique ID for this managed resource.
DisplayName string: A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
Filters []GetAlarmSuppressionsFilter
State string: The current lifecycle state of the alarm suppression. Example: DELETED

alarmId String: The OCID of the alarm that is the target of the alarm suppression.
alarmSuppressionCollections List<GetAlarmSuppressionsAlarmSuppressionCollection>: The list of alarm_suppression_collection.
id String: The provider-assigned unique ID for this managed resource.
displayName String: A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
filters List<GetAlarmSuppressionsFilter>
state String: The current lifecycle state of the alarm suppression. Example: DELETED

alarmId string: The OCID of the alarm that is the target of the alarm suppression.
alarmSuppressionCollections GetAlarmSuppressionsAlarmSuppressionCollection[]: The list of alarm_suppression_collection.
id string: The provider-assigned unique ID for this managed resource.
displayName string: A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
filters GetAlarmSuppressionsFilter[]
state string: The current lifecycle state of the alarm suppression. Example: DELETED

alarm_id str: The OCID of the alarm that is the target of the alarm suppression.
alarm_suppression_collections Sequence[monitoring.GetAlarmSuppressionsAlarmSuppressionCollection]: The list of alarm_suppression_collection.
id str: The provider-assigned unique ID for this managed resource.
display_name str: A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
filters Sequence[monitoring.GetAlarmSuppressionsFilter]
state str: The current lifecycle state of the alarm suppression. Example: DELETED

alarmId String: The OCID of the alarm that is the target of the alarm suppression.
alarmSuppressionCollections List<Property Map>: The list of alarm_suppression_collection.
id String: The provider-assigned unique ID for this managed resource.
displayName String: A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
filters List<Property Map>
state String: The current lifecycle state of the alarm suppression. Example: DELETED

Supporting Types

GetAlarmSuppressionsAlarmSuppressionCollection

Items List<GetAlarmSuppressionsAlarmSuppressionCollectionItem>

Items []GetAlarmSuppressionsAlarmSuppressionCollectionItem

items List<GetAlarmSuppressionsAlarmSuppressionCollectionItem>

items GetAlarmSuppressionsAlarmSuppressionCollectionItem[]

items Sequence[monitoring.GetAlarmSuppressionsAlarmSuppressionCollectionItem]

items List<Property Map>

GetAlarmSuppressionsAlarmSuppressionCollectionItem

AlarmSuppressionTargets List<GetAlarmSuppressionsAlarmSuppressionCollectionItemAlarmSuppressionTarget>: The target of the alarm suppression.
CompartmentId string: The OCID of the compartment containing the alarm suppression.
DefinedTags Dictionary<string, object>: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
Description string: Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
Dimensions Dictionary<string, object>: Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs. Example: {"resourceId": "instance.region1.phx.exampleuniqueID"}
DisplayName string: A filter to return only resources that match the given display name exactly. Use this filter to list a alarm suppression by name. Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation.
FreeformTags 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 suppression.
State string: A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed.
TimeCreated string: The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
TimeSuppressFrom string: The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
TimeSuppressUntil string: The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T02:02:29.600Z
TimeUpdated string: The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z

AlarmSuppressionTargets []GetAlarmSuppressionsAlarmSuppressionCollectionItemAlarmSuppressionTarget: The target of the alarm suppression.
CompartmentId string: The OCID of the compartment containing the alarm suppression.
DefinedTags map[string]interface{}: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
Description string: Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
Dimensions map[string]interface{}: Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs. Example: {"resourceId": "instance.region1.phx.exampleuniqueID"}
DisplayName string: A filter to return only resources that match the given display name exactly. Use this filter to list a alarm suppression by name. Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation.
FreeformTags 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 suppression.
State string: A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed.
TimeCreated string: The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
TimeSuppressFrom string: The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
TimeSuppressUntil string: The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T02:02:29.600Z
TimeUpdated string: The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z

alarmSuppressionTargets List<GetAlarmSuppressionsAlarmSuppressionCollectionItemAlarmSuppressionTarget>: The target of the alarm suppression.
compartmentId String: The OCID of the compartment containing the alarm suppression.
definedTags Map<String,Object>: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
description String: Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
dimensions Map<String,Object>: Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs. Example: {"resourceId": "instance.region1.phx.exampleuniqueID"}
displayName String: A filter to return only resources that match the given display name exactly. Use this filter to list a alarm suppression by name. Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation.
freeformTags 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 suppression.
state String: A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed.
timeCreated String: The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
timeSuppressFrom String: The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
timeSuppressUntil String: The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T02:02:29.600Z
timeUpdated String: The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z

alarmSuppressionTargets GetAlarmSuppressionsAlarmSuppressionCollectionItemAlarmSuppressionTarget[]: The target of the alarm suppression.
compartmentId string: The OCID of the compartment containing the alarm suppression.
definedTags {[key: string]: any}: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
description string: Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
dimensions {[key: string]: any}: Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs. Example: {"resourceId": "instance.region1.phx.exampleuniqueID"}
displayName string: A filter to return only resources that match the given display name exactly. Use this filter to list a alarm suppression by name. Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation.
freeformTags {[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 suppression.
state string: A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed.
timeCreated string: The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
timeSuppressFrom string: The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
timeSuppressUntil string: The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T02:02:29.600Z
timeUpdated string: The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z

alarm_suppression_targets Sequence[monitoring.GetAlarmSuppressionsAlarmSuppressionCollectionItemAlarmSuppressionTarget]: The target of the alarm suppression.
compartment_id str: The OCID of the compartment containing the alarm suppression.
defined_tags Mapping[str, Any]: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
description str: Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
dimensions Mapping[str, Any]: Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs. Example: {"resourceId": "instance.region1.phx.exampleuniqueID"}
display_name str: A filter to return only resources that match the given display name exactly. Use this filter to list a alarm suppression by name. Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation.
freeform_tags 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 suppression.
state str: A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed.
time_created str: The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
time_suppress_from str: The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
time_suppress_until str: The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T02:02:29.600Z
time_updated str: The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z

alarmSuppressionTargets List<Property Map>: The target of the alarm suppression.
compartmentId String: The OCID of the compartment containing the alarm suppression.
definedTags Map<Any>: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
description String: Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
dimensions Map<Any>: Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs. Example: {"resourceId": "instance.region1.phx.exampleuniqueID"}
displayName String: A filter to return only resources that match the given display name exactly. Use this filter to list a alarm suppression by name. Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation.
freeformTags 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 suppression.
state String: A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed.
timeCreated String: The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
timeSuppressFrom String: The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
timeSuppressUntil String: The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T02:02:29.600Z
timeUpdated String: The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z

GetAlarmSuppressionsAlarmSuppressionCollectionItemAlarmSuppressionTarget

AlarmId string: The OCID of the alarm that is the target of the alarm suppression.
TargetType string: The type of the alarm suppression target.

AlarmId string: The OCID of the alarm that is the target of the alarm suppression.
TargetType string: The type of the alarm suppression target.

alarmId String: The OCID of the alarm that is the target of the alarm suppression.
targetType String: The type of the alarm suppression target.

alarmId string: The OCID of the alarm that is the target of the alarm suppression.
targetType string: The type of the alarm suppression target.

alarm_id str: The OCID of the alarm that is the target of the alarm suppression.
target_type str: The type of the alarm suppression target.

alarmId String: The OCID of the alarm that is the target of the alarm suppression.
targetType String: The type of the alarm suppression target.

GetAlarmSuppressionsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v1.33.0 published on Thursday, Apr 25, 2024 by Pulumi

pulumi/pulumi-oci

oci.Monitoring.getAlarmSuppressions

On this page

On this page

Example Usage

Using getAlarmSuppressions

getAlarmSuppressions Result

Supporting Types

GetAlarmSuppressionsAlarmSuppressionCollection

GetAlarmSuppressionsAlarmSuppressionCollectionItem

GetAlarmSuppressionsAlarmSuppressionCollectionItemAlarmSuppressionTarget

GetAlarmSuppressionsFilter

Package Details

On this page

On this page