Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. costmanagement
  5. getBudget
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.costmanagement.getBudget

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure-native

    Gets the budget for the scope by budget name. Azure REST API version: 2023-04-01-preview.

    Other available API versions: 2019-04-01-preview, 2023-08-01, 2023-09-01, 2023-11-01.

    Using getBudget

    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 getBudget(args: GetBudgetArgs, opts?: InvokeOptions): Promise<GetBudgetResult>
function getBudgetOutput(args: GetBudgetOutputArgs, opts?: InvokeOptions): Output<GetBudgetResult>
    def get_budget(budget_name: Optional[str] = None,
               scope: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetBudgetResult
def get_budget_output(budget_name: Optional[pulumi.Input[str]] = None,
               scope: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetBudgetResult]
    func LookupBudget(ctx *Context, args *LookupBudgetArgs, opts ...InvokeOption) (*LookupBudgetResult, error)
func LookupBudgetOutput(ctx *Context, args *LookupBudgetOutputArgs, opts ...InvokeOption) LookupBudgetResultOutput

    > Note: This function is named LookupBudget in the Go SDK.

    public static class GetBudget 
{
    public static Task<GetBudgetResult> InvokeAsync(GetBudgetArgs args, InvokeOptions? opts = null)
    public static Output<GetBudgetResult> Invoke(GetBudgetInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBudgetResult> getBudget(GetBudgetArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:costmanagement:getBudget
  arguments:
    # arguments dictionary

    The following arguments are supported:

    BudgetName string
    Budget Name.
    Scope string

    The scope associated with budget operations.

    Supported scopes for CategoryType: Cost

    Azure RBAC Scopes:

    • '/subscriptions/{subscriptionId}/' for subscription scope
    • '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope
    • '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope

    EA (Enterprise Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope

    MCA (Modern Customer Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only)

    Supported scopes for CategoryType: ReservationUtilization

    EA (Enterprise Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account Scope

    MCA (Modern Customer Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope (non-CSP only)
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only)
    BudgetName string
    Budget Name.
    Scope string

    The scope associated with budget operations.

    Supported scopes for CategoryType: Cost

    Azure RBAC Scopes:

    • '/subscriptions/{subscriptionId}/' for subscription scope
    • '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope
    • '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope

    EA (Enterprise Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope

    MCA (Modern Customer Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only)

    Supported scopes for CategoryType: ReservationUtilization

    EA (Enterprise Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account Scope

    MCA (Modern Customer Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope (non-CSP only)
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only)
    budgetName String
    Budget Name.
    scope String

    The scope associated with budget operations.

    Supported scopes for CategoryType: Cost

    Azure RBAC Scopes:

    • '/subscriptions/{subscriptionId}/' for subscription scope
    • '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope
    • '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope

    EA (Enterprise Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope

    MCA (Modern Customer Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only)

    Supported scopes for CategoryType: ReservationUtilization

    EA (Enterprise Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account Scope

    MCA (Modern Customer Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope (non-CSP only)
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only)
    budgetName string
    Budget Name.
    scope string

    The scope associated with budget operations.

    Supported scopes for CategoryType: Cost

    Azure RBAC Scopes:

    • '/subscriptions/{subscriptionId}/' for subscription scope
    • '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope
    • '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope

    EA (Enterprise Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope

    MCA (Modern Customer Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only)

    Supported scopes for CategoryType: ReservationUtilization

    EA (Enterprise Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account Scope

    MCA (Modern Customer Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope (non-CSP only)
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only)
    budget_name str
    Budget Name.
    scope str

    The scope associated with budget operations.

    Supported scopes for CategoryType: Cost

    Azure RBAC Scopes:

    • '/subscriptions/{subscriptionId}/' for subscription scope
    • '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope
    • '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope

    EA (Enterprise Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope

    MCA (Modern Customer Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only)

    Supported scopes for CategoryType: ReservationUtilization

    EA (Enterprise Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account Scope

    MCA (Modern Customer Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope (non-CSP only)
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only)
    budgetName String
    Budget Name.
    scope String

    The scope associated with budget operations.

    Supported scopes for CategoryType: Cost

    Azure RBAC Scopes:

    • '/subscriptions/{subscriptionId}/' for subscription scope
    • '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope
    • '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope

    EA (Enterprise Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope

    MCA (Modern Customer Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only)

    Supported scopes for CategoryType: ReservationUtilization

    EA (Enterprise Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account Scope

    MCA (Modern Customer Agreement) Scopes:

    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope (non-CSP only)
    • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only)

    getBudget Result

    The following output properties are available:

    Category string
    The category of the budget.

    • 'Cost' defines a Budget.
    • 'ReservationUtilization' defines a Reservation Utilization Alert Rule.
    CurrentSpend Pulumi.AzureNative.CostManagement.Outputs.CurrentSpendResponse

    The current amount of cost which is being tracked for a budget.

    Supported for CategoryType(s): Cost.

    ForecastSpend Pulumi.AzureNative.CostManagement.Outputs.ForecastSpendResponse

    The forecasted cost which is being tracked for a budget.

    Supported for CategoryType(s): Cost.

    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    TimeGrain string

    The time covered by a budget. Tracking of the amount will be reset based on the time grain.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported timeGrainTypes for CategoryType: Cost

    • Monthly

    • Quarterly

    • Annually

    • BillingMonth*

    • BillingQuarter*

    • BillingAnnual*

      *only supported for Web Direct customers.

    Supported timeGrainTypes for CategoryType: ReservationUtilization

    • Last7Days
    • Last30Days

    Required for CategoryType(s): Cost, ReservationUtilization.

    TimePeriod Pulumi.AzureNative.CostManagement.Outputs.BudgetTimePeriodResponse

    The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Required for CategoryType(s): Cost, ReservationUtilization.

    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Amount double

    The total amount of cost to track with the budget.

    Supported for CategoryType(s): Cost.

    Required for CategoryType(s): Cost.

    ETag string
    eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.
    Filter Pulumi.AzureNative.CostManagement.Outputs.BudgetFilterResponse

    May be used to filter budgets by user-specified dimensions and/or tags.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Notifications Dictionary<string, Pulumi.AzureNative.CostManagement.Outputs.NotificationResponse>

    Dictionary of notifications associated with the budget.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    • Constraints for CategoryType: Cost - Budget can have up to 5 notifications with thresholdType: Actual and 5 notifications with thresholdType: Forecasted.
    • Constraints for CategoryType: ReservationUtilization - Only one notification allowed. thresholdType is not applicable.
    Category string
    The category of the budget.

    • 'Cost' defines a Budget.
    • 'ReservationUtilization' defines a Reservation Utilization Alert Rule.
    CurrentSpend CurrentSpendResponse

    The current amount of cost which is being tracked for a budget.

    Supported for CategoryType(s): Cost.

    ForecastSpend ForecastSpendResponse

    The forecasted cost which is being tracked for a budget.

    Supported for CategoryType(s): Cost.

    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    TimeGrain string

    The time covered by a budget. Tracking of the amount will be reset based on the time grain.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported timeGrainTypes for CategoryType: Cost

    • Monthly

    • Quarterly

    • Annually

    • BillingMonth*

    • BillingQuarter*

    • BillingAnnual*

      *only supported for Web Direct customers.

    Supported timeGrainTypes for CategoryType: ReservationUtilization

    • Last7Days
    • Last30Days

    Required for CategoryType(s): Cost, ReservationUtilization.

    TimePeriod BudgetTimePeriodResponse

    The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Required for CategoryType(s): Cost, ReservationUtilization.

    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Amount float64

    The total amount of cost to track with the budget.

    Supported for CategoryType(s): Cost.

    Required for CategoryType(s): Cost.

    ETag string
    eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.
    Filter BudgetFilterResponse

    May be used to filter budgets by user-specified dimensions and/or tags.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Notifications map[string]NotificationResponse

    Dictionary of notifications associated with the budget.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    • Constraints for CategoryType: Cost - Budget can have up to 5 notifications with thresholdType: Actual and 5 notifications with thresholdType: Forecasted.
    • Constraints for CategoryType: ReservationUtilization - Only one notification allowed. thresholdType is not applicable.
    category String
    The category of the budget.

    • 'Cost' defines a Budget.
    • 'ReservationUtilization' defines a Reservation Utilization Alert Rule.
    currentSpend CurrentSpendResponse

    The current amount of cost which is being tracked for a budget.

    Supported for CategoryType(s): Cost.

    forecastSpend ForecastSpendResponse

    The forecasted cost which is being tracked for a budget.

    Supported for CategoryType(s): Cost.

    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    timeGrain String

    The time covered by a budget. Tracking of the amount will be reset based on the time grain.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported timeGrainTypes for CategoryType: Cost

    • Monthly

    • Quarterly

    • Annually

    • BillingMonth*

    • BillingQuarter*

    • BillingAnnual*

      *only supported for Web Direct customers.

    Supported timeGrainTypes for CategoryType: ReservationUtilization

    • Last7Days
    • Last30Days

    Required for CategoryType(s): Cost, ReservationUtilization.

    timePeriod BudgetTimePeriodResponse

    The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Required for CategoryType(s): Cost, ReservationUtilization.

    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    amount Double

    The total amount of cost to track with the budget.

    Supported for CategoryType(s): Cost.

    Required for CategoryType(s): Cost.

    eTag String
    eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.
    filter BudgetFilterResponse

    May be used to filter budgets by user-specified dimensions and/or tags.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    notifications Map<String,NotificationResponse>

    Dictionary of notifications associated with the budget.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    • Constraints for CategoryType: Cost - Budget can have up to 5 notifications with thresholdType: Actual and 5 notifications with thresholdType: Forecasted.
    • Constraints for CategoryType: ReservationUtilization - Only one notification allowed. thresholdType is not applicable.
    category string
    The category of the budget.

    • 'Cost' defines a Budget.
    • 'ReservationUtilization' defines a Reservation Utilization Alert Rule.
    currentSpend CurrentSpendResponse

    The current amount of cost which is being tracked for a budget.

    Supported for CategoryType(s): Cost.

    forecastSpend ForecastSpendResponse

    The forecasted cost which is being tracked for a budget.

    Supported for CategoryType(s): Cost.

    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name string
    The name of the resource
    timeGrain string

    The time covered by a budget. Tracking of the amount will be reset based on the time grain.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported timeGrainTypes for CategoryType: Cost

    • Monthly

    • Quarterly

    • Annually

    • BillingMonth*

    • BillingQuarter*

    • BillingAnnual*

      *only supported for Web Direct customers.

    Supported timeGrainTypes for CategoryType: ReservationUtilization

    • Last7Days
    • Last30Days

    Required for CategoryType(s): Cost, ReservationUtilization.

    timePeriod BudgetTimePeriodResponse

    The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Required for CategoryType(s): Cost, ReservationUtilization.

    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    amount number

    The total amount of cost to track with the budget.

    Supported for CategoryType(s): Cost.

    Required for CategoryType(s): Cost.

    eTag string
    eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.
    filter BudgetFilterResponse

    May be used to filter budgets by user-specified dimensions and/or tags.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    notifications {[key: string]: NotificationResponse}

    Dictionary of notifications associated with the budget.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    • Constraints for CategoryType: Cost - Budget can have up to 5 notifications with thresholdType: Actual and 5 notifications with thresholdType: Forecasted.
    • Constraints for CategoryType: ReservationUtilization - Only one notification allowed. thresholdType is not applicable.
    category str
    The category of the budget.

    • 'Cost' defines a Budget.
    • 'ReservationUtilization' defines a Reservation Utilization Alert Rule.
    current_spend CurrentSpendResponse

    The current amount of cost which is being tracked for a budget.

    Supported for CategoryType(s): Cost.

    forecast_spend ForecastSpendResponse

    The forecasted cost which is being tracked for a budget.

    Supported for CategoryType(s): Cost.

    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name str
    The name of the resource
    time_grain str

    The time covered by a budget. Tracking of the amount will be reset based on the time grain.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported timeGrainTypes for CategoryType: Cost

    • Monthly

    • Quarterly

    • Annually

    • BillingMonth*

    • BillingQuarter*

    • BillingAnnual*

      *only supported for Web Direct customers.

    Supported timeGrainTypes for CategoryType: ReservationUtilization

    • Last7Days
    • Last30Days

    Required for CategoryType(s): Cost, ReservationUtilization.

    time_period BudgetTimePeriodResponse

    The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Required for CategoryType(s): Cost, ReservationUtilization.

    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    amount float

    The total amount of cost to track with the budget.

    Supported for CategoryType(s): Cost.

    Required for CategoryType(s): Cost.

    e_tag str
    eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.
    filter BudgetFilterResponse

    May be used to filter budgets by user-specified dimensions and/or tags.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    notifications Mapping[str, NotificationResponse]

    Dictionary of notifications associated with the budget.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    • Constraints for CategoryType: Cost - Budget can have up to 5 notifications with thresholdType: Actual and 5 notifications with thresholdType: Forecasted.
    • Constraints for CategoryType: ReservationUtilization - Only one notification allowed. thresholdType is not applicable.
    category String
    The category of the budget.

    • 'Cost' defines a Budget.
    • 'ReservationUtilization' defines a Reservation Utilization Alert Rule.
    currentSpend Property Map

    The current amount of cost which is being tracked for a budget.

    Supported for CategoryType(s): Cost.

    forecastSpend Property Map

    The forecasted cost which is being tracked for a budget.

    Supported for CategoryType(s): Cost.

    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    timeGrain String

    The time covered by a budget. Tracking of the amount will be reset based on the time grain.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported timeGrainTypes for CategoryType: Cost

    • Monthly

    • Quarterly

    • Annually

    • BillingMonth*

    • BillingQuarter*

    • BillingAnnual*

      *only supported for Web Direct customers.

    Supported timeGrainTypes for CategoryType: ReservationUtilization

    • Last7Days
    • Last30Days

    Required for CategoryType(s): Cost, ReservationUtilization.

    timePeriod Property Map

    The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Required for CategoryType(s): Cost, ReservationUtilization.

    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    amount Number

    The total amount of cost to track with the budget.

    Supported for CategoryType(s): Cost.

    Required for CategoryType(s): Cost.

    eTag String
    eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.
    filter Property Map

    May be used to filter budgets by user-specified dimensions and/or tags.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    notifications Map<Property Map>

    Dictionary of notifications associated with the budget.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    • Constraints for CategoryType: Cost - Budget can have up to 5 notifications with thresholdType: Actual and 5 notifications with thresholdType: Forecasted.
    • Constraints for CategoryType: ReservationUtilization - Only one notification allowed. thresholdType is not applicable.

    Supporting Types

    BudgetComparisonExpressionResponse

    Name string
    The name of the column to use in comparison.
    Operator string
    The operator to use for comparison.
    Values List<string>
    Array of values to use for comparison
    Name string
    The name of the column to use in comparison.
    Operator string
    The operator to use for comparison.
    Values []string
    Array of values to use for comparison
    name String
    The name of the column to use in comparison.
    operator String
    The operator to use for comparison.
    values List<String>
    Array of values to use for comparison
    name string
    The name of the column to use in comparison.
    operator string
    The operator to use for comparison.
    values string[]
    Array of values to use for comparison
    name str
    The name of the column to use in comparison.
    operator str
    The operator to use for comparison.
    values Sequence[str]
    Array of values to use for comparison
    name String
    The name of the column to use in comparison.
    operator String
    The operator to use for comparison.
    values List<String>
    Array of values to use for comparison

    BudgetFilterPropertiesResponse

    Dimensions Pulumi.AzureNative.CostManagement.Inputs.BudgetComparisonExpressionResponse

    Has comparison expression for a dimension.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported dimension names for CategoryType: ReservationUtilization

    • ReservationId
    • ReservedResourceType
    Tags Pulumi.AzureNative.CostManagement.Inputs.BudgetComparisonExpressionResponse

    Has comparison expression for a tag.

    Supported for CategoryType(s): Cost.

    Dimensions BudgetComparisonExpressionResponse

    Has comparison expression for a dimension.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported dimension names for CategoryType: ReservationUtilization

    • ReservationId
    • ReservedResourceType
    Tags BudgetComparisonExpressionResponse

    Has comparison expression for a tag.

    Supported for CategoryType(s): Cost.

    dimensions BudgetComparisonExpressionResponse

    Has comparison expression for a dimension.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported dimension names for CategoryType: ReservationUtilization

    • ReservationId
    • ReservedResourceType
    tags BudgetComparisonExpressionResponse

    Has comparison expression for a tag.

    Supported for CategoryType(s): Cost.

    dimensions BudgetComparisonExpressionResponse

    Has comparison expression for a dimension.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported dimension names for CategoryType: ReservationUtilization

    • ReservationId
    • ReservedResourceType
    tags BudgetComparisonExpressionResponse

    Has comparison expression for a tag.

    Supported for CategoryType(s): Cost.

    dimensions BudgetComparisonExpressionResponse

    Has comparison expression for a dimension.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported dimension names for CategoryType: ReservationUtilization

    • ReservationId
    • ReservedResourceType
    tags BudgetComparisonExpressionResponse

    Has comparison expression for a tag.

    Supported for CategoryType(s): Cost.

    dimensions Property Map

    Has comparison expression for a dimension.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported dimension names for CategoryType: ReservationUtilization

    • ReservationId
    • ReservedResourceType
    tags Property Map

    Has comparison expression for a tag.

    Supported for CategoryType(s): Cost.

    BudgetFilterResponse

    And List<Pulumi.AzureNative.CostManagement.Inputs.BudgetFilterPropertiesResponse>

    The logical "AND" expression. Must have at least 2 items.

    Supported for CategoryType(s): Cost.

    Dimensions Pulumi.AzureNative.CostManagement.Inputs.BudgetComparisonExpressionResponse

    Has comparison expression for a dimension.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported dimension names for CategoryType: ReservationUtilization

    • ReservationId
    • ReservedResourceType
    Tags Pulumi.AzureNative.CostManagement.Inputs.BudgetComparisonExpressionResponse

    Has comparison expression for a tag.

    Supported for CategoryType(s): Cost.

    And []BudgetFilterPropertiesResponse

    The logical "AND" expression. Must have at least 2 items.

    Supported for CategoryType(s): Cost.

    Dimensions BudgetComparisonExpressionResponse

    Has comparison expression for a dimension.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported dimension names for CategoryType: ReservationUtilization

    • ReservationId
    • ReservedResourceType
    Tags BudgetComparisonExpressionResponse

    Has comparison expression for a tag.

    Supported for CategoryType(s): Cost.

    and List<BudgetFilterPropertiesResponse>

    The logical "AND" expression. Must have at least 2 items.

    Supported for CategoryType(s): Cost.

    dimensions BudgetComparisonExpressionResponse

    Has comparison expression for a dimension.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported dimension names for CategoryType: ReservationUtilization

    • ReservationId
    • ReservedResourceType
    tags BudgetComparisonExpressionResponse

    Has comparison expression for a tag.

    Supported for CategoryType(s): Cost.

    and BudgetFilterPropertiesResponse[]

    The logical "AND" expression. Must have at least 2 items.

    Supported for CategoryType(s): Cost.

    dimensions BudgetComparisonExpressionResponse

    Has comparison expression for a dimension.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported dimension names for CategoryType: ReservationUtilization

    • ReservationId
    • ReservedResourceType
    tags BudgetComparisonExpressionResponse

    Has comparison expression for a tag.

    Supported for CategoryType(s): Cost.

    and_ Sequence[BudgetFilterPropertiesResponse]

    The logical "AND" expression. Must have at least 2 items.

    Supported for CategoryType(s): Cost.

    dimensions BudgetComparisonExpressionResponse

    Has comparison expression for a dimension.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported dimension names for CategoryType: ReservationUtilization

    • ReservationId
    • ReservedResourceType
    tags BudgetComparisonExpressionResponse

    Has comparison expression for a tag.

    Supported for CategoryType(s): Cost.

    and List<Property Map>

    The logical "AND" expression. Must have at least 2 items.

    Supported for CategoryType(s): Cost.

    dimensions Property Map

    Has comparison expression for a dimension.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported dimension names for CategoryType: ReservationUtilization

    • ReservationId
    • ReservedResourceType
    tags Property Map

    Has comparison expression for a tag.

    Supported for CategoryType(s): Cost.

    BudgetTimePeriodResponse

    StartDate string

    The start date for the budget.

    • Constraints for CategoryType: Cost - Must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period.

    • Constraints for CategoryType: ReservationUtilization - Must be on or after the current date and less than the end date.

    EndDate string

    The end date for the budget.

    • Constraints for CategoryType: Cost - No constraints. If not provided, we default this to 10 years from the start date.

    • Constraints for CategoryType: ReservationUtilization - End date cannot be more than 3 years after the start date.

    StartDate string

    The start date for the budget.

    • Constraints for CategoryType: Cost - Must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period.

    • Constraints for CategoryType: ReservationUtilization - Must be on or after the current date and less than the end date.

    EndDate string

    The end date for the budget.

    • Constraints for CategoryType: Cost - No constraints. If not provided, we default this to 10 years from the start date.

    • Constraints for CategoryType: ReservationUtilization - End date cannot be more than 3 years after the start date.

    startDate String

    The start date for the budget.

    • Constraints for CategoryType: Cost - Must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period.

    • Constraints for CategoryType: ReservationUtilization - Must be on or after the current date and less than the end date.

    endDate String

    The end date for the budget.

    • Constraints for CategoryType: Cost - No constraints. If not provided, we default this to 10 years from the start date.

    • Constraints for CategoryType: ReservationUtilization - End date cannot be more than 3 years after the start date.

    startDate string

    The start date for the budget.

    • Constraints for CategoryType: Cost - Must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period.

    • Constraints for CategoryType: ReservationUtilization - Must be on or after the current date and less than the end date.

    endDate string

    The end date for the budget.

    • Constraints for CategoryType: Cost - No constraints. If not provided, we default this to 10 years from the start date.

    • Constraints for CategoryType: ReservationUtilization - End date cannot be more than 3 years after the start date.

    start_date str

    The start date for the budget.

    • Constraints for CategoryType: Cost - Must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period.

    • Constraints for CategoryType: ReservationUtilization - Must be on or after the current date and less than the end date.

    end_date str

    The end date for the budget.

    • Constraints for CategoryType: Cost - No constraints. If not provided, we default this to 10 years from the start date.

    • Constraints for CategoryType: ReservationUtilization - End date cannot be more than 3 years after the start date.

    startDate String

    The start date for the budget.

    • Constraints for CategoryType: Cost - Must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period.

    • Constraints for CategoryType: ReservationUtilization - Must be on or after the current date and less than the end date.

    endDate String

    The end date for the budget.

    • Constraints for CategoryType: Cost - No constraints. If not provided, we default this to 10 years from the start date.

    • Constraints for CategoryType: ReservationUtilization - End date cannot be more than 3 years after the start date.

    CurrentSpendResponse

    Amount double
    The total amount of cost which is being tracked by the budget.
    Unit string
    The unit of measure for the budget amount.
    Amount float64
    The total amount of cost which is being tracked by the budget.
    Unit string
    The unit of measure for the budget amount.
    amount Double
    The total amount of cost which is being tracked by the budget.
    unit String
    The unit of measure for the budget amount.
    amount number
    The total amount of cost which is being tracked by the budget.
    unit string
    The unit of measure for the budget amount.
    amount float
    The total amount of cost which is being tracked by the budget.
    unit str
    The unit of measure for the budget amount.
    amount Number
    The total amount of cost which is being tracked by the budget.
    unit String
    The unit of measure for the budget amount.

    ForecastSpendResponse

    Amount double
    The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type.
    Unit string
    The unit of measure for the budget amount.
    Amount float64
    The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type.
    Unit string
    The unit of measure for the budget amount.
    amount Double
    The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type.
    unit String
    The unit of measure for the budget amount.
    amount number
    The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type.
    unit string
    The unit of measure for the budget amount.
    amount float
    The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type.
    unit str
    The unit of measure for the budget amount.
    amount Number
    The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type.
    unit String
    The unit of measure for the budget amount.

    NotificationResponse

    ContactEmails 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.

    Enabled bool

    The notification is enabled or not.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Operator string

    The comparison operator.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported operators for CategoryType: Cost

    • GreaterThan
    • GreaterThanOrEqualTo

    Supported operators for CategoryType: ReservationUtilization

    • LessThan
    Threshold 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.

    ContactGroups List<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.

    ContactRoles List<string>

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

    Supported for CategoryType(s): Cost.

    Frequency string

    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 string

    Language in which the recipient will receive the notification,

    Supported for CategoryType(s): Cost, ReservationUtilization.

    ThresholdType string

    The type of threshold.

    Supported for CategoryType(s): Cost.

    ContactEmails []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.

    Enabled bool

    The notification is enabled or not.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Operator string

    The comparison operator.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported operators for CategoryType: Cost

    • GreaterThan
    • GreaterThanOrEqualTo

    Supported operators for CategoryType: ReservationUtilization

    • LessThan
    Threshold float64

    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.

    ContactGroups []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.

    ContactRoles []string

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

    Supported for CategoryType(s): Cost.

    Frequency string

    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 string

    Language in which the recipient will receive the notification,

    Supported for CategoryType(s): Cost, ReservationUtilization.

    ThresholdType string

    The type of threshold.

    Supported for CategoryType(s): Cost.

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

    enabled Boolean

    The notification is enabled or not.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    operator String

    The comparison operator.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported operators for CategoryType: Cost

    • GreaterThan
    • GreaterThanOrEqualTo

    Supported operators for CategoryType: ReservationUtilization

    • LessThan
    threshold 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.

    contactGroups List<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.

    contactRoles List<String>

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

    Supported for CategoryType(s): Cost.

    frequency String

    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 String

    Language in which the recipient will receive the notification,

    Supported for CategoryType(s): Cost, ReservationUtilization.

    thresholdType String

    The type of threshold.

    Supported for CategoryType(s): Cost.

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

    enabled boolean

    The notification is enabled or not.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    operator string

    The comparison operator.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported operators for CategoryType: Cost

    • GreaterThan
    • GreaterThanOrEqualTo

    Supported operators for CategoryType: ReservationUtilization

    • LessThan
    threshold number

    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.

    contactGroups 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.

    contactRoles string[]

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

    Supported for CategoryType(s): Cost.

    frequency string

    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 string

    Language in which the recipient will receive the notification,

    Supported for CategoryType(s): Cost, ReservationUtilization.

    thresholdType string

    The type of threshold.

    Supported for CategoryType(s): Cost.

    contact_emails Sequence[str]

    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.

    enabled bool

    The notification is enabled or not.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    operator str

    The comparison operator.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported operators for CategoryType: Cost

    • GreaterThan
    • GreaterThanOrEqualTo

    Supported operators for CategoryType: ReservationUtilization

    • LessThan
    threshold float

    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.

    contact_groups Sequence[str]

    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.

    contact_roles Sequence[str]

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

    Supported for CategoryType(s): Cost.

    frequency str

    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 str

    Language in which the recipient will receive the notification,

    Supported for CategoryType(s): Cost, ReservationUtilization.

    threshold_type str

    The type of threshold.

    Supported for CategoryType(s): Cost.

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

    enabled Boolean

    The notification is enabled or not.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    operator String

    The comparison operator.

    Supported for CategoryType(s): Cost, ReservationUtilization.

    Supported operators for CategoryType: Cost

    • GreaterThan
    • GreaterThanOrEqualTo

    Supported operators for CategoryType: ReservationUtilization

    • LessThan
    threshold Number

    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.

    contactGroups List<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.

    contactRoles List<String>

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

    Supported for CategoryType(s): Cost.

    frequency String

    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 String

    Language in which the recipient will receive the notification,

    Supported for CategoryType(s): Cost, ReservationUtilization.

    thresholdType String

    The type of threshold.

    Supported for CategoryType(s): Cost.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi
    pulumi/pulumi-azure-native