Microsoft.CostManagement (preview:2022-06-01)

2025/10/30 • 12 new, 12 deleted methods

ScheduledActions_List (new)
Description :  List all private scheduled actions.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/scheduledActions
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter scheduled actions by properties/viewId. Supported operator is 'eq'. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of scheduled actions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only csv format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be executed. ,
Disabled: Scheduled action is saved but will not be executed. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_ListByScope (new)
Description :  List all shared scheduled actions within the given scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/scheduledActions
{
scope:
{
Description: The scope associated with scheduled action operations. This includes '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 External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter scheduled actions by properties/viewId. Supported operator is 'eq'. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of scheduled actions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only csv format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be executed. ,
Disabled: Scheduled action is saved but will not be executed. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_CreateOrUpdate (new)
Description :  Create or update a private scheduled action.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.CostManagement/scheduledActions/{name}
{
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
scheduledAction:
{
Description: Scheduled action to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only csv format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be executed. ,
Disabled: Scheduled action is saved but will not be executed. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only csv format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be executed. ,
Disabled: Scheduled action is saved but will not be executed. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only csv format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be executed. ,
Disabled: Scheduled action is saved but will not be executed. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_Get (new)
Description :  Get the private scheduled action by name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/scheduledActions/{name}
{
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only csv format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be executed. ,
Disabled: Scheduled action is saved but will not be executed. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_Delete (new)
Description :  Delete a private scheduled action.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.CostManagement/scheduledActions/{name}
{
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_CreateOrUpdateByScope (new)
Description :  Create or update a shared scheduled action within the given scope.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}
{
scope:
{
Description: The scope associated with scheduled action operations. This includes '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 External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope. ,
Required: True ,
}
string ,
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
scheduledAction:
{
Description: Scheduled action to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only csv format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be executed. ,
Disabled: Scheduled action is saved but will not be executed. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only csv format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be executed. ,
Disabled: Scheduled action is saved but will not be executed. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only csv format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be executed. ,
Disabled: Scheduled action is saved but will not be executed. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_GetByScope (new)
Description :  Get the shared scheduled action from the given scope by name.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}
{
scope:
{
Description: The scope associated with scheduled action operations. This includes '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 External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope. ,
Required: True ,
}
string ,
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only csv format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be executed. ,
Disabled: Scheduled action is saved but will not be executed. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_DeleteByScope (new)
Description :  Delete a scheduled action within the given scope.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}
{
scope:
{
Description: The scope associated with scheduled action operations. This includes '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 External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope. ,
Required: True ,
}
string ,
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_Execute (new)
Description :  Execute a private scheduled action.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.CostManagement/scheduledActions/{name}/execute
{
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_ExecuteByScope (new)
Description :  Execute a shared scheduled action within the given scope.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}/execute
{
scope:
{
Description: The scope associated with scheduled action operations. This includes '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 External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope. ,
Required: True ,
}
string ,
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_CheckNameAvailability (new)
Description :  Checks availability and correctness of the name for a scheduled action.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.CostManagement/checkNameAvailability
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
checkNameAvailabilityRequest:
{
Description: Scheduled action to be created or updated. ,
Required: True ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates if the resource name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the given name is not available. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Detailed reason why the given name is available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_CheckNameAvailabilityByScope (new)
Description :  Checks availability and correctness of the name for a scheduled action within the given scope.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.CostManagement/checkNameAvailability
{
scope:
{
Description: The scope associated with scheduled action operations. This includes '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 External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
checkNameAvailabilityRequest:
{
Description: Scheduled action to be created or updated. ,
Required: True ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates if the resource name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the given name is not available. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Detailed reason why the given name is available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_List (removed)
Description :  List all private scheduled actions.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/scheduledActions
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter scheduled actions by properties/viewId. Supported operator is 'eq'. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of scheduled actions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only csv format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be executed. ,
Disabled: Scheduled action is saved but will not be executed. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_ListByScope (removed)
Description :  List all shared scheduled actions within the given scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/scheduledActions
{
scope:
{
Description: The scope associated with scheduled action operations. This includes '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 External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter scheduled actions by properties/viewId. Supported operator is 'eq'. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of scheduled actions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only csv format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be executed. ,
Disabled: Scheduled action is saved but will not be executed. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_CreateOrUpdate (removed)
Description :  Create or update a private scheduled action.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.CostManagement/scheduledActions/{name}
{
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
scheduledAction:
{
Description: Scheduled action to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only csv format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be executed. ,
Disabled: Scheduled action is saved but will not be executed. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only csv format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be executed. ,
Disabled: Scheduled action is saved but will not be executed. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only csv format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be executed. ,
Disabled: Scheduled action is saved but will not be executed. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_Get (removed)
Description :  Get the private scheduled action by name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CostManagement/scheduledActions/{name}
{
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only csv format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be executed. ,
Disabled: Scheduled action is saved but will not be executed. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_Delete (removed)
Description :  Delete a private scheduled action.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.CostManagement/scheduledActions/{name}
{
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_CreateOrUpdateByScope (removed)
Description :  Create or update a shared scheduled action within the given scope.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}
{
scope:
{
Description: The scope associated with scheduled action operations. This includes '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 External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope. ,
Required: True ,
}
string ,
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
scheduledAction:
{
Description: Scheduled action to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only csv format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be executed. ,
Disabled: Scheduled action is saved but will not be executed. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only csv format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be executed. ,
Disabled: Scheduled action is saved but will not be executed. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only csv format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be executed. ,
Disabled: Scheduled action is saved but will not be executed. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_GetByScope (removed)
Description :  Get the shared scheduled action from the given scope by name.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}
{
scope:
{
Description: The scope associated with scheduled action operations. This includes '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 External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope. ,
Required: True ,
}
string ,
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scheduled action. ,
Required: False ,
}
{
displayName:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
fileDestination:
{
Description: Destination format of the view data. This is optional. ,
Required: False ,
}
{
fileFormats:
{
Description: Destination of the view data. Currently only csv format is supported. ,
Required: False ,
}
[
string ,
]
,
}
,
notification:
{
Description: Notification properties based on scheduled action kind. ,
Required: True ,
}
{
to:
{
Description: Array of email addresses. ,
Required: True ,
}
[
string ,
]
,
message:
{
Description: Optional message to be added in the email. Length is limited to 250 characters. ,
Required: False ,
}
string ,
subject:
{
Description: Subject of the email. Length is limited to 70 characters. ,
Required: True ,
}
string ,
}
,
schedule:
{
Description: Schedule of the scheduled action. ,
Required: True ,
}
{
frequency:
{
Description: Frequency of the schedule. ,
Enum:
{
Daily: Cost analysis data will be emailed every day. ,
Weekly: Cost analysis data will be emailed every week. ,
Monthly: Cost analysis data will be emailed every month. ,
}
,
Required: True ,
}
enum ,
hourOfDay:
{
Description: UTC time at which cost analysis data will be emailed. ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfWeek:
{
Description: Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. ,
Required: False ,
}
[
string ,
]
,
weeksOfMonth:
{
Description: Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. ,
Required: False ,
}
[
string ,
]
,
dayOfMonth:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
startDate:
{
Description: The start date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The end date and time of the scheduled action (UTC). ,
Format: date-time ,
Required: True ,
}
string ,
}
,
scope:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Status of the scheduled action. ,
Enum:
{
Enabled: Scheduled action is saved and will be executed. ,
Disabled: Scheduled action is saved but will not be executed. ,
}
,
Required: True ,
}
enum ,
viewId:
{
Description: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_DeleteByScope (removed)
Description :  Delete a scheduled action within the given scope.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}
{
scope:
{
Description: The scope associated with scheduled action operations. This includes '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 External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope. ,
Required: True ,
}
string ,
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_Execute (removed)
Description :  Execute a private scheduled action.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.CostManagement/scheduledActions/{name}/execute
{
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_ExecuteByScope (removed)
Description :  Execute a shared scheduled action within the given scope.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}/execute
{
scope:
{
Description: The scope associated with scheduled action operations. This includes '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 External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope. ,
Required: True ,
}
string ,
name:
{
Description: Scheduled action name. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_CheckNameAvailability (removed)
Description :  Checks availability and correctness of the name for a scheduled action.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.CostManagement/checkNameAvailability
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
checkNameAvailabilityRequest:
{
Description: Scheduled action to be created or updated. ,
Required: True ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates if the resource name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the given name is not available. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Detailed reason why the given name is available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScheduledActions_CheckNameAvailabilityByScope (removed)
Description :  Checks availability and correctness of the name for a scheduled action within the given scope.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.CostManagement/checkNameAvailability
{
scope:
{
Description: The scope associated with scheduled action operations. This includes '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 External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
checkNameAvailabilityRequest:
{
Description: Scheduled action to be created or updated. ,
Required: True ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates if the resource name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the given name is not available. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Detailed reason why the given name is available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}