pulumi-azure-native-kotlin/com.pulumi.azurenative.costmanagement.kotlin.inputs/NotificationArgs

NotificationArgs

data class NotificationArgs(val contactEmails: Output<List<String>>, val contactGroups: Output<List<String>>? = null, val contactRoles: Output<List<String>>? = null, val enabled: Output<Boolean>, val frequency: Output<Either<String, Frequency>>? = null, val locale: Output<Either<String, CultureCode>>? = null, val operator: Output<Either<String, BudgetNotificationOperatorType>>, val threshold: Output<Double>, val thresholdType: Output<Either<String, ThresholdType>>? = null) : ConvertibleToJava<NotificationArgs>

The notification associated with a budget. Supported for CategoryType(s): Cost, ReservationUtilization.

Constructors

Link copied to clipboard
fun NotificationArgs(contactEmails: Output<List<String>>, contactGroups: Output<List<String>>? = null, contactRoles: Output<List<String>>? = null, enabled: Output<Boolean>, frequency: Output<Either<String, Frequency>>? = null, locale: Output<Either<String, CultureCode>>? = null, operator: Output<Either<String, BudgetNotificationOperatorType>>, threshold: Output<Double>, thresholdType: Output<Either<String, ThresholdType>>? = null)

Functions

Link copied to clipboard
open override fun toJava(): NotificationArgs

Properties

Link copied to clipboard
val contactEmails: Output<List<String>>

Email addresses to send the notification to when the threshold is breached. Must have at least one contact email or contact group specified at the Subscription or Resource Group scopes. All other scopes must have at least one contact email specified. Supported for CategoryType(s): Cost, ReservationUtilization.

Link copied to clipboard
val contactGroups: Output<List<String>>? = null

Subscription or Resource Group scopes only. Action groups to send the notification to when the threshold is exceeded. Must be provided as a fully qualified Azure resource id. Supported for CategoryType(s): Cost.

Link copied to clipboard
val contactRoles: Output<List<String>>? = null

Subscription or Resource Group scopes only. Contact roles to send the notification to when the threshold is breached. Supported for CategoryType(s): Cost.

Link copied to clipboard
val enabled: Output<Boolean>

The notification is enabled or not. Supported for CategoryType(s): Cost, ReservationUtilization.

Link copied to clipboard
val frequency: Output<Either<String, Frequency>>? = null

Frequency of a notification. Represents how long the notification will be silent after triggering an alert for a threshold breach. If not specified, the frequency will be set by default based on the timeGrain (Weekly when timeGrain: Last7Days, Monthly when timeGrain: Last30Days). Supported for CategoryType(s): ReservationUtilization.

Link copied to clipboard
val locale: Output<Either<String, CultureCode>>? = null

Language in which the recipient will receive the notification, Supported for CategoryType(s): Cost, ReservationUtilization.

Link copied to clipboard
val operator: Output<Either<String, BudgetNotificationOperatorType>>

The comparison operator. Supported for CategoryType(s): Cost, ReservationUtilization. Supported operators for CategoryType: Cost

Link copied to clipboard
val threshold: Output<Double>

Threshold value associated with a notification. It is always percent with a maximum of 2 decimal places. Supported for CategoryType(s): Cost, ReservationUtilization. CategoryType: Cost - Must be between 0 and 1000. Notification is sent when the cost exceeded the threshold. CategoryType: ReservationUtilization - Must be between 0 and 100. Notification is sent when a reservation has a utilization percentage below the threshold.

Link copied to clipboard
val thresholdType: Output<Either<String, ThresholdType>>? = null

The type of threshold. Supported for CategoryType(s): Cost.