Oracle Cloud Infrastructure v2.29.0, Apr 9 25

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

oci.Budget.getAlertRules

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testAlertRules = oci.Budget.getAlertRules({
    budgetId: testBudget.id,
    displayName: alertRuleDisplayName,
    state: alertRuleState,
});

import pulumi
import pulumi_oci as oci

test_alert_rules = oci.Budget.get_alert_rules(budget_id=test_budget["id"],
    display_name=alert_rule_display_name,
    state=alert_rule_state)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/budget"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := budget.GetAlertRules(ctx, &budget.GetAlertRulesArgs{
			BudgetId:    testBudget.Id,
			DisplayName: pulumi.StringRef(alertRuleDisplayName),
			State:       pulumi.StringRef(alertRuleState),
		}, 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 testAlertRules = Oci.Budget.GetAlertRules.Invoke(new()
    {
        BudgetId = testBudget.Id,
        DisplayName = alertRuleDisplayName,
        State = alertRuleState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Budget.BudgetFunctions;
import com.pulumi.oci.Budget.inputs.GetAlertRulesArgs;
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 testAlertRules = BudgetFunctions.getAlertRules(GetAlertRulesArgs.builder()
            .budgetId(testBudget.id())
            .displayName(alertRuleDisplayName)
            .state(alertRuleState)
            .build());

    }
}

variables:
  testAlertRules:
    fn::invoke:
      function: oci:Budget:getAlertRules
      arguments:
        budgetId: ${testBudget.id}
        displayName: ${alertRuleDisplayName}
        state: ${alertRuleState}

Using getAlertRules

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.

TypeScript
Python
Go
C#
Java
YAML

function getAlertRules(args: GetAlertRulesArgs, opts?: InvokeOptions): Promise<GetAlertRulesResult>
function getAlertRulesOutput(args: GetAlertRulesOutputArgs, opts?: InvokeOptions): Output<GetAlertRulesResult>

def get_alert_rules(budget_id: Optional[str] = None,
                    display_name: Optional[str] = None,
                    filters: Optional[Sequence[_budget.GetAlertRulesFilter]] = None,
                    state: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetAlertRulesResult
def get_alert_rules_output(budget_id: Optional[pulumi.Input[str]] = None,
                    display_name: Optional[pulumi.Input[str]] = None,
                    filters: Optional[pulumi.Input[Sequence[pulumi.Input[_budget.GetAlertRulesFilterArgs]]]] = None,
                    state: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetAlertRulesResult]

func GetAlertRules(ctx *Context, args *GetAlertRulesArgs, opts ...InvokeOption) (*GetAlertRulesResult, error)
func GetAlertRulesOutput(ctx *Context, args *GetAlertRulesOutputArgs, opts ...InvokeOption) GetAlertRulesResultOutput

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

public static class GetAlertRules 
{
    public static Task<GetAlertRulesResult> InvokeAsync(GetAlertRulesArgs args, InvokeOptions? opts = null)
    public static Output<GetAlertRulesResult> Invoke(GetAlertRulesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAlertRulesResult> getAlertRules(GetAlertRulesArgs args, InvokeOptions options)
public static Output<GetAlertRulesResult> getAlertRules(GetAlertRulesArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Budget/getAlertRules:getAlertRules
  arguments:
    # arguments dictionary

The following arguments are supported:

BudgetId string: The unique budget OCID.
DisplayName string: A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource
Filters List<GetAlertRulesFilter>
State string: The current state of the resource to filter by.

BudgetId string: The unique budget OCID.
DisplayName string: A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource
Filters []GetAlertRulesFilter
State string: The current state of the resource to filter by.

budgetId String: The unique budget OCID.
displayName String: A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource
filters List<GetAlertRulesFilter>
state String: The current state of the resource to filter by.

budgetId string: The unique budget OCID.
displayName string: A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource
filters GetAlertRulesFilter[]
state string: The current state of the resource to filter by.

budget_id str: The unique budget OCID.
display_name str: A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource
filters Sequence[budget.GetAlertRulesFilter]
state str: The current state of the resource to filter by.

budgetId String: The unique budget OCID.
displayName String: A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource
filters List<Property Map>
state String: The current state of the resource to filter by.

getAlertRules Result

The following output properties are available:

AlertRules List<GetAlertRulesAlertRule>: The list of alert_rules.
BudgetId string: The OCID of the budget.
Id string: The provider-assigned unique ID for this managed resource.
DisplayName string: The name of the alert rule. Avoid entering confidential information.
Filters List<GetAlertRulesFilter>
State string: The current state of the alert rule.

AlertRules []GetAlertRulesAlertRule: The list of alert_rules.
BudgetId string: The OCID of the budget.
Id string: The provider-assigned unique ID for this managed resource.
DisplayName string: The name of the alert rule. Avoid entering confidential information.
Filters []GetAlertRulesFilter
State string: The current state of the alert rule.

alertRules List<GetAlertRulesAlertRule>: The list of alert_rules.
budgetId String: The OCID of the budget.
id String: The provider-assigned unique ID for this managed resource.
displayName String: The name of the alert rule. Avoid entering confidential information.
filters List<GetAlertRulesFilter>
state String: The current state of the alert rule.

alertRules GetAlertRulesAlertRule[]: The list of alert_rules.
budgetId string: The OCID of the budget.
id string: The provider-assigned unique ID for this managed resource.
displayName string: The name of the alert rule. Avoid entering confidential information.
filters GetAlertRulesFilter[]
state string: The current state of the alert rule.

alert_rules Sequence[budget.GetAlertRulesAlertRule]: The list of alert_rules.
budget_id str: The OCID of the budget.
id str: The provider-assigned unique ID for this managed resource.
display_name str: The name of the alert rule. Avoid entering confidential information.
filters Sequence[budget.GetAlertRulesFilter]
state str: The current state of the alert rule.

alertRules List<Property Map>: The list of alert_rules.
budgetId String: The OCID of the budget.
id String: The provider-assigned unique ID for this managed resource.
displayName String: The name of the alert rule. Avoid entering confidential information.
filters List<Property Map>
state String: The current state of the alert rule.

Supporting Types

GetAlertRulesAlertRule

BudgetId string: The unique budget OCID.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: The description of the alert rule.
DisplayName string: A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource
FreeformTags Dictionary<string, string>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of the alert rule.
Message string: The custom message that will be sent when the alert is triggered.
Recipients string: The delimited list of email addresses to receive the alert when it triggers. Delimiter characters can be a comma, space, TAB, or semicolon.
State string: The current state of the resource to filter by.
Threshold double: The threshold for triggering the alert. If the thresholdType is PERCENTAGE, the maximum value is 10000.
ThresholdType string: The type of threshold.
TimeCreated string: The time when the budget was created.
TimeUpdated string: The time when the budget was updated.
Type string: The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).
Version int: The version of the alert rule. Starts from 1 and increments by 1.

BudgetId string: The unique budget OCID.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: The description of the alert rule.
DisplayName string: A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource
FreeformTags map[string]string: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of the alert rule.
Message string: The custom message that will be sent when the alert is triggered.
Recipients string: The delimited list of email addresses to receive the alert when it triggers. Delimiter characters can be a comma, space, TAB, or semicolon.
State string: The current state of the resource to filter by.
Threshold float64: The threshold for triggering the alert. If the thresholdType is PERCENTAGE, the maximum value is 10000.
ThresholdType string: The type of threshold.
TimeCreated string: The time when the budget was created.
TimeUpdated string: The time when the budget was updated.
Type string: The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).
Version int: The version of the alert rule. Starts from 1 and increments by 1.

budgetId String: The unique budget OCID.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: The description of the alert rule.
displayName String: A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource
freeformTags Map<String,String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of the alert rule.
message String: The custom message that will be sent when the alert is triggered.
recipients String: The delimited list of email addresses to receive the alert when it triggers. Delimiter characters can be a comma, space, TAB, or semicolon.
state String: The current state of the resource to filter by.
threshold Double: The threshold for triggering the alert. If the thresholdType is PERCENTAGE, the maximum value is 10000.
thresholdType String: The type of threshold.
timeCreated String: The time when the budget was created.
timeUpdated String: The time when the budget was updated.
type String: The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).
version Integer: The version of the alert rule. Starts from 1 and increments by 1.

budgetId string: The unique budget OCID.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description string: The description of the alert rule.
displayName string: A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource
freeformTags {[key: string]: string}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id string: The OCID of the alert rule.
message string: The custom message that will be sent when the alert is triggered.
recipients string: The delimited list of email addresses to receive the alert when it triggers. Delimiter characters can be a comma, space, TAB, or semicolon.
state string: The current state of the resource to filter by.
threshold number: The threshold for triggering the alert. If the thresholdType is PERCENTAGE, the maximum value is 10000.
thresholdType string: The type of threshold.
timeCreated string: The time when the budget was created.
timeUpdated string: The time when the budget was updated.
type string: The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).
version number: The version of the alert rule. Starts from 1 and increments by 1.

budget_id str: The unique budget OCID.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description str: The description of the alert rule.
display_name str: A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource
freeform_tags Mapping[str, str]: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id str: The OCID of the alert rule.
message str: The custom message that will be sent when the alert is triggered.
recipients str: The delimited list of email addresses to receive the alert when it triggers. Delimiter characters can be a comma, space, TAB, or semicolon.
state str: The current state of the resource to filter by.
threshold float: The threshold for triggering the alert. If the thresholdType is PERCENTAGE, the maximum value is 10000.
threshold_type str: The type of threshold.
time_created str: The time when the budget was created.
time_updated str: The time when the budget was updated.
type str: The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).
version int: The version of the alert rule. Starts from 1 and increments by 1.

budgetId String: The unique budget OCID.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: The description of the alert rule.
displayName String: A user-friendly name. This does not have to be unique, and it's changeable. Example: My new resource
freeformTags Map<String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of the alert rule.
message String: The custom message that will be sent when the alert is triggered.
recipients String: The delimited list of email addresses to receive the alert when it triggers. Delimiter characters can be a comma, space, TAB, or semicolon.
state String: The current state of the resource to filter by.
threshold Number: The threshold for triggering the alert. If the thresholdType is PERCENTAGE, the maximum value is 10000.
thresholdType String: The type of threshold.
timeCreated String: The time when the budget was created.
timeUpdated String: The time when the budget was updated.
type String: The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).
version Number: The version of the alert rule. Starts from 1 and increments by 1.

GetAlertRulesFilter

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 v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

pulumi/pulumi-oci

oci.Budget.getAlertRules

On this page

On this page

Example Usage

Using getAlertRules

getAlertRules Result

Supporting Types

GetAlertRulesAlertRule

GetAlertRulesFilter

Package Details

On this page

On this page