Notification interface

Package:

@azure/arm-costmanagement

The notification associated with a budget.

Supported for CategoryType(s): Cost, ReservationUtilization.

Properties

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.

Property Details

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.

contactEmails: string[]

Property Value

string[]

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.

contactGroups?: string[]

Property Value

string[]

contactRoles

Subscription or Resource Group scopes only. Contact roles to send the notification to when the threshold is breached.

Supported for CategoryType(s): Cost.

contactRoles?: string[]

Property Value

string[]

enabled

The notification is enabled or not.

Supported for CategoryType(s): Cost, ReservationUtilization.

enabled: boolean

Property Value

boolean

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.

frequency?: string

Property Value

string

locale

Language in which the recipient will receive the notification,

Supported for CategoryType(s): Cost, ReservationUtilization.

locale?: string

Property Value

string

operator

The comparison operator.

Supported for CategoryType(s): Cost, ReservationUtilization.

Supported operators for CategoryType: Cost

• GreaterThan
• GreaterThanOrEqualTo

Supported operators for CategoryType: ReservationUtilization

• LessThan

operator: string

Property Value

string

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.

threshold: number

Property Value

number

thresholdType

The type of threshold.

Supported for CategoryType(s): Cost.

thresholdType?: string

Property Value

string