oci.Budget.getAlertRules
Explore with Pulumi AI
This data source provides the list of Alert Rules in Oracle Cloud Infrastructure Budget service.
Returns a list of Alert Rules for a specified budget.
Example Usage
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 = oci_budget_budget.Test_budget.Id,
DisplayName = @var.Alert_rule_display_name,
State = @var.Alert_rule_state,
});
});
package main
import (
"github.com/pulumi/pulumi-oci/sdk/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: oci_budget_budget.Test_budget.Id,
DisplayName: pulumi.StringRef(_var.Alert_rule_display_name),
State: pulumi.StringRef(_var.Alert_rule_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.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(oci_budget_budget.test_budget().id())
.displayName(var_.alert_rule_display_name())
.state(var_.alert_rule_state())
.build());
}
}
import pulumi
import pulumi_oci as oci
test_alert_rules = oci.Budget.get_alert_rules(budget_id=oci_budget_budget["test_budget"]["id"],
display_name=var["alert_rule_display_name"],
state=var["alert_rule_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testAlertRules = oci.Budget.getAlertRules({
budgetId: oci_budget_budget.test_budget.id,
displayName: _var.alert_rule_display_name,
state: _var.alert_rule_state,
});
variables:
testAlertRules:
fn::invoke:
Function: oci:Budget:getAlertRules
Arguments:
budgetId: ${oci_budget_budget.test_budget.id}
displayName: ${var.alert_rule_display_name}
state: ${var.alert_rule_state}
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.
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:Budget/getAlertRules:getAlertRules
arguments:
# arguments dictionary
The following arguments are supported:
- Budget
Id string The unique budget OCID.
- Display
Name string A user-friendly name. This does not have to be unique, and it's changeable. Example:
My new resource
- Filters
List<Get
Alert Rules Filter> - State string
The current state of the resource to filter by.
- Budget
Id string The unique budget OCID.
- Display
Name string A user-friendly name. This does not have to be unique, and it's changeable. Example:
My new resource
- Filters
[]Get
Alert Rules Filter - State string
The current state of the resource to filter by.
- budget
Id String The unique budget OCID.
- display
Name String A user-friendly name. This does not have to be unique, and it's changeable. Example:
My new resource
- filters
List<Get
Alert Rules Filter> - state String
The current state of the resource to filter by.
- budget
Id string The unique budget OCID.
- display
Name string A user-friendly name. This does not have to be unique, and it's changeable. Example:
My new resource
- filters
Get
Alert Rules Filter[] - 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
Get
Alert Rules Filter] - state str
The current state of the resource to filter by.
- budget
Id String The unique budget OCID.
- display
Name 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:
- Alert
Rules List<GetAlert Rules Alert Rule> The list of alert_rules.
- Budget
Id string The OCID of the budget.
- Id string
The provider-assigned unique ID for this managed resource.
- Display
Name string The name of the alert rule. Avoid entering confidential information.
- Filters
List<Get
Alert Rules Filter> - State string
The current state of the alert rule.
- Alert
Rules []GetAlert Rules Alert Rule The list of alert_rules.
- Budget
Id string The OCID of the budget.
- Id string
The provider-assigned unique ID for this managed resource.
- Display
Name string The name of the alert rule. Avoid entering confidential information.
- Filters
[]Get
Alert Rules Filter - State string
The current state of the alert rule.
- alert
Rules List<GetAlert Rules Alert Rule> The list of alert_rules.
- budget
Id String The OCID of the budget.
- id String
The provider-assigned unique ID for this managed resource.
- display
Name String The name of the alert rule. Avoid entering confidential information.
- filters
List<Get
Alert Rules Filter> - state String
The current state of the alert rule.
- alert
Rules GetAlert Rules Alert Rule[] The list of alert_rules.
- budget
Id string The OCID of the budget.
- id string
The provider-assigned unique ID for this managed resource.
- display
Name string The name of the alert rule. Avoid entering confidential information.
- filters
Get
Alert Rules Filter[] - state string
The current state of the alert rule.
- alert_
rules GetAlert Rules Alert Rule] 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
Get
Alert Rules Filter] - state str
The current state of the alert rule.
- alert
Rules List<Property Map> The list of alert_rules.
- budget
Id String The OCID of the budget.
- id String
The provider-assigned unique ID for this managed resource.
- display
Name 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
- Budget
Id string The unique budget OCID.
- Dictionary<string, object>
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.
- Display
Name string A user-friendly name. This does not have to be unique, and it's changeable. Example:
My new resource
- Dictionary<string, object>
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.
- Threshold
Type string The type of threshold.
- Time
Created string The time when the budget was created.
- Time
Updated 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.
- Budget
Id string The unique budget OCID.
- map[string]interface{}
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.
- Display
Name string A user-friendly name. This does not have to be unique, and it's changeable. Example:
My new resource
- map[string]interface{}
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.
- Threshold
Type string The type of threshold.
- Time
Created string The time when the budget was created.
- Time
Updated 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.
- budget
Id String The unique budget OCID.
- Map<String,Object>
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.
- display
Name String A user-friendly name. This does not have to be unique, and it's changeable. Example:
My new resource
- Map<String,Object>
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.
- threshold
Type String The type of threshold.
- time
Created String The time when the budget was created.
- time
Updated 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.
- budget
Id string The unique budget OCID.
- {[key: string]: any}
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.
- display
Name string A user-friendly name. This does not have to be unique, and it's changeable. Example:
My new resource
- {[key: string]: any}
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.
- threshold
Type string The type of threshold.
- time
Created string The time when the budget was created.
- time
Updated 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.
- Mapping[str, Any]
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
- Mapping[str, Any]
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.
- budget
Id String The unique budget OCID.
- Map<Any>
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.
- display
Name String A user-friendly name. This does not have to be unique, and it's changeable. Example:
My new resource
- Map<Any>
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.
- threshold
Type String The type of threshold.
- time
Created String The time when the budget was created.
- time
Updated 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
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.