Microsoft.CostManagement scheduledActions 2022-10-01

• Latest
• 2024-08-01
• 2023-11-01
• 2023-09-01
• 2023-08-01
• 2023-07-01-preview
• 2023-04-01-preview
• 2023-03-01
• 2022-10-01
• 2022-06-01-preview
• 2022-04-01-preview

Bicep resource definition

The scheduledActions resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.CostManagement/scheduledActions resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.CostManagement/scheduledActions@2022-10-01' = {
  scope: resourceSymbolicName or scope
  kind: 'string'
  name: 'string'
  properties: {
    displayName: 'string'
    fileDestination: {
      fileFormats: [
        'string'
      ]
    }
    notification: {
      language: 'string'
      message: 'string'
      regionalFormat: 'string'
      subject: 'string'
      to: [
        'string'
      ]
    }
    notificationEmail: 'string'
    schedule: {
      dayOfMonth: int
      daysOfWeek: [
        'string'
      ]
      endDate: 'string'
      frequency: 'string'
      hourOfDay: int
      startDate: 'string'
      weeksOfMonth: [
        'string'
      ]
    }
    scope: 'string'
    status: 'string'
    viewId: 'string'
  }
}

Property Values

FileDestination

Name	Description	Value
fileFormats	Destination of the view data. Currently only CSV format is supported.	String array containing any of: 'Csv'

Microsoft.CostManagement/scheduledActions

Name	Description	Value
kind	Kind of the scheduled action.	'Email' 'InsightAlert'
name	The resource name	string (required)
properties	The properties of the scheduled action.	ScheduledActionProperties
scope	Use when creating a resource at a scope that is different than the deployment scope.	Set this property to the symbolic name of a resource to apply the extension resource.

NotificationProperties

Name	Description	Value
language	Locale of the email.	string
message	Optional message to be added in the email. Length is limited to 250 characters.	string
regionalFormat	Regional format used for formatting date/time and currency values in the email.	string
subject	Subject of the email. Length is limited to 70 characters.	string (required)
to	Array of email addresses.	string Constraints: Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$[] (required)

ScheduledActionProperties

Name	Description	Value
displayName	Scheduled action name.	string (required)
fileDestination	Destination format of the view data. This is optional.	FileDestination
notification	Notification properties based on scheduled action kind.	NotificationProperties (required)
notificationEmail	Email address of the point of contact that should get the unsubscribe requests and notification emails.	string
schedule	Schedule of the scheduled action.	ScheduleProperties (required)
scope	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.	string
status	Status of the scheduled action.	'Disabled' 'Enabled' 'Expired' (required)
viewId	Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'	string (required)

ScheduleProperties

Name	Description	Value
dayOfMonth	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.	int
daysOfWeek	Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.	String array containing any of: 'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday'
endDate	The end date and time of the scheduled action (UTC).	string (required)
frequency	Frequency of the schedule.	'Daily' 'Monthly' 'Weekly' (required)
hourOfDay	UTC time at which cost analysis data will be emailed.	int
startDate	The start date and time of the scheduled action (UTC).	string (required)
weeksOfMonth	Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.	String array containing any of: 'First' 'Fourth' 'Last' 'Second' 'Third'

ARM template resource definition

The scheduledActions resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.CostManagement/scheduledActions resource, add the following JSON to your template.

{
  "type": "Microsoft.CostManagement/scheduledActions",
  "apiVersion": "2022-10-01",
  "name": "string",
  "kind": "string",
  "properties": {
    "displayName": "string",
    "fileDestination": {
      "fileFormats": [ "string" ]
    },
    "notification": {
      "language": "string",
      "message": "string",
      "regionalFormat": "string",
      "subject": "string",
      "to": [ "string" ]
    },
    "notificationEmail": "string",
    "schedule": {
      "dayOfMonth": "int",
      "daysOfWeek": [ "string" ],
      "endDate": "string",
      "frequency": "string",
      "hourOfDay": "int",
      "startDate": "string",
      "weeksOfMonth": [ "string" ]
    },
    "scope": "string",
    "status": "string",
    "viewId": "string"
  }
}

Property Values

FileDestination

Name	Description	Value
fileFormats	Destination of the view data. Currently only CSV format is supported.	String array containing any of: 'Csv'

Microsoft.CostManagement/scheduledActions

Name	Description	Value
apiVersion	The api version	'2022-10-01'
kind	Kind of the scheduled action.	'Email' 'InsightAlert'
name	The resource name	string (required)
properties	The properties of the scheduled action.	ScheduledActionProperties
type	The resource type	'Microsoft.CostManagement/scheduledActions'

NotificationProperties

Name	Description	Value
language	Locale of the email.	string
message	Optional message to be added in the email. Length is limited to 250 characters.	string
regionalFormat	Regional format used for formatting date/time and currency values in the email.	string
subject	Subject of the email. Length is limited to 70 characters.	string (required)
to	Array of email addresses.	string Constraints: Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$[] (required)

ScheduledActionProperties

Name	Description	Value
displayName	Scheduled action name.	string (required)
fileDestination	Destination format of the view data. This is optional.	FileDestination
notification	Notification properties based on scheduled action kind.	NotificationProperties (required)
notificationEmail	Email address of the point of contact that should get the unsubscribe requests and notification emails.	string
schedule	Schedule of the scheduled action.	ScheduleProperties (required)
scope	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.	string
status	Status of the scheduled action.	'Disabled' 'Enabled' 'Expired' (required)
viewId	Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'	string (required)

ScheduleProperties

Name	Description	Value
dayOfMonth	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.	int
daysOfWeek	Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.	String array containing any of: 'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday'
endDate	The end date and time of the scheduled action (UTC).	string (required)
frequency	Frequency of the schedule.	'Daily' 'Monthly' 'Weekly' (required)
hourOfDay	UTC time at which cost analysis data will be emailed.	int
startDate	The start date and time of the scheduled action (UTC).	string (required)
weeksOfMonth	Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.	String array containing any of: 'First' 'Fourth' 'Last' 'Second' 'Third'

Usage Examples

Terraform (AzAPI provider) resource definition

The scheduledActions resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.CostManagement/scheduledActions resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.CostManagement/scheduledActions@2022-10-01"
  name = "string"
  parent_id = "string"
  kind = "string"
  body = jsonencode({
    properties = {
      displayName = "string"
      fileDestination = {
        fileFormats = [
          "string"
        ]
      }
      notification = {
        language = "string"
        message = "string"
        regionalFormat = "string"
        subject = "string"
        to = [
          "string"
        ]
      }
      notificationEmail = "string"
      schedule = {
        dayOfMonth = int
        daysOfWeek = [
          "string"
        ]
        endDate = "string"
        frequency = "string"
        hourOfDay = int
        startDate = "string"
        weeksOfMonth = [
          "string"
        ]
      }
      scope = "string"
      status = "string"
      viewId = "string"
    }
  })
}

Property Values

FileDestination

Name	Description	Value
fileFormats	Destination of the view data. Currently only CSV format is supported.	String array containing any of: 'Csv'

Microsoft.CostManagement/scheduledActions

Name	Description	Value
kind	Kind of the scheduled action.	'Email' 'InsightAlert'
name	The resource name	string (required)
parent_id	The ID of the resource to apply this extension resource to.	string (required)
properties	The properties of the scheduled action.	ScheduledActionProperties
type	The resource type	"Microsoft.CostManagement/scheduledActions@2022-10-01"

NotificationProperties

Name	Description	Value
language	Locale of the email.	string
message	Optional message to be added in the email. Length is limited to 250 characters.	string
regionalFormat	Regional format used for formatting date/time and currency values in the email.	string
subject	Subject of the email. Length is limited to 70 characters.	string (required)
to	Array of email addresses.	string Constraints: Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$[] (required)

ScheduledActionProperties

Name	Description	Value
displayName	Scheduled action name.	string (required)
fileDestination	Destination format of the view data. This is optional.	FileDestination
notification	Notification properties based on scheduled action kind.	NotificationProperties (required)
notificationEmail	Email address of the point of contact that should get the unsubscribe requests and notification emails.	string
schedule	Schedule of the scheduled action.	ScheduleProperties (required)
scope	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.	string
status	Status of the scheduled action.	'Disabled' 'Enabled' 'Expired' (required)
viewId	Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'	string (required)

ScheduleProperties

Name	Description	Value
dayOfMonth	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.	int
daysOfWeek	Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.	String array containing any of: 'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday'
endDate	The end date and time of the scheduled action (UTC).	string (required)
frequency	Frequency of the schedule.	'Daily' 'Monthly' 'Weekly' (required)
hourOfDay	UTC time at which cost analysis data will be emailed.	int
startDate	The start date and time of the scheduled action (UTC).	string (required)
weeksOfMonth	Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.	String array containing any of: 'First' 'Fourth' 'Last' 'Second' 'Third'