BudgetNotification Class

Definition

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

public class BudgetNotification : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CostManagement.Models.BudgetNotification>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CostManagement.Models.BudgetNotification>
type BudgetNotification = class
    interface IJsonModel<BudgetNotification>
    interface IPersistableModel<BudgetNotification>
Public Class BudgetNotification
Implements IJsonModel(Of BudgetNotification), IPersistableModel(Of BudgetNotification)
Inheritance
BudgetNotification
Implements

Constructors

Name Description
BudgetNotification(Boolean, BudgetNotificationOperatorType, Single, IEnumerable<String>)

Initializes a new instance of BudgetNotification.

Properties

Name Description
ContactEmails

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.

ContactGroups

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.

ContactRoles

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

Enabled

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

Frequency

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.

Locale

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

Operator

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

  • GreaterThan
  • GreaterThanOrEqualTo
Supported operators for CategoryType: ReservationUtilization
  • LessThan

Threshold

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.

ThresholdType

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

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<BudgetNotification>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<BudgetNotification>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<BudgetNotification>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<BudgetNotification>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<BudgetNotification>.Write(ModelReaderWriterOptions)

Applies to