Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. costmanagement
  5. ScheduledActionByScope
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.costmanagement.ScheduledActionByScope

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Scheduled action definition. API Version: 2022-04-01-preview.

    Example Usage

    CreateOrUpdateScheduledActionByScope

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var scheduledActionByScope = new AzureNative.CostManagement.ScheduledActionByScope("scheduledActionByScope", new()
    {
        DisplayName = "Monthly Cost By Resource",
        FileDestination = new AzureNative.CostManagement.Inputs.FileDestinationArgs
        {
            FileFormats = new[]
            {
                "Csv",
            },
        },
        Kind = "Email",
        Name = "monthlyCostByResource",
        Notification = new AzureNative.CostManagement.Inputs.NotificationPropertiesArgs
        {
            Subject = "Cost by resource this month",
            To = new[]
            {
                "user@gmail.com",
                "team@gmail.com",
            },
        },
        Schedule = new AzureNative.CostManagement.Inputs.SchedulePropertiesArgs
        {
            DaysOfWeek = new[]
            {
                "Monday",
            },
            EndDate = "2021-06-19T22:21:51.1287144Z",
            Frequency = "Monthly",
            HourOfDay = 10,
            StartDate = "2020-06-19T22:21:51.1287144Z",
            WeeksOfMonth = new[]
            {
                "First",
                "Third",
            },
        },
        Scope = "subscriptions/00000000-0000-0000-0000-000000000000",
        Status = "Enabled",
        ViewId = "/providers/Microsoft.CostManagement/views/swaggerExample",
    });

});

    package main

import (
	costmanagement "github.com/pulumi/pulumi-azure-native-sdk/costmanagement"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := costmanagement.NewScheduledActionByScope(ctx, "scheduledActionByScope", &costmanagement.ScheduledActionByScopeArgs{
			DisplayName: pulumi.String("Monthly Cost By Resource"),
			FileDestination: &costmanagement.FileDestinationArgs{
				FileFormats: pulumi.StringArray{
					pulumi.String("Csv"),
				},
			},
			Kind: pulumi.String("Email"),
			Name: pulumi.String("monthlyCostByResource"),
			Notification: &costmanagement.NotificationPropertiesArgs{
				Subject: pulumi.String("Cost by resource this month"),
				To: pulumi.StringArray{
					pulumi.String("user@gmail.com"),
					pulumi.String("team@gmail.com"),
				},
			},
			Schedule: &costmanagement.SchedulePropertiesArgs{
				DaysOfWeek: pulumi.StringArray{
					pulumi.String("Monday"),
				},
				EndDate:   pulumi.String("2021-06-19T22:21:51.1287144Z"),
				Frequency: pulumi.String("Monthly"),
				HourOfDay: pulumi.Int(10),
				StartDate: pulumi.String("2020-06-19T22:21:51.1287144Z"),
				WeeksOfMonth: pulumi.StringArray{
					pulumi.String("First"),
					pulumi.String("Third"),
				},
			},
			Scope:  pulumi.String("subscriptions/00000000-0000-0000-0000-000000000000"),
			Status: pulumi.String("Enabled"),
			ViewId: pulumi.String("/providers/Microsoft.CostManagement/views/swaggerExample"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.costmanagement.ScheduledActionByScope;
import com.pulumi.azurenative.costmanagement.ScheduledActionByScopeArgs;
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) {
        var scheduledActionByScope = new ScheduledActionByScope("scheduledActionByScope", ScheduledActionByScopeArgs.builder()        
            .displayName("Monthly Cost By Resource")
            .fileDestination(Map.of("fileFormats", "Csv"))
            .kind("Email")
            .name("monthlyCostByResource")
            .notification(Map.ofEntries(
                Map.entry("subject", "Cost by resource this month"),
                Map.entry("to",                 
                    "user@gmail.com",
                    "team@gmail.com")
            ))
            .schedule(Map.ofEntries(
                Map.entry("daysOfWeek", "Monday"),
                Map.entry("endDate", "2021-06-19T22:21:51.1287144Z"),
                Map.entry("frequency", "Monthly"),
                Map.entry("hourOfDay", 10),
                Map.entry("startDate", "2020-06-19T22:21:51.1287144Z"),
                Map.entry("weeksOfMonth",                 
                    "First",
                    "Third")
            ))
            .scope("subscriptions/00000000-0000-0000-0000-000000000000")
            .status("Enabled")
            .viewId("/providers/Microsoft.CostManagement/views/swaggerExample")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const scheduledActionByScope = new azure_native.costmanagement.ScheduledActionByScope("scheduledActionByScope", {
    displayName: "Monthly Cost By Resource",
    fileDestination: {
        fileFormats: ["Csv"],
    },
    kind: "Email",
    name: "monthlyCostByResource",
    notification: {
        subject: "Cost by resource this month",
        to: [
            "user@gmail.com",
            "team@gmail.com",
        ],
    },
    schedule: {
        daysOfWeek: ["Monday"],
        endDate: "2021-06-19T22:21:51.1287144Z",
        frequency: "Monthly",
        hourOfDay: 10,
        startDate: "2020-06-19T22:21:51.1287144Z",
        weeksOfMonth: [
            "First",
            "Third",
        ],
    },
    scope: "subscriptions/00000000-0000-0000-0000-000000000000",
    status: "Enabled",
    viewId: "/providers/Microsoft.CostManagement/views/swaggerExample",
});

    import pulumi
import pulumi_azure_native as azure_native

scheduled_action_by_scope = azure_native.costmanagement.ScheduledActionByScope("scheduledActionByScope",
    display_name="Monthly Cost By Resource",
    file_destination=azure_native.costmanagement.FileDestinationArgs(
        file_formats=["Csv"],
    ),
    kind="Email",
    name="monthlyCostByResource",
    notification=azure_native.costmanagement.NotificationPropertiesArgs(
        subject="Cost by resource this month",
        to=[
            "user@gmail.com",
            "team@gmail.com",
        ],
    ),
    schedule=azure_native.costmanagement.SchedulePropertiesArgs(
        days_of_week=["Monday"],
        end_date="2021-06-19T22:21:51.1287144Z",
        frequency="Monthly",
        hour_of_day=10,
        start_date="2020-06-19T22:21:51.1287144Z",
        weeks_of_month=[
            "First",
            "Third",
        ],
    ),
    scope="subscriptions/00000000-0000-0000-0000-000000000000",
    status="Enabled",
    view_id="/providers/Microsoft.CostManagement/views/swaggerExample")

    resources:
  scheduledActionByScope:
    type: azure-native:costmanagement:ScheduledActionByScope
    properties:
      displayName: Monthly Cost By Resource
      fileDestination:
        fileFormats:
          - Csv
      kind: Email
      name: monthlyCostByResource
      notification:
        subject: Cost by resource this month
        to:
          - user@gmail.com
          - team@gmail.com
      schedule:
        daysOfWeek:
          - Monday
        endDate: 2021-06-19T22:21:51.1287144Z
        frequency: Monthly
        hourOfDay: 10
        startDate: 2020-06-19T22:21:51.1287144Z
        weeksOfMonth:
          - First
          - Third
      scope: subscriptions/00000000-0000-0000-0000-000000000000
      status: Enabled
      viewId: /providers/Microsoft.CostManagement/views/swaggerExample

    Create ScheduledActionByScope Resource

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

    Constructor syntax

    new ScheduledActionByScope(name: string, args: ScheduledActionByScopeArgs, opts?: CustomResourceOptions);
    @overload
def ScheduledActionByScope(resource_name: str,
                           args: ScheduledActionByScopeArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def ScheduledActionByScope(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           display_name: Optional[str] = None,
                           notification: Optional[NotificationPropertiesArgs] = None,
                           schedule: Optional[SchedulePropertiesArgs] = None,
                           scope: Optional[str] = None,
                           status: Optional[Union[str, ScheduledActionStatus]] = None,
                           view_id: Optional[str] = None,
                           file_destination: Optional[FileDestinationArgs] = None,
                           kind: Optional[Union[str, ScheduledActionKind]] = None,
                           name: Optional[str] = None)
    func NewScheduledActionByScope(ctx *Context, name string, args ScheduledActionByScopeArgs, opts ...ResourceOption) (*ScheduledActionByScope, error)
    public ScheduledActionByScope(string name, ScheduledActionByScopeArgs args, CustomResourceOptions? opts = null)
    public ScheduledActionByScope(String name, ScheduledActionByScopeArgs args)
public ScheduledActionByScope(String name, ScheduledActionByScopeArgs args, CustomResourceOptions options)

    type: azure-native:costmanagement:ScheduledActionByScope
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 ScheduledActionByScopeArgs
    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 ScheduledActionByScopeArgs
    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 ScheduledActionByScopeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScheduledActionByScopeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScheduledActionByScopeArgs
    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 scheduledActionByScopeResource = new AzureNative.Costmanagement.ScheduledActionByScope("scheduledActionByScopeResource", new()
{
    DisplayName = "string",
    Notification = 
    {
        { "subject", "string" },
        { "to", new[]
        {
            "string",
        } },
        { "message", "string" },
    },
    Schedule = 
    {
        { "endDate", "string" },
        { "frequency", "string" },
        { "startDate", "string" },
        { "dayOfMonth", 0 },
        { "daysOfWeek", new[]
        {
            "string",
        } },
        { "hourOfDay", 0 },
        { "weeksOfMonth", new[]
        {
            "string",
        } },
    },
    Scope = "string",
    Status = "string",
    ViewId = "string",
    FileDestination = 
    {
        { "fileFormats", new[]
        {
            "string",
        } },
    },
    Kind = "string",
    Name = "string",
});

    example, err := costmanagement.NewScheduledActionByScope(ctx, "scheduledActionByScopeResource", &costmanagement.ScheduledActionByScopeArgs{
	DisplayName: "string",
	Notification: map[string]interface{}{
		"subject": "string",
		"to": []string{
			"string",
		},
		"message": "string",
	},
	Schedule: map[string]interface{}{
		"endDate":    "string",
		"frequency":  "string",
		"startDate":  "string",
		"dayOfMonth": 0,
		"daysOfWeek": []string{
			"string",
		},
		"hourOfDay": 0,
		"weeksOfMonth": []string{
			"string",
		},
	},
	Scope:  "string",
	Status: "string",
	ViewId: "string",
	FileDestination: map[string]interface{}{
		"fileFormats": []string{
			"string",
		},
	},
	Kind: "string",
	Name: "string",
})

    var scheduledActionByScopeResource = new ScheduledActionByScope("scheduledActionByScopeResource", ScheduledActionByScopeArgs.builder()
    .displayName("string")
    .notification(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .schedule(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .scope("string")
    .status("string")
    .viewId("string")
    .fileDestination(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .kind("string")
    .name("string")
    .build());

    scheduled_action_by_scope_resource = azure_native.costmanagement.ScheduledActionByScope("scheduledActionByScopeResource",
    display_name=string,
    notification={
        subject: string,
        to: [string],
        message: string,
    },
    schedule={
        endDate: string,
        frequency: string,
        startDate: string,
        dayOfMonth: 0,
        daysOfWeek: [string],
        hourOfDay: 0,
        weeksOfMonth: [string],
    },
    scope=string,
    status=string,
    view_id=string,
    file_destination={
        fileFormats: [string],
    },
    kind=string,
    name=string)

    const scheduledActionByScopeResource = new azure_native.costmanagement.ScheduledActionByScope("scheduledActionByScopeResource", {
    displayName: "string",
    notification: {
        subject: "string",
        to: ["string"],
        message: "string",
    },
    schedule: {
        endDate: "string",
        frequency: "string",
        startDate: "string",
        dayOfMonth: 0,
        daysOfWeek: ["string"],
        hourOfDay: 0,
        weeksOfMonth: ["string"],
    },
    scope: "string",
    status: "string",
    viewId: "string",
    fileDestination: {
        fileFormats: ["string"],
    },
    kind: "string",
    name: "string",
});

    type: azure-native:costmanagement:ScheduledActionByScope
properties:
    displayName: string
    fileDestination:
        fileFormats:
            - string
    kind: string
    name: string
    notification:
        message: string
        subject: string
        to:
            - string
    schedule:
        dayOfMonth: 0
        daysOfWeek:
            - string
        endDate: string
        frequency: string
        hourOfDay: 0
        startDate: string
        weeksOfMonth:
            - string
    scope: string
    status: string
    viewId: string

    ScheduledActionByScope 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 ScheduledActionByScope resource accepts the following input properties:

    DisplayName string
    Scheduled action name.
    Notification Pulumi.AzureNative.CostManagement.Inputs.NotificationProperties
    Notification properties based on scheduled action kind.
    Schedule Pulumi.AzureNative.CostManagement.Inputs.ScheduleProperties
    Schedule of the scheduled action.
    Scope string
    Cost Management scope like 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '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, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
    Status string | Pulumi.AzureNative.CostManagement.ScheduledActionStatus
    Status of the scheduled action.
    ViewId string
    Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'
    FileDestination Pulumi.AzureNative.CostManagement.Inputs.FileDestination
    Destination format of the view data.
    Kind string | Pulumi.AzureNative.CostManagement.ScheduledActionKind
    Kind of the scheduled action.
    Name string
    Scheduled action name.
    DisplayName string
    Scheduled action name.
    Notification NotificationPropertiesArgs
    Notification properties based on scheduled action kind.
    Schedule SchedulePropertiesArgs
    Schedule of the scheduled action.
    Scope string
    Cost Management scope like 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '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, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
    Status string | ScheduledActionStatus
    Status of the scheduled action.
    ViewId string
    Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'
    FileDestination FileDestinationArgs
    Destination format of the view data.
    Kind string | ScheduledActionKind
    Kind of the scheduled action.
    Name string
    Scheduled action name.
    displayName String
    Scheduled action name.
    notification NotificationProperties
    Notification properties based on scheduled action kind.
    schedule ScheduleProperties
    Schedule of the scheduled action.
    scope String
    Cost Management scope like 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '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, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
    status String | ScheduledActionStatus
    Status of the scheduled action.
    viewId String
    Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'
    fileDestination FileDestination
    Destination format of the view data.
    kind String | ScheduledActionKind
    Kind of the scheduled action.
    name String
    Scheduled action name.
    displayName string
    Scheduled action name.
    notification NotificationProperties
    Notification properties based on scheduled action kind.
    schedule ScheduleProperties
    Schedule of the scheduled action.
    scope string
    Cost Management scope like 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '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, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
    status string | ScheduledActionStatus
    Status of the scheduled action.
    viewId string
    Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'
    fileDestination FileDestination
    Destination format of the view data.
    kind string | ScheduledActionKind
    Kind of the scheduled action.
    name string
    Scheduled action name.
    display_name str
    Scheduled action name.
    notification NotificationPropertiesArgs
    Notification properties based on scheduled action kind.
    schedule SchedulePropertiesArgs
    Schedule of the scheduled action.
    scope str
    Cost Management scope like 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '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, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
    status str | ScheduledActionStatus
    Status of the scheduled action.
    view_id str
    Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'
    file_destination FileDestinationArgs
    Destination format of the view data.
    kind str | ScheduledActionKind
    Kind of the scheduled action.
    name str
    Scheduled action name.
    displayName String
    Scheduled action name.
    notification Property Map
    Notification properties based on scheduled action kind.
    schedule Property Map
    Schedule of the scheduled action.
    scope String
    Cost Management scope like 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '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, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
    status String | "Disabled" | "Enabled"
    Status of the scheduled action.
    viewId String
    Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'
    fileDestination Property Map
    Destination format of the view data.
    kind String | "Email"
    Kind of the scheduled action.
    name String
    Scheduled action name.

    Outputs

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

    ETag string
    Resource Etag.
    Id string
    The provider-assigned unique ID for this managed resource.
    SystemData Pulumi.AzureNative.CostManagement.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    Resource type.
    ETag string
    Resource Etag.
    Id string
    The provider-assigned unique ID for this managed resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    Resource type.
    eTag String
    Resource Etag.
    id String
    The provider-assigned unique ID for this managed resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    Resource type.
    eTag string
    Resource Etag.
    id string
    The provider-assigned unique ID for this managed resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    Resource type.
    e_tag str
    Resource Etag.
    id str
    The provider-assigned unique ID for this managed resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    Resource type.
    eTag String
    Resource Etag.
    id String
    The provider-assigned unique ID for this managed resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    Resource type.

    Supporting Types

    DaysOfWeek, DaysOfWeekArgs

    Monday
    Monday
    Tuesday
    Tuesday
    Wednesday
    Wednesday
    Thursday
    Thursday
    Friday
    Friday
    Saturday
    Saturday
    Sunday
    Sunday
    DaysOfWeekMonday
    Monday
    DaysOfWeekTuesday
    Tuesday
    DaysOfWeekWednesday
    Wednesday
    DaysOfWeekThursday
    Thursday
    DaysOfWeekFriday
    Friday
    DaysOfWeekSaturday
    Saturday
    DaysOfWeekSunday
    Sunday
    Monday
    Monday
    Tuesday
    Tuesday
    Wednesday
    Wednesday
    Thursday
    Thursday
    Friday
    Friday
    Saturday
    Saturday
    Sunday
    Sunday
    Monday
    Monday
    Tuesday
    Tuesday
    Wednesday
    Wednesday
    Thursday
    Thursday
    Friday
    Friday
    Saturday
    Saturday
    Sunday
    Sunday
    MONDAY
    Monday
    TUESDAY
    Tuesday
    WEDNESDAY
    Wednesday
    THURSDAY
    Thursday
    FRIDAY
    Friday
    SATURDAY
    Saturday
    SUNDAY
    Sunday
    "Monday"
    Monday
    "Tuesday"
    Tuesday
    "Wednesday"
    Wednesday
    "Thursday"
    Thursday
    "Friday"
    Friday
    "Saturday"
    Saturday
    "Sunday"
    Sunday

    FileDestination, FileDestinationArgs

    FileFormats List<Union<string, Pulumi.AzureNative.CostManagement.FileFormat>>
    Destination of the view data. Currently only csv format is supported.
    FileFormats []string
    Destination of the view data. Currently only csv format is supported.
    fileFormats List<Either<String,FileFormat>>
    Destination of the view data. Currently only csv format is supported.
    fileFormats (string | FileFormat)[]
    Destination of the view data. Currently only csv format is supported.
    file_formats Sequence[Union[str, FileFormat]]
    Destination of the view data. Currently only csv format is supported.
    fileFormats List<String | "Csv">
    Destination of the view data. Currently only csv format is supported.

    FileDestinationResponse, FileDestinationResponseArgs

    FileFormats List<string>
    Destination of the view data. Currently only csv format is supported.
    FileFormats []string
    Destination of the view data. Currently only csv format is supported.
    fileFormats List<String>
    Destination of the view data. Currently only csv format is supported.
    fileFormats string[]
    Destination of the view data. Currently only csv format is supported.
    file_formats Sequence[str]
    Destination of the view data. Currently only csv format is supported.
    fileFormats List<String>
    Destination of the view data. Currently only csv format is supported.

    FileFormat, FileFormatArgs

    Csv
    Csv
    FileFormatCsv
    Csv
    Csv
    Csv
    Csv
    Csv
    CSV
    Csv
    "Csv"
    Csv

    NotificationProperties, NotificationPropertiesArgs

    Subject string
    Subject of the email. Length is limited to 70 characters.
    To List<string>
    Array of email addresses.
    Message string
    Optional message to be added in the email. Length is limited to 250 characters.
    Subject string
    Subject of the email. Length is limited to 70 characters.
    To []string
    Array of email addresses.
    Message string
    Optional message to be added in the email. Length is limited to 250 characters.
    subject String
    Subject of the email. Length is limited to 70 characters.
    to List<String>
    Array of email addresses.
    message String
    Optional message to be added in the email. Length is limited to 250 characters.
    subject string
    Subject of the email. Length is limited to 70 characters.
    to string[]
    Array of email addresses.
    message string
    Optional message to be added in the email. Length is limited to 250 characters.
    subject str
    Subject of the email. Length is limited to 70 characters.
    to Sequence[str]
    Array of email addresses.
    message str
    Optional message to be added in the email. Length is limited to 250 characters.
    subject String
    Subject of the email. Length is limited to 70 characters.
    to List<String>
    Array of email addresses.
    message String
    Optional message to be added in the email. Length is limited to 250 characters.

    NotificationPropertiesResponse, NotificationPropertiesResponseArgs

    Subject string
    Subject of the email. Length is limited to 70 characters.
    To List<string>
    Array of email addresses.
    Message string
    Optional message to be added in the email. Length is limited to 250 characters.
    Subject string
    Subject of the email. Length is limited to 70 characters.
    To []string
    Array of email addresses.
    Message string
    Optional message to be added in the email. Length is limited to 250 characters.
    subject String
    Subject of the email. Length is limited to 70 characters.
    to List<String>
    Array of email addresses.
    message String
    Optional message to be added in the email. Length is limited to 250 characters.
    subject string
    Subject of the email. Length is limited to 70 characters.
    to string[]
    Array of email addresses.
    message string
    Optional message to be added in the email. Length is limited to 250 characters.
    subject str
    Subject of the email. Length is limited to 70 characters.
    to Sequence[str]
    Array of email addresses.
    message str
    Optional message to be added in the email. Length is limited to 250 characters.
    subject String
    Subject of the email. Length is limited to 70 characters.
    to List<String>
    Array of email addresses.
    message String
    Optional message to be added in the email. Length is limited to 250 characters.

    ScheduleFrequency, ScheduleFrequencyArgs

    Daily
    DailyCost analysis data will be emailed every day.
    Weekly
    WeeklyCost analysis data will be emailed every week.
    Monthly
    MonthlyCost analysis data will be emailed every month.
    ScheduleFrequencyDaily
    DailyCost analysis data will be emailed every day.
    ScheduleFrequencyWeekly
    WeeklyCost analysis data will be emailed every week.
    ScheduleFrequencyMonthly
    MonthlyCost analysis data will be emailed every month.
    Daily
    DailyCost analysis data will be emailed every day.
    Weekly
    WeeklyCost analysis data will be emailed every week.
    Monthly
    MonthlyCost analysis data will be emailed every month.
    Daily
    DailyCost analysis data will be emailed every day.
    Weekly
    WeeklyCost analysis data will be emailed every week.
    Monthly
    MonthlyCost analysis data will be emailed every month.
    DAILY
    DailyCost analysis data will be emailed every day.
    WEEKLY
    WeeklyCost analysis data will be emailed every week.
    MONTHLY
    MonthlyCost analysis data will be emailed every month.
    "Daily"
    DailyCost analysis data will be emailed every day.
    "Weekly"
    WeeklyCost analysis data will be emailed every week.
    "Monthly"
    MonthlyCost analysis data will be emailed every month.

    ScheduleProperties, SchedulePropertiesArgs

    EndDate string
    The end date and time of the scheduled action (UTC).
    Frequency string | Pulumi.AzureNative.CostManagement.ScheduleFrequency
    Frequency of the schedule.
    StartDate string
    The start date and time of the scheduled action (UTC).
    DayOfMonth int
    UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
    DaysOfWeek List<Union<string, Pulumi.AzureNative.CostManagement.DaysOfWeek>>
    Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.
    HourOfDay int
    UTC time at which cost analysis data will be emailed.
    WeeksOfMonth List<Union<string, Pulumi.AzureNative.CostManagement.WeeksOfMonth>>
    Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.
    EndDate string
    The end date and time of the scheduled action (UTC).
    Frequency string | ScheduleFrequency
    Frequency of the schedule.
    StartDate string
    The start date and time of the scheduled action (UTC).
    DayOfMonth int
    UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
    DaysOfWeek []string
    Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.
    HourOfDay int
    UTC time at which cost analysis data will be emailed.
    WeeksOfMonth []string
    Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.
    endDate String
    The end date and time of the scheduled action (UTC).
    frequency String | ScheduleFrequency
    Frequency of the schedule.
    startDate String
    The start date and time of the scheduled action (UTC).
    dayOfMonth Integer
    UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
    daysOfWeek List<Either<String,DaysOfWeek>>
    Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.
    hourOfDay Integer
    UTC time at which cost analysis data will be emailed.
    weeksOfMonth List<Either<String,WeeksOfMonth>>
    Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.
    endDate string
    The end date and time of the scheduled action (UTC).
    frequency string | ScheduleFrequency
    Frequency of the schedule.
    startDate string
    The start date and time of the scheduled action (UTC).
    dayOfMonth number
    UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
    daysOfWeek (string | DaysOfWeek)[]
    Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.
    hourOfDay number
    UTC time at which cost analysis data will be emailed.
    weeksOfMonth (string | WeeksOfMonth)[]
    Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.
    end_date str
    The end date and time of the scheduled action (UTC).
    frequency str | ScheduleFrequency
    Frequency of the schedule.
    start_date str
    The start date and time of the scheduled action (UTC).
    day_of_month int
    UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
    days_of_week Sequence[Union[str, DaysOfWeek]]
    Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.
    hour_of_day int
    UTC time at which cost analysis data will be emailed.
    weeks_of_month Sequence[Union[str, WeeksOfMonth]]
    Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.
    endDate String
    The end date and time of the scheduled action (UTC).
    frequency String | "Daily" | "Weekly" | "Monthly"
    Frequency of the schedule.
    startDate String
    The start date and time of the scheduled action (UTC).
    dayOfMonth Number
    UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
    daysOfWeek List<String | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday">
    Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.
    hourOfDay Number
    UTC time at which cost analysis data will be emailed.
    weeksOfMonth List<String | "First" | "Second" | "Third" | "Fourth" | "Last">
    Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.

    SchedulePropertiesResponse, SchedulePropertiesResponseArgs

    EndDate string
    The end date and time of the scheduled action (UTC).
    Frequency string
    Frequency of the schedule.
    StartDate string
    The start date and time of the scheduled action (UTC).
    DayOfMonth int
    UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
    DaysOfWeek List<string>
    Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.
    HourOfDay int
    UTC time at which cost analysis data will be emailed.
    WeeksOfMonth List<string>
    Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.
    EndDate string
    The end date and time of the scheduled action (UTC).
    Frequency string
    Frequency of the schedule.
    StartDate string
    The start date and time of the scheduled action (UTC).
    DayOfMonth int
    UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
    DaysOfWeek []string
    Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.
    HourOfDay int
    UTC time at which cost analysis data will be emailed.
    WeeksOfMonth []string
    Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.
    endDate String
    The end date and time of the scheduled action (UTC).
    frequency String
    Frequency of the schedule.
    startDate String
    The start date and time of the scheduled action (UTC).
    dayOfMonth Integer
    UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
    daysOfWeek List<String>
    Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.
    hourOfDay Integer
    UTC time at which cost analysis data will be emailed.
    weeksOfMonth List<String>
    Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.
    endDate string
    The end date and time of the scheduled action (UTC).
    frequency string
    Frequency of the schedule.
    startDate string
    The start date and time of the scheduled action (UTC).
    dayOfMonth number
    UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
    daysOfWeek string[]
    Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.
    hourOfDay number
    UTC time at which cost analysis data will be emailed.
    weeksOfMonth string[]
    Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.
    end_date str
    The end date and time of the scheduled action (UTC).
    frequency str
    Frequency of the schedule.
    start_date str
    The start date and time of the scheduled action (UTC).
    day_of_month int
    UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
    days_of_week Sequence[str]
    Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.
    hour_of_day int
    UTC time at which cost analysis data will be emailed.
    weeks_of_month Sequence[str]
    Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.
    endDate String
    The end date and time of the scheduled action (UTC).
    frequency String
    Frequency of the schedule.
    startDate String
    The start date and time of the scheduled action (UTC).
    dayOfMonth Number
    UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
    daysOfWeek List<String>
    Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.
    hourOfDay Number
    UTC time at which cost analysis data will be emailed.
    weeksOfMonth List<String>
    Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.

    ScheduledActionKind, ScheduledActionKindArgs

    Email
    EmailCost analysis data will be emailed.
    ScheduledActionKindEmail
    EmailCost analysis data will be emailed.
    Email
    EmailCost analysis data will be emailed.
    Email
    EmailCost analysis data will be emailed.
    EMAIL
    EmailCost analysis data will be emailed.
    "Email"
    EmailCost analysis data will be emailed.

    ScheduledActionStatus, ScheduledActionStatusArgs

    Disabled
    DisabledScheduled action is saved but will not be executed.
    Enabled
    EnabledScheduled action is saved and will be executed.
    ScheduledActionStatusDisabled
    DisabledScheduled action is saved but will not be executed.
    ScheduledActionStatusEnabled
    EnabledScheduled action is saved and will be executed.
    Disabled
    DisabledScheduled action is saved but will not be executed.
    Enabled
    EnabledScheduled action is saved and will be executed.
    Disabled
    DisabledScheduled action is saved but will not be executed.
    Enabled
    EnabledScheduled action is saved and will be executed.
    DISABLED
    DisabledScheduled action is saved but will not be executed.
    ENABLED
    EnabledScheduled action is saved and will be executed.
    "Disabled"
    DisabledScheduled action is saved but will not be executed.
    "Enabled"
    EnabledScheduled action is saved and will be executed.

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    WeeksOfMonth, WeeksOfMonthArgs

    First
    First
    Second
    Second
    Third
    Third
    Fourth
    Fourth
    Last
    Last
    WeeksOfMonthFirst
    First
    WeeksOfMonthSecond
    Second
    WeeksOfMonthThird
    Third
    WeeksOfMonthFourth
    Fourth
    WeeksOfMonthLast
    Last
    First
    First
    Second
    Second
    Third
    Third
    Fourth
    Fourth
    Last
    Last
    First
    First
    Second
    Second
    Third
    Third
    Fourth
    Fourth
    Last
    Last
    FIRST
    First
    SECOND
    Second
    THIRD
    Third
    FOURTH
    Fourth
    LAST
    Last
    "First"
    First
    "Second"
    Second
    "Third"
    Third
    "Fourth"
    Fourth
    "Last"
    Last

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:costmanagement:ScheduledActionByScope monthlyCostByResource subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource

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

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native