1. Packages
  2. Azure Classic
  3. API Docs
  4. consumption
  5. BudgetSubscription

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi

azure.consumption.BudgetSubscription

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Manages a Subscription Consumption Budget.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const current = azure.core.getSubscription({});
    const example = new azure.core.ResourceGroup("example", {
        name: "example",
        location: "eastus",
    });
    const exampleActionGroup = new azure.monitoring.ActionGroup("example", {
        name: "example",
        resourceGroupName: example.name,
        shortName: "example",
    });
    const exampleBudgetSubscription = new azure.consumption.BudgetSubscription("example", {
        name: "example",
        subscriptionId: current.then(current => current.id),
        amount: 1000,
        timeGrain: "Monthly",
        timePeriod: {
            startDate: "2022-06-01T00:00:00Z",
            endDate: "2022-07-01T00:00:00Z",
        },
        filter: {
            dimensions: [{
                name: "ResourceGroupName",
                values: [example.name],
            }],
            tags: [{
                name: "foo",
                values: [
                    "bar",
                    "baz",
                ],
            }],
        },
        notifications: [
            {
                enabled: true,
                threshold: 90,
                operator: "EqualTo",
                contactEmails: [
                    "foo@example.com",
                    "bar@example.com",
                ],
                contactGroups: [exampleActionGroup.id],
                contactRoles: ["Owner"],
            },
            {
                enabled: false,
                threshold: 100,
                operator: "GreaterThan",
                thresholdType: "Forecasted",
                contactEmails: [
                    "foo@example.com",
                    "bar@example.com",
                ],
            },
        ],
    });
    
    import pulumi
    import pulumi_azure as azure
    
    current = azure.core.get_subscription()
    example = azure.core.ResourceGroup("example",
        name="example",
        location="eastus")
    example_action_group = azure.monitoring.ActionGroup("example",
        name="example",
        resource_group_name=example.name,
        short_name="example")
    example_budget_subscription = azure.consumption.BudgetSubscription("example",
        name="example",
        subscription_id=current.id,
        amount=1000,
        time_grain="Monthly",
        time_period={
            "start_date": "2022-06-01T00:00:00Z",
            "end_date": "2022-07-01T00:00:00Z",
        },
        filter={
            "dimensions": [{
                "name": "ResourceGroupName",
                "values": [example.name],
            }],
            "tags": [{
                "name": "foo",
                "values": [
                    "bar",
                    "baz",
                ],
            }],
        },
        notifications=[
            {
                "enabled": True,
                "threshold": 90,
                "operator": "EqualTo",
                "contact_emails": [
                    "foo@example.com",
                    "bar@example.com",
                ],
                "contact_groups": [example_action_group.id],
                "contact_roles": ["Owner"],
            },
            {
                "enabled": False,
                "threshold": 100,
                "operator": "GreaterThan",
                "threshold_type": "Forecasted",
                "contact_emails": [
                    "foo@example.com",
                    "bar@example.com",
                ],
            },
        ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/consumption"
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/monitoring"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		current, err := core.LookupSubscription(ctx, &core.LookupSubscriptionArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example"),
    			Location: pulumi.String("eastus"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleActionGroup, err := monitoring.NewActionGroup(ctx, "example", &monitoring.ActionGroupArgs{
    			Name:              pulumi.String("example"),
    			ResourceGroupName: example.Name,
    			ShortName:         pulumi.String("example"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = consumption.NewBudgetSubscription(ctx, "example", &consumption.BudgetSubscriptionArgs{
    			Name:           pulumi.String("example"),
    			SubscriptionId: pulumi.String(current.Id),
    			Amount:         pulumi.Float64(1000),
    			TimeGrain:      pulumi.String("Monthly"),
    			TimePeriod: &consumption.BudgetSubscriptionTimePeriodArgs{
    				StartDate: pulumi.String("2022-06-01T00:00:00Z"),
    				EndDate:   pulumi.String("2022-07-01T00:00:00Z"),
    			},
    			Filter: &consumption.BudgetSubscriptionFilterArgs{
    				Dimensions: consumption.BudgetSubscriptionFilterDimensionArray{
    					&consumption.BudgetSubscriptionFilterDimensionArgs{
    						Name: pulumi.String("ResourceGroupName"),
    						Values: pulumi.StringArray{
    							example.Name,
    						},
    					},
    				},
    				Tags: consumption.BudgetSubscriptionFilterTagArray{
    					&consumption.BudgetSubscriptionFilterTagArgs{
    						Name: pulumi.String("foo"),
    						Values: pulumi.StringArray{
    							pulumi.String("bar"),
    							pulumi.String("baz"),
    						},
    					},
    				},
    			},
    			Notifications: consumption.BudgetSubscriptionNotificationArray{
    				&consumption.BudgetSubscriptionNotificationArgs{
    					Enabled:   pulumi.Bool(true),
    					Threshold: pulumi.Int(90),
    					Operator:  pulumi.String("EqualTo"),
    					ContactEmails: pulumi.StringArray{
    						pulumi.String("foo@example.com"),
    						pulumi.String("bar@example.com"),
    					},
    					ContactGroups: pulumi.StringArray{
    						exampleActionGroup.ID(),
    					},
    					ContactRoles: pulumi.StringArray{
    						pulumi.String("Owner"),
    					},
    				},
    				&consumption.BudgetSubscriptionNotificationArgs{
    					Enabled:       pulumi.Bool(false),
    					Threshold:     pulumi.Int(100),
    					Operator:      pulumi.String("GreaterThan"),
    					ThresholdType: pulumi.String("Forecasted"),
    					ContactEmails: pulumi.StringArray{
    						pulumi.String("foo@example.com"),
    						pulumi.String("bar@example.com"),
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var current = Azure.Core.GetSubscription.Invoke();
    
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example",
            Location = "eastus",
        });
    
        var exampleActionGroup = new Azure.Monitoring.ActionGroup("example", new()
        {
            Name = "example",
            ResourceGroupName = example.Name,
            ShortName = "example",
        });
    
        var exampleBudgetSubscription = new Azure.Consumption.BudgetSubscription("example", new()
        {
            Name = "example",
            SubscriptionId = current.Apply(getSubscriptionResult => getSubscriptionResult.Id),
            Amount = 1000,
            TimeGrain = "Monthly",
            TimePeriod = new Azure.Consumption.Inputs.BudgetSubscriptionTimePeriodArgs
            {
                StartDate = "2022-06-01T00:00:00Z",
                EndDate = "2022-07-01T00:00:00Z",
            },
            Filter = new Azure.Consumption.Inputs.BudgetSubscriptionFilterArgs
            {
                Dimensions = new[]
                {
                    new Azure.Consumption.Inputs.BudgetSubscriptionFilterDimensionArgs
                    {
                        Name = "ResourceGroupName",
                        Values = new[]
                        {
                            example.Name,
                        },
                    },
                },
                Tags = new[]
                {
                    new Azure.Consumption.Inputs.BudgetSubscriptionFilterTagArgs
                    {
                        Name = "foo",
                        Values = new[]
                        {
                            "bar",
                            "baz",
                        },
                    },
                },
            },
            Notifications = new[]
            {
                new Azure.Consumption.Inputs.BudgetSubscriptionNotificationArgs
                {
                    Enabled = true,
                    Threshold = 90,
                    Operator = "EqualTo",
                    ContactEmails = new[]
                    {
                        "foo@example.com",
                        "bar@example.com",
                    },
                    ContactGroups = new[]
                    {
                        exampleActionGroup.Id,
                    },
                    ContactRoles = new[]
                    {
                        "Owner",
                    },
                },
                new Azure.Consumption.Inputs.BudgetSubscriptionNotificationArgs
                {
                    Enabled = false,
                    Threshold = 100,
                    Operator = "GreaterThan",
                    ThresholdType = "Forecasted",
                    ContactEmails = new[]
                    {
                        "foo@example.com",
                        "bar@example.com",
                    },
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.CoreFunctions;
    import com.pulumi.azure.core.inputs.GetSubscriptionArgs;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.monitoring.ActionGroup;
    import com.pulumi.azure.monitoring.ActionGroupArgs;
    import com.pulumi.azure.consumption.BudgetSubscription;
    import com.pulumi.azure.consumption.BudgetSubscriptionArgs;
    import com.pulumi.azure.consumption.inputs.BudgetSubscriptionTimePeriodArgs;
    import com.pulumi.azure.consumption.inputs.BudgetSubscriptionFilterArgs;
    import com.pulumi.azure.consumption.inputs.BudgetSubscriptionNotificationArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var current = CoreFunctions.getSubscription();
    
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example")
                .location("eastus")
                .build());
    
            var exampleActionGroup = new ActionGroup("exampleActionGroup", ActionGroupArgs.builder()
                .name("example")
                .resourceGroupName(example.name())
                .shortName("example")
                .build());
    
            var exampleBudgetSubscription = new BudgetSubscription("exampleBudgetSubscription", BudgetSubscriptionArgs.builder()
                .name("example")
                .subscriptionId(current.applyValue(getSubscriptionResult -> getSubscriptionResult.id()))
                .amount(1000)
                .timeGrain("Monthly")
                .timePeriod(BudgetSubscriptionTimePeriodArgs.builder()
                    .startDate("2022-06-01T00:00:00Z")
                    .endDate("2022-07-01T00:00:00Z")
                    .build())
                .filter(BudgetSubscriptionFilterArgs.builder()
                    .dimensions(BudgetSubscriptionFilterDimensionArgs.builder()
                        .name("ResourceGroupName")
                        .values(example.name())
                        .build())
                    .tags(BudgetSubscriptionFilterTagArgs.builder()
                        .name("foo")
                        .values(                    
                            "bar",
                            "baz")
                        .build())
                    .build())
                .notifications(            
                    BudgetSubscriptionNotificationArgs.builder()
                        .enabled(true)
                        .threshold(90)
                        .operator("EqualTo")
                        .contactEmails(                    
                            "foo@example.com",
                            "bar@example.com")
                        .contactGroups(exampleActionGroup.id())
                        .contactRoles("Owner")
                        .build(),
                    BudgetSubscriptionNotificationArgs.builder()
                        .enabled(false)
                        .threshold(100)
                        .operator("GreaterThan")
                        .thresholdType("Forecasted")
                        .contactEmails(                    
                            "foo@example.com",
                            "bar@example.com")
                        .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example
          location: eastus
      exampleActionGroup:
        type: azure:monitoring:ActionGroup
        name: example
        properties:
          name: example
          resourceGroupName: ${example.name}
          shortName: example
      exampleBudgetSubscription:
        type: azure:consumption:BudgetSubscription
        name: example
        properties:
          name: example
          subscriptionId: ${current.id}
          amount: 1000
          timeGrain: Monthly
          timePeriod:
            startDate: 2022-06-01T00:00:00Z
            endDate: 2022-07-01T00:00:00Z
          filter:
            dimensions:
              - name: ResourceGroupName
                values:
                  - ${example.name}
            tags:
              - name: foo
                values:
                  - bar
                  - baz
          notifications:
            - enabled: true
              threshold: 90
              operator: EqualTo
              contactEmails:
                - foo@example.com
                - bar@example.com
              contactGroups:
                - ${exampleActionGroup.id}
              contactRoles:
                - Owner
            - enabled: false
              threshold: 100
              operator: GreaterThan
              thresholdType: Forecasted
              contactEmails:
                - foo@example.com
                - bar@example.com
    variables:
      current:
        fn::invoke:
          Function: azure:core:getSubscription
          Arguments: {}
    

    Create BudgetSubscription Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new BudgetSubscription(name: string, args: BudgetSubscriptionArgs, opts?: CustomResourceOptions);
    @overload
    def BudgetSubscription(resource_name: str,
                           args: BudgetSubscriptionArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def BudgetSubscription(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           amount: Optional[float] = None,
                           notifications: Optional[Sequence[BudgetSubscriptionNotificationArgs]] = None,
                           subscription_id: Optional[str] = None,
                           time_period: Optional[BudgetSubscriptionTimePeriodArgs] = None,
                           etag: Optional[str] = None,
                           filter: Optional[BudgetSubscriptionFilterArgs] = None,
                           name: Optional[str] = None,
                           time_grain: Optional[str] = None)
    func NewBudgetSubscription(ctx *Context, name string, args BudgetSubscriptionArgs, opts ...ResourceOption) (*BudgetSubscription, error)
    public BudgetSubscription(string name, BudgetSubscriptionArgs args, CustomResourceOptions? opts = null)
    public BudgetSubscription(String name, BudgetSubscriptionArgs args)
    public BudgetSubscription(String name, BudgetSubscriptionArgs args, CustomResourceOptions options)
    
    type: azure:consumption:BudgetSubscription
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args BudgetSubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BudgetSubscriptionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BudgetSubscriptionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BudgetSubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BudgetSubscriptionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var budgetSubscriptionResource = new Azure.Consumption.BudgetSubscription("budgetSubscriptionResource", new()
    {
        Amount = 0,
        Notifications = new[]
        {
            new Azure.Consumption.Inputs.BudgetSubscriptionNotificationArgs
            {
                Operator = "string",
                Threshold = 0,
                ContactEmails = new[]
                {
                    "string",
                },
                ContactGroups = new[]
                {
                    "string",
                },
                ContactRoles = new[]
                {
                    "string",
                },
                Enabled = false,
                ThresholdType = "string",
            },
        },
        SubscriptionId = "string",
        TimePeriod = new Azure.Consumption.Inputs.BudgetSubscriptionTimePeriodArgs
        {
            StartDate = "string",
            EndDate = "string",
        },
        Etag = "string",
        Filter = new Azure.Consumption.Inputs.BudgetSubscriptionFilterArgs
        {
            Dimensions = new[]
            {
                new Azure.Consumption.Inputs.BudgetSubscriptionFilterDimensionArgs
                {
                    Name = "string",
                    Values = new[]
                    {
                        "string",
                    },
                    Operator = "string",
                },
            },
            Tags = new[]
            {
                new Azure.Consumption.Inputs.BudgetSubscriptionFilterTagArgs
                {
                    Name = "string",
                    Values = new[]
                    {
                        "string",
                    },
                    Operator = "string",
                },
            },
        },
        Name = "string",
        TimeGrain = "string",
    });
    
    example, err := consumption.NewBudgetSubscription(ctx, "budgetSubscriptionResource", &consumption.BudgetSubscriptionArgs{
    	Amount: pulumi.Float64(0),
    	Notifications: consumption.BudgetSubscriptionNotificationArray{
    		&consumption.BudgetSubscriptionNotificationArgs{
    			Operator:  pulumi.String("string"),
    			Threshold: pulumi.Int(0),
    			ContactEmails: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			ContactGroups: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			ContactRoles: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			Enabled:       pulumi.Bool(false),
    			ThresholdType: pulumi.String("string"),
    		},
    	},
    	SubscriptionId: pulumi.String("string"),
    	TimePeriod: &consumption.BudgetSubscriptionTimePeriodArgs{
    		StartDate: pulumi.String("string"),
    		EndDate:   pulumi.String("string"),
    	},
    	Etag: pulumi.String("string"),
    	Filter: &consumption.BudgetSubscriptionFilterArgs{
    		Dimensions: consumption.BudgetSubscriptionFilterDimensionArray{
    			&consumption.BudgetSubscriptionFilterDimensionArgs{
    				Name: pulumi.String("string"),
    				Values: pulumi.StringArray{
    					pulumi.String("string"),
    				},
    				Operator: pulumi.String("string"),
    			},
    		},
    		Tags: consumption.BudgetSubscriptionFilterTagArray{
    			&consumption.BudgetSubscriptionFilterTagArgs{
    				Name: pulumi.String("string"),
    				Values: pulumi.StringArray{
    					pulumi.String("string"),
    				},
    				Operator: pulumi.String("string"),
    			},
    		},
    	},
    	Name:      pulumi.String("string"),
    	TimeGrain: pulumi.String("string"),
    })
    
    var budgetSubscriptionResource = new BudgetSubscription("budgetSubscriptionResource", BudgetSubscriptionArgs.builder()
        .amount(0)
        .notifications(BudgetSubscriptionNotificationArgs.builder()
            .operator("string")
            .threshold(0)
            .contactEmails("string")
            .contactGroups("string")
            .contactRoles("string")
            .enabled(false)
            .thresholdType("string")
            .build())
        .subscriptionId("string")
        .timePeriod(BudgetSubscriptionTimePeriodArgs.builder()
            .startDate("string")
            .endDate("string")
            .build())
        .etag("string")
        .filter(BudgetSubscriptionFilterArgs.builder()
            .dimensions(BudgetSubscriptionFilterDimensionArgs.builder()
                .name("string")
                .values("string")
                .operator("string")
                .build())
            .tags(BudgetSubscriptionFilterTagArgs.builder()
                .name("string")
                .values("string")
                .operator("string")
                .build())
            .build())
        .name("string")
        .timeGrain("string")
        .build());
    
    budget_subscription_resource = azure.consumption.BudgetSubscription("budgetSubscriptionResource",
        amount=0,
        notifications=[{
            "operator": "string",
            "threshold": 0,
            "contact_emails": ["string"],
            "contact_groups": ["string"],
            "contact_roles": ["string"],
            "enabled": False,
            "threshold_type": "string",
        }],
        subscription_id="string",
        time_period={
            "start_date": "string",
            "end_date": "string",
        },
        etag="string",
        filter={
            "dimensions": [{
                "name": "string",
                "values": ["string"],
                "operator": "string",
            }],
            "tags": [{
                "name": "string",
                "values": ["string"],
                "operator": "string",
            }],
        },
        name="string",
        time_grain="string")
    
    const budgetSubscriptionResource = new azure.consumption.BudgetSubscription("budgetSubscriptionResource", {
        amount: 0,
        notifications: [{
            operator: "string",
            threshold: 0,
            contactEmails: ["string"],
            contactGroups: ["string"],
            contactRoles: ["string"],
            enabled: false,
            thresholdType: "string",
        }],
        subscriptionId: "string",
        timePeriod: {
            startDate: "string",
            endDate: "string",
        },
        etag: "string",
        filter: {
            dimensions: [{
                name: "string",
                values: ["string"],
                operator: "string",
            }],
            tags: [{
                name: "string",
                values: ["string"],
                operator: "string",
            }],
        },
        name: "string",
        timeGrain: "string",
    });
    
    type: azure:consumption:BudgetSubscription
    properties:
        amount: 0
        etag: string
        filter:
            dimensions:
                - name: string
                  operator: string
                  values:
                    - string
            tags:
                - name: string
                  operator: string
                  values:
                    - string
        name: string
        notifications:
            - contactEmails:
                - string
              contactGroups:
                - string
              contactRoles:
                - string
              enabled: false
              operator: string
              threshold: 0
              thresholdType: string
        subscriptionId: string
        timeGrain: string
        timePeriod:
            endDate: string
            startDate: string
    

    BudgetSubscription Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The BudgetSubscription resource accepts the following input properties:

    Amount double
    The total amount of cost to track with the budget.
    Notifications List<BudgetSubscriptionNotification>
    One or more notification blocks as defined below.
    SubscriptionId string

    The ID of the Subscription for which to create a Consumption Budget. Changing this forces a new resource to be created.

    NOTE: The subscription_id property can accept a subscription ID e.g. 00000000-0000-0000-0000-000000000000 or the subscription resource ID e.g. /subscriptions/00000000-0000-0000-0000-000000000000. In version 3.0 this property will only accept the subscription resource ID.

    TimePeriod BudgetSubscriptionTimePeriod
    A time_period block as defined below.
    Etag string
    (Optional) The ETag of the Subscription Consumption Budget.
    Filter BudgetSubscriptionFilter
    A filter block as defined below.
    Name string
    The name which should be used for this Subscription Consumption Budget. Changing this forces a new resource to be created.
    TimeGrain string
    The time covered by a budget. Tracking of the amount will be reset based on the time grain. Must be one of BillingAnnual, BillingMonth, BillingQuarter, Annually, Monthly and Quarterly. Defaults to Monthly. Changing this forces a new resource to be created.
    Amount float64
    The total amount of cost to track with the budget.
    Notifications []BudgetSubscriptionNotificationArgs
    One or more notification blocks as defined below.
    SubscriptionId string

    The ID of the Subscription for which to create a Consumption Budget. Changing this forces a new resource to be created.

    NOTE: The subscription_id property can accept a subscription ID e.g. 00000000-0000-0000-0000-000000000000 or the subscription resource ID e.g. /subscriptions/00000000-0000-0000-0000-000000000000. In version 3.0 this property will only accept the subscription resource ID.

    TimePeriod BudgetSubscriptionTimePeriodArgs
    A time_period block as defined below.
    Etag string
    (Optional) The ETag of the Subscription Consumption Budget.
    Filter BudgetSubscriptionFilterArgs
    A filter block as defined below.
    Name string
    The name which should be used for this Subscription Consumption Budget. Changing this forces a new resource to be created.
    TimeGrain string
    The time covered by a budget. Tracking of the amount will be reset based on the time grain. Must be one of BillingAnnual, BillingMonth, BillingQuarter, Annually, Monthly and Quarterly. Defaults to Monthly. Changing this forces a new resource to be created.
    amount Double
    The total amount of cost to track with the budget.
    notifications List<BudgetSubscriptionNotification>
    One or more notification blocks as defined below.
    subscriptionId String

    The ID of the Subscription for which to create a Consumption Budget. Changing this forces a new resource to be created.

    NOTE: The subscription_id property can accept a subscription ID e.g. 00000000-0000-0000-0000-000000000000 or the subscription resource ID e.g. /subscriptions/00000000-0000-0000-0000-000000000000. In version 3.0 this property will only accept the subscription resource ID.

    timePeriod BudgetSubscriptionTimePeriod
    A time_period block as defined below.
    etag String
    (Optional) The ETag of the Subscription Consumption Budget.
    filter BudgetSubscriptionFilter
    A filter block as defined below.
    name String
    The name which should be used for this Subscription Consumption Budget. Changing this forces a new resource to be created.
    timeGrain String
    The time covered by a budget. Tracking of the amount will be reset based on the time grain. Must be one of BillingAnnual, BillingMonth, BillingQuarter, Annually, Monthly and Quarterly. Defaults to Monthly. Changing this forces a new resource to be created.
    amount number
    The total amount of cost to track with the budget.
    notifications BudgetSubscriptionNotification[]
    One or more notification blocks as defined below.
    subscriptionId string

    The ID of the Subscription for which to create a Consumption Budget. Changing this forces a new resource to be created.

    NOTE: The subscription_id property can accept a subscription ID e.g. 00000000-0000-0000-0000-000000000000 or the subscription resource ID e.g. /subscriptions/00000000-0000-0000-0000-000000000000. In version 3.0 this property will only accept the subscription resource ID.

    timePeriod BudgetSubscriptionTimePeriod
    A time_period block as defined below.
    etag string
    (Optional) The ETag of the Subscription Consumption Budget.
    filter BudgetSubscriptionFilter
    A filter block as defined below.
    name string
    The name which should be used for this Subscription Consumption Budget. Changing this forces a new resource to be created.
    timeGrain string
    The time covered by a budget. Tracking of the amount will be reset based on the time grain. Must be one of BillingAnnual, BillingMonth, BillingQuarter, Annually, Monthly and Quarterly. Defaults to Monthly. Changing this forces a new resource to be created.
    amount float
    The total amount of cost to track with the budget.
    notifications Sequence[BudgetSubscriptionNotificationArgs]
    One or more notification blocks as defined below.
    subscription_id str

    The ID of the Subscription for which to create a Consumption Budget. Changing this forces a new resource to be created.

    NOTE: The subscription_id property can accept a subscription ID e.g. 00000000-0000-0000-0000-000000000000 or the subscription resource ID e.g. /subscriptions/00000000-0000-0000-0000-000000000000. In version 3.0 this property will only accept the subscription resource ID.

    time_period BudgetSubscriptionTimePeriodArgs
    A time_period block as defined below.
    etag str
    (Optional) The ETag of the Subscription Consumption Budget.
    filter BudgetSubscriptionFilterArgs
    A filter block as defined below.
    name str
    The name which should be used for this Subscription Consumption Budget. Changing this forces a new resource to be created.
    time_grain str
    The time covered by a budget. Tracking of the amount will be reset based on the time grain. Must be one of BillingAnnual, BillingMonth, BillingQuarter, Annually, Monthly and Quarterly. Defaults to Monthly. Changing this forces a new resource to be created.
    amount Number
    The total amount of cost to track with the budget.
    notifications List<Property Map>
    One or more notification blocks as defined below.
    subscriptionId String

    The ID of the Subscription for which to create a Consumption Budget. Changing this forces a new resource to be created.

    NOTE: The subscription_id property can accept a subscription ID e.g. 00000000-0000-0000-0000-000000000000 or the subscription resource ID e.g. /subscriptions/00000000-0000-0000-0000-000000000000. In version 3.0 this property will only accept the subscription resource ID.

    timePeriod Property Map
    A time_period block as defined below.
    etag String
    (Optional) The ETag of the Subscription Consumption Budget.
    filter Property Map
    A filter block as defined below.
    name String
    The name which should be used for this Subscription Consumption Budget. Changing this forces a new resource to be created.
    timeGrain String
    The time covered by a budget. Tracking of the amount will be reset based on the time grain. Must be one of BillingAnnual, BillingMonth, BillingQuarter, Annually, Monthly and Quarterly. Defaults to Monthly. Changing this forces a new resource to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BudgetSubscription resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing BudgetSubscription Resource

    Get an existing BudgetSubscription resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BudgetSubscriptionState, opts?: CustomResourceOptions): BudgetSubscription
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            amount: Optional[float] = None,
            etag: Optional[str] = None,
            filter: Optional[BudgetSubscriptionFilterArgs] = None,
            name: Optional[str] = None,
            notifications: Optional[Sequence[BudgetSubscriptionNotificationArgs]] = None,
            subscription_id: Optional[str] = None,
            time_grain: Optional[str] = None,
            time_period: Optional[BudgetSubscriptionTimePeriodArgs] = None) -> BudgetSubscription
    func GetBudgetSubscription(ctx *Context, name string, id IDInput, state *BudgetSubscriptionState, opts ...ResourceOption) (*BudgetSubscription, error)
    public static BudgetSubscription Get(string name, Input<string> id, BudgetSubscriptionState? state, CustomResourceOptions? opts = null)
    public static BudgetSubscription get(String name, Output<String> id, BudgetSubscriptionState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Amount double
    The total amount of cost to track with the budget.
    Etag string
    (Optional) The ETag of the Subscription Consumption Budget.
    Filter BudgetSubscriptionFilter
    A filter block as defined below.
    Name string
    The name which should be used for this Subscription Consumption Budget. Changing this forces a new resource to be created.
    Notifications List<BudgetSubscriptionNotification>
    One or more notification blocks as defined below.
    SubscriptionId string

    The ID of the Subscription for which to create a Consumption Budget. Changing this forces a new resource to be created.

    NOTE: The subscription_id property can accept a subscription ID e.g. 00000000-0000-0000-0000-000000000000 or the subscription resource ID e.g. /subscriptions/00000000-0000-0000-0000-000000000000. In version 3.0 this property will only accept the subscription resource ID.

    TimeGrain string
    The time covered by a budget. Tracking of the amount will be reset based on the time grain. Must be one of BillingAnnual, BillingMonth, BillingQuarter, Annually, Monthly and Quarterly. Defaults to Monthly. Changing this forces a new resource to be created.
    TimePeriod BudgetSubscriptionTimePeriod
    A time_period block as defined below.
    Amount float64
    The total amount of cost to track with the budget.
    Etag string
    (Optional) The ETag of the Subscription Consumption Budget.
    Filter BudgetSubscriptionFilterArgs
    A filter block as defined below.
    Name string
    The name which should be used for this Subscription Consumption Budget. Changing this forces a new resource to be created.
    Notifications []BudgetSubscriptionNotificationArgs
    One or more notification blocks as defined below.
    SubscriptionId string

    The ID of the Subscription for which to create a Consumption Budget. Changing this forces a new resource to be created.

    NOTE: The subscription_id property can accept a subscription ID e.g. 00000000-0000-0000-0000-000000000000 or the subscription resource ID e.g. /subscriptions/00000000-0000-0000-0000-000000000000. In version 3.0 this property will only accept the subscription resource ID.

    TimeGrain string
    The time covered by a budget. Tracking of the amount will be reset based on the time grain. Must be one of BillingAnnual, BillingMonth, BillingQuarter, Annually, Monthly and Quarterly. Defaults to Monthly. Changing this forces a new resource to be created.
    TimePeriod BudgetSubscriptionTimePeriodArgs
    A time_period block as defined below.
    amount Double
    The total amount of cost to track with the budget.
    etag String
    (Optional) The ETag of the Subscription Consumption Budget.
    filter BudgetSubscriptionFilter
    A filter block as defined below.
    name String
    The name which should be used for this Subscription Consumption Budget. Changing this forces a new resource to be created.
    notifications List<BudgetSubscriptionNotification>
    One or more notification blocks as defined below.
    subscriptionId String

    The ID of the Subscription for which to create a Consumption Budget. Changing this forces a new resource to be created.

    NOTE: The subscription_id property can accept a subscription ID e.g. 00000000-0000-0000-0000-000000000000 or the subscription resource ID e.g. /subscriptions/00000000-0000-0000-0000-000000000000. In version 3.0 this property will only accept the subscription resource ID.

    timeGrain String
    The time covered by a budget. Tracking of the amount will be reset based on the time grain. Must be one of BillingAnnual, BillingMonth, BillingQuarter, Annually, Monthly and Quarterly. Defaults to Monthly. Changing this forces a new resource to be created.
    timePeriod BudgetSubscriptionTimePeriod
    A time_period block as defined below.
    amount number
    The total amount of cost to track with the budget.
    etag string
    (Optional) The ETag of the Subscription Consumption Budget.
    filter BudgetSubscriptionFilter
    A filter block as defined below.
    name string
    The name which should be used for this Subscription Consumption Budget. Changing this forces a new resource to be created.
    notifications BudgetSubscriptionNotification[]
    One or more notification blocks as defined below.
    subscriptionId string

    The ID of the Subscription for which to create a Consumption Budget. Changing this forces a new resource to be created.

    NOTE: The subscription_id property can accept a subscription ID e.g. 00000000-0000-0000-0000-000000000000 or the subscription resource ID e.g. /subscriptions/00000000-0000-0000-0000-000000000000. In version 3.0 this property will only accept the subscription resource ID.

    timeGrain string
    The time covered by a budget. Tracking of the amount will be reset based on the time grain. Must be one of BillingAnnual, BillingMonth, BillingQuarter, Annually, Monthly and Quarterly. Defaults to Monthly. Changing this forces a new resource to be created.
    timePeriod BudgetSubscriptionTimePeriod
    A time_period block as defined below.
    amount float
    The total amount of cost to track with the budget.
    etag str
    (Optional) The ETag of the Subscription Consumption Budget.
    filter BudgetSubscriptionFilterArgs
    A filter block as defined below.
    name str
    The name which should be used for this Subscription Consumption Budget. Changing this forces a new resource to be created.
    notifications Sequence[BudgetSubscriptionNotificationArgs]
    One or more notification blocks as defined below.
    subscription_id str

    The ID of the Subscription for which to create a Consumption Budget. Changing this forces a new resource to be created.

    NOTE: The subscription_id property can accept a subscription ID e.g. 00000000-0000-0000-0000-000000000000 or the subscription resource ID e.g. /subscriptions/00000000-0000-0000-0000-000000000000. In version 3.0 this property will only accept the subscription resource ID.

    time_grain str
    The time covered by a budget. Tracking of the amount will be reset based on the time grain. Must be one of BillingAnnual, BillingMonth, BillingQuarter, Annually, Monthly and Quarterly. Defaults to Monthly. Changing this forces a new resource to be created.
    time_period BudgetSubscriptionTimePeriodArgs
    A time_period block as defined below.
    amount Number
    The total amount of cost to track with the budget.
    etag String
    (Optional) The ETag of the Subscription Consumption Budget.
    filter Property Map
    A filter block as defined below.
    name String
    The name which should be used for this Subscription Consumption Budget. Changing this forces a new resource to be created.
    notifications List<Property Map>
    One or more notification blocks as defined below.
    subscriptionId String

    The ID of the Subscription for which to create a Consumption Budget. Changing this forces a new resource to be created.

    NOTE: The subscription_id property can accept a subscription ID e.g. 00000000-0000-0000-0000-000000000000 or the subscription resource ID e.g. /subscriptions/00000000-0000-0000-0000-000000000000. In version 3.0 this property will only accept the subscription resource ID.

    timeGrain String
    The time covered by a budget. Tracking of the amount will be reset based on the time grain. Must be one of BillingAnnual, BillingMonth, BillingQuarter, Annually, Monthly and Quarterly. Defaults to Monthly. Changing this forces a new resource to be created.
    timePeriod Property Map
    A time_period block as defined below.

    Supporting Types

    BudgetSubscriptionFilter, BudgetSubscriptionFilterArgs

    Dimensions List<BudgetSubscriptionFilterDimension>
    One or more dimension blocks as defined below to filter the budget on.
    Tags List<BudgetSubscriptionFilterTag>
    One or more tag blocks as defined below to filter the budget on.
    Dimensions []BudgetSubscriptionFilterDimension
    One or more dimension blocks as defined below to filter the budget on.
    Tags []BudgetSubscriptionFilterTag
    One or more tag blocks as defined below to filter the budget on.
    dimensions List<BudgetSubscriptionFilterDimension>
    One or more dimension blocks as defined below to filter the budget on.
    tags List<BudgetSubscriptionFilterTag>
    One or more tag blocks as defined below to filter the budget on.
    dimensions BudgetSubscriptionFilterDimension[]
    One or more dimension blocks as defined below to filter the budget on.
    tags BudgetSubscriptionFilterTag[]
    One or more tag blocks as defined below to filter the budget on.
    dimensions Sequence[BudgetSubscriptionFilterDimension]
    One or more dimension blocks as defined below to filter the budget on.
    tags Sequence[BudgetSubscriptionFilterTag]
    One or more tag blocks as defined below to filter the budget on.
    dimensions List<Property Map>
    One or more dimension blocks as defined below to filter the budget on.
    tags List<Property Map>
    One or more tag blocks as defined below to filter the budget on.

    BudgetSubscriptionFilterDimension, BudgetSubscriptionFilterDimensionArgs

    Name string
    The name of the column to use for the filter. The allowed values are ChargeType, Frequency, InvoiceId, Meter, MeterCategory, MeterSubCategory, PartNumber, PricingModel, Product, ProductOrderId, ProductOrderName, PublisherType, ReservationId, ReservationName, ResourceGroupName, ResourceGuid, ResourceId, ResourceLocation, ResourceType, ServiceFamily, ServiceName, SubscriptionID, SubscriptionName, UnitOfMeasure.
    Values List<string>
    Specifies a list of values for the column.
    Operator string
    The operator to use for comparison. The allowed values are In. Defaults to In.
    Name string
    The name of the column to use for the filter. The allowed values are ChargeType, Frequency, InvoiceId, Meter, MeterCategory, MeterSubCategory, PartNumber, PricingModel, Product, ProductOrderId, ProductOrderName, PublisherType, ReservationId, ReservationName, ResourceGroupName, ResourceGuid, ResourceId, ResourceLocation, ResourceType, ServiceFamily, ServiceName, SubscriptionID, SubscriptionName, UnitOfMeasure.
    Values []string
    Specifies a list of values for the column.
    Operator string
    The operator to use for comparison. The allowed values are In. Defaults to In.
    name String
    The name of the column to use for the filter. The allowed values are ChargeType, Frequency, InvoiceId, Meter, MeterCategory, MeterSubCategory, PartNumber, PricingModel, Product, ProductOrderId, ProductOrderName, PublisherType, ReservationId, ReservationName, ResourceGroupName, ResourceGuid, ResourceId, ResourceLocation, ResourceType, ServiceFamily, ServiceName, SubscriptionID, SubscriptionName, UnitOfMeasure.
    values List<String>
    Specifies a list of values for the column.
    operator String
    The operator to use for comparison. The allowed values are In. Defaults to In.
    name string
    The name of the column to use for the filter. The allowed values are ChargeType, Frequency, InvoiceId, Meter, MeterCategory, MeterSubCategory, PartNumber, PricingModel, Product, ProductOrderId, ProductOrderName, PublisherType, ReservationId, ReservationName, ResourceGroupName, ResourceGuid, ResourceId, ResourceLocation, ResourceType, ServiceFamily, ServiceName, SubscriptionID, SubscriptionName, UnitOfMeasure.
    values string[]
    Specifies a list of values for the column.
    operator string
    The operator to use for comparison. The allowed values are In. Defaults to In.
    name str
    The name of the column to use for the filter. The allowed values are ChargeType, Frequency, InvoiceId, Meter, MeterCategory, MeterSubCategory, PartNumber, PricingModel, Product, ProductOrderId, ProductOrderName, PublisherType, ReservationId, ReservationName, ResourceGroupName, ResourceGuid, ResourceId, ResourceLocation, ResourceType, ServiceFamily, ServiceName, SubscriptionID, SubscriptionName, UnitOfMeasure.
    values Sequence[str]
    Specifies a list of values for the column.
    operator str
    The operator to use for comparison. The allowed values are In. Defaults to In.
    name String
    The name of the column to use for the filter. The allowed values are ChargeType, Frequency, InvoiceId, Meter, MeterCategory, MeterSubCategory, PartNumber, PricingModel, Product, ProductOrderId, ProductOrderName, PublisherType, ReservationId, ReservationName, ResourceGroupName, ResourceGuid, ResourceId, ResourceLocation, ResourceType, ServiceFamily, ServiceName, SubscriptionID, SubscriptionName, UnitOfMeasure.
    values List<String>
    Specifies a list of values for the column.
    operator String
    The operator to use for comparison. The allowed values are In. Defaults to In.

    BudgetSubscriptionFilterTag, BudgetSubscriptionFilterTagArgs

    Name string
    The name of the tag to use for the filter.
    Values List<string>
    Specifies a list of values for the tag.
    Operator string
    The operator to use for comparison. The allowed values are In. Defaults to In.
    Name string
    The name of the tag to use for the filter.
    Values []string
    Specifies a list of values for the tag.
    Operator string
    The operator to use for comparison. The allowed values are In. Defaults to In.
    name String
    The name of the tag to use for the filter.
    values List<String>
    Specifies a list of values for the tag.
    operator String
    The operator to use for comparison. The allowed values are In. Defaults to In.
    name string
    The name of the tag to use for the filter.
    values string[]
    Specifies a list of values for the tag.
    operator string
    The operator to use for comparison. The allowed values are In. Defaults to In.
    name str
    The name of the tag to use for the filter.
    values Sequence[str]
    Specifies a list of values for the tag.
    operator str
    The operator to use for comparison. The allowed values are In. Defaults to In.
    name String
    The name of the tag to use for the filter.
    values List<String>
    Specifies a list of values for the tag.
    operator String
    The operator to use for comparison. The allowed values are In. Defaults to In.

    BudgetSubscriptionNotification, BudgetSubscriptionNotificationArgs

    Operator string
    The comparison operator for the notification. Must be one of EqualTo, GreaterThan, or GreaterThanOrEqualTo.
    Threshold int
    Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.
    ContactEmails List<string>
    Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.
    ContactGroups List<string>
    Specifies a list of Action Group IDs to send the budget notification to when the threshold is exceeded.
    ContactRoles List<string>
    Specifies a list of contact roles to send the budget notification to when the threshold is exceeded.
    Enabled bool

    Should the notification be enabled? Defaults to true.

    NOTE: A notification block cannot have all of contact_emails, contact_roles, and contact_groups empty. This means that at least one of the three must be specified.

    ThresholdType string
    The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are Actual and Forecasted. Default is Actual.
    Operator string
    The comparison operator for the notification. Must be one of EqualTo, GreaterThan, or GreaterThanOrEqualTo.
    Threshold int
    Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.
    ContactEmails []string
    Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.
    ContactGroups []string
    Specifies a list of Action Group IDs to send the budget notification to when the threshold is exceeded.
    ContactRoles []string
    Specifies a list of contact roles to send the budget notification to when the threshold is exceeded.
    Enabled bool

    Should the notification be enabled? Defaults to true.

    NOTE: A notification block cannot have all of contact_emails, contact_roles, and contact_groups empty. This means that at least one of the three must be specified.

    ThresholdType string
    The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are Actual and Forecasted. Default is Actual.
    operator String
    The comparison operator for the notification. Must be one of EqualTo, GreaterThan, or GreaterThanOrEqualTo.
    threshold Integer
    Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.
    contactEmails List<String>
    Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.
    contactGroups List<String>
    Specifies a list of Action Group IDs to send the budget notification to when the threshold is exceeded.
    contactRoles List<String>
    Specifies a list of contact roles to send the budget notification to when the threshold is exceeded.
    enabled Boolean

    Should the notification be enabled? Defaults to true.

    NOTE: A notification block cannot have all of contact_emails, contact_roles, and contact_groups empty. This means that at least one of the three must be specified.

    thresholdType String
    The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are Actual and Forecasted. Default is Actual.
    operator string
    The comparison operator for the notification. Must be one of EqualTo, GreaterThan, or GreaterThanOrEqualTo.
    threshold number
    Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.
    contactEmails string[]
    Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.
    contactGroups string[]
    Specifies a list of Action Group IDs to send the budget notification to when the threshold is exceeded.
    contactRoles string[]
    Specifies a list of contact roles to send the budget notification to when the threshold is exceeded.
    enabled boolean

    Should the notification be enabled? Defaults to true.

    NOTE: A notification block cannot have all of contact_emails, contact_roles, and contact_groups empty. This means that at least one of the three must be specified.

    thresholdType string
    The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are Actual and Forecasted. Default is Actual.
    operator str
    The comparison operator for the notification. Must be one of EqualTo, GreaterThan, or GreaterThanOrEqualTo.
    threshold int
    Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.
    contact_emails Sequence[str]
    Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.
    contact_groups Sequence[str]
    Specifies a list of Action Group IDs to send the budget notification to when the threshold is exceeded.
    contact_roles Sequence[str]
    Specifies a list of contact roles to send the budget notification to when the threshold is exceeded.
    enabled bool

    Should the notification be enabled? Defaults to true.

    NOTE: A notification block cannot have all of contact_emails, contact_roles, and contact_groups empty. This means that at least one of the three must be specified.

    threshold_type str
    The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are Actual and Forecasted. Default is Actual.
    operator String
    The comparison operator for the notification. Must be one of EqualTo, GreaterThan, or GreaterThanOrEqualTo.
    threshold Number
    Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.
    contactEmails List<String>
    Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.
    contactGroups List<String>
    Specifies a list of Action Group IDs to send the budget notification to when the threshold is exceeded.
    contactRoles List<String>
    Specifies a list of contact roles to send the budget notification to when the threshold is exceeded.
    enabled Boolean

    Should the notification be enabled? Defaults to true.

    NOTE: A notification block cannot have all of contact_emails, contact_roles, and contact_groups empty. This means that at least one of the three must be specified.

    thresholdType String
    The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are Actual and Forecasted. Default is Actual.

    BudgetSubscriptionTimePeriod, BudgetSubscriptionTimePeriodArgs

    StartDate string
    The start date for the budget. The start date 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. Changing this forces a new Subscription Consumption Budget to be created.
    EndDate string
    The end date for the budget. If not set this will be 10 years after the start date.
    StartDate string
    The start date for the budget. The start date 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. Changing this forces a new Subscription Consumption Budget to be created.
    EndDate string
    The end date for the budget. If not set this will be 10 years after the start date.
    startDate String
    The start date for the budget. The start date 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. Changing this forces a new Subscription Consumption Budget to be created.
    endDate String
    The end date for the budget. If not set this will be 10 years after the start date.
    startDate string
    The start date for the budget. The start date 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. Changing this forces a new Subscription Consumption Budget to be created.
    endDate string
    The end date for the budget. If not set this will be 10 years after the start date.
    start_date str
    The start date for the budget. The start date 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. Changing this forces a new Subscription Consumption Budget to be created.
    end_date str
    The end date for the budget. If not set this will be 10 years after the start date.
    startDate String
    The start date for the budget. The start date 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. Changing this forces a new Subscription Consumption Budget to be created.
    endDate String
    The end date for the budget. If not set this will be 10 years after the start date.

    Import

    Subscription Consumption Budgets can be imported using the resource id, e.g.

    $ pulumi import azure:consumption/budgetSubscription:BudgetSubscription example /subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/subscription1
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi