ArmCostManagementModelFactory.BudgetNotification Method

Definition

Namespace:: Azure.ResourceManager.CostManagement.Models

Assembly:: Azure.ResourceManager.CostManagement.dll

Package:: Azure.ResourceManager.CostManagement v1.0.3

Source:: ArmCostManagementModelFactory.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public static Azure.ResourceManager.CostManagement.Models.BudgetNotification BudgetNotification(bool enabled = false, Azure.ResourceManager.CostManagement.Models.BudgetNotificationOperatorType operator = default, float threshold = 0, Azure.ResourceManager.CostManagement.Models.Frequency? frequency = default, System.Collections.Generic.IEnumerable<string> contactEmails = default, System.Collections.Generic.IEnumerable<string> contactRoles = default, System.Collections.Generic.IEnumerable<string> contactGroups = default, Azure.ResourceManager.CostManagement.Models.ThresholdType? thresholdType = default, Azure.ResourceManager.CostManagement.Models.CultureCode? locale = default);

static member BudgetNotification : bool * Azure.ResourceManager.CostManagement.Models.BudgetNotificationOperatorType * single * Nullable<Azure.ResourceManager.CostManagement.Models.Frequency> * seq<string> * seq<string> * seq<string> * Nullable<Azure.ResourceManager.CostManagement.Models.ThresholdType> * Nullable<Azure.ResourceManager.CostManagement.Models.CultureCode> -> Azure.ResourceManager.CostManagement.Models.BudgetNotification

Public Shared Function BudgetNotification (Optional enabled As Boolean = false, Optional operator As BudgetNotificationOperatorType = Nothing, Optional threshold As Single = 0, Optional frequency As Nullable(Of Frequency) = Nothing, Optional contactEmails As IEnumerable(Of String) = Nothing, Optional contactRoles As IEnumerable(Of String) = Nothing, Optional contactGroups As IEnumerable(Of String) = Nothing, Optional thresholdType As Nullable(Of ThresholdType) = Nothing, Optional locale As Nullable(Of CultureCode) = Nothing) As BudgetNotification

Parameters

enabled: Boolean

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

operator: BudgetNotificationOperatorType

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

GreaterThan
GreaterThanOrEqualTo

Supported operators for CategoryType: ReservationUtilization

LessThan

threshold: Single

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.

frequency: Nullable<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.

contactEmails: IEnumerable<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.

contactRoles: IEnumerable<String>

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

contactGroups: IEnumerable<String>

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.

thresholdType: Nullable<ThresholdType>

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

locale: Nullable<CultureCode>

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

Returns

BudgetNotification

A new BudgetNotification instance for mocking.

Applies to

Feedback

Was this page helpful?