ScheduledActions interface
Interface representing a ScheduledActions.
Methods
Method Details
checkNameAvailability(CheckNameAvailabilityRequest, ScheduledActionsCheckNameAvailabilityOptionalParams)
Checks availability and correctness of the name for a scheduled action.
function checkNameAvailability(checkNameAvailabilityRequest: CheckNameAvailabilityRequest, options?: ScheduledActionsCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResponse>Parameters
- checkNameAvailabilityRequest
- CheckNameAvailabilityRequest
Scheduled action to be created or updated.
The options parameters.
Returns
Promise<CheckNameAvailabilityResponse>
checkNameAvailabilityByScope(string, CheckNameAvailabilityRequest, ScheduledActionsCheckNameAvailabilityByScopeOptionalParams)
Checks availability and correctness of the name for a scheduled action within the given scope.
function checkNameAvailabilityByScope(scope: string, checkNameAvailabilityRequest: CheckNameAvailabilityRequest, options?: ScheduledActionsCheckNameAvailabilityByScopeOptionalParams): Promise<CheckNameAvailabilityResponse>Parameters
- scope
-
string
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.
- checkNameAvailabilityRequest
- CheckNameAvailabilityRequest
Scheduled action to be created or updated.
The options parameters.
Returns
Promise<CheckNameAvailabilityResponse>
createOrUpdate(string, ScheduledAction, ScheduledActionsCreateOrUpdateOptionalParams)
Create or update a private scheduled action.
function createOrUpdate(name: string, scheduledAction: ScheduledAction, options?: ScheduledActionsCreateOrUpdateOptionalParams): Promise<ScheduledAction>Parameters
- name
-
string
Scheduled action name.
- scheduledAction
- ScheduledAction
Scheduled action to be created or updated.
The options parameters.
Returns
Promise<ScheduledAction>
createOrUpdateByScope(string, string, ScheduledAction, ScheduledActionsCreateOrUpdateByScopeOptionalParams)
Create or update a shared scheduled action within the given scope.
function createOrUpdateByScope(scope: string, name: string, scheduledAction: ScheduledAction, options?: ScheduledActionsCreateOrUpdateByScopeOptionalParams): Promise<ScheduledAction>Parameters
- scope
-
string
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.
- name
-
string
Scheduled action name.
- scheduledAction
- ScheduledAction
Scheduled action to be created or updated.
The options parameters.
Returns
Promise<ScheduledAction>
delete(string, ScheduledActionsDeleteOptionalParams)
Delete a private scheduled action.
function delete(name: string, options?: ScheduledActionsDeleteOptionalParams): Promise<void>Parameters
- name
-
string
Scheduled action name.
The options parameters.
Returns
Promise<void>
deleteByScope(string, string, ScheduledActionsDeleteByScopeOptionalParams)
Delete a scheduled action within the given scope.
function deleteByScope(scope: string, name: string, options?: ScheduledActionsDeleteByScopeOptionalParams): Promise<void>Parameters
- scope
-
string
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.
- name
-
string
Scheduled action name.
The options parameters.
Returns
Promise<void>
get(string, ScheduledActionsGetOptionalParams)
Get the private scheduled action by name.
function get(name: string, options?: ScheduledActionsGetOptionalParams): Promise<ScheduledAction>Parameters
- name
-
string
Scheduled action name.
The options parameters.
Returns
Promise<ScheduledAction>
getByScope(string, string, ScheduledActionsGetByScopeOptionalParams)
Get the shared scheduled action from the given scope by name.
function getByScope(scope: string, name: string, options?: ScheduledActionsGetByScopeOptionalParams): Promise<ScheduledAction>Parameters
- scope
-
string
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.
- name
-
string
Scheduled action name.
The options parameters.
Returns
Promise<ScheduledAction>
list(ScheduledActionsListOptionalParams)
List all private scheduled actions.
function list(options?: ScheduledActionsListOptionalParams): PagedAsyncIterableIterator<ScheduledAction, ScheduledAction[], PageSettings>Parameters
The options parameters.
Returns
listByScope(string, ScheduledActionsListByScopeOptionalParams)
List all shared scheduled actions within the given scope.
function listByScope(scope: string, options?: ScheduledActionsListByScopeOptionalParams): PagedAsyncIterableIterator<ScheduledAction, ScheduledAction[], PageSettings>Parameters
- scope
-
string
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.
The options parameters.
Returns
run(string, ScheduledActionsRunOptionalParams)
Processes a private scheduled action.
function run(name: string, options?: ScheduledActionsRunOptionalParams): Promise<void>Parameters
- name
-
string
Scheduled action name.
The options parameters.
Returns
Promise<void>
runByScope(string, string, ScheduledActionsRunByScopeOptionalParams)
Runs a shared scheduled action within the given scope.
function runByScope(scope: string, name: string, options?: ScheduledActionsRunByScopeOptionalParams): Promise<void>Parameters
- scope
-
string
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.
- name
-
string
Scheduled action name.
The options parameters.
Returns
Promise<void>
Azure SDK for JavaScript