ScheduledActionsOperations interface

Package:

@azure/arm-compute-bulkactions

Interface representing a ScheduledActions operations.

Properties

attachResources	Attach resources to the scheduled action so they are included in future occurrences.
cancelNextOccurrence	Cancel the next scheduled occurrence of the scheduled action.
createOrUpdate	Create a ScheduledAction
delete	Delete a ScheduledAction
detachResources	Detach resources from the scheduled action so they are excluded from future occurrences.
disable	Disable the scheduled action so its future occurrences do not run.
enable	Enable a previously disabled scheduled action so its future occurrences run.
get	Get a ScheduledAction
listByResourceGroup	List ScheduledAction resources by resource group
listBySubscription	List ScheduledAction resources by subscription ID
listResources	List resources attached to Scheduled Actions
patchResources	A synchronous resource action.
triggerManualOccurrence	Trigger a manual occurrence of the scheduled action immediately, outside its normal schedule.
update	Update a ScheduledAction

Property Details

attachResources

Attach resources to the scheduled action so they are included in future occurrences.

attachResources: (resourceGroupName: string, scheduledActionName: string, body: ResourceAttachRequest, options?: ScheduledActionsAttachResourcesOptionalParams) => PollerLike<OperationState<ResourceOperationResponse>, ResourceOperationResponse>

Property Value

(resourceGroupName: string, scheduledActionName: string, body: ResourceAttachRequest, options?: ScheduledActionsAttachResourcesOptionalParams) => PollerLike<OperationState<ResourceOperationResponse>, ResourceOperationResponse>

cancelNextOccurrence

Cancel the next scheduled occurrence of the scheduled action.

cancelNextOccurrence: (resourceGroupName: string, scheduledActionName: string, body: CancelOccurrenceRequest, options?: ScheduledActionsCancelNextOccurrenceOptionalParams) => PollerLike<OperationState<ResourceOperationResponse>, ResourceOperationResponse>

Property Value

(resourceGroupName: string, scheduledActionName: string, body: CancelOccurrenceRequest, options?: ScheduledActionsCancelNextOccurrenceOptionalParams) => PollerLike<OperationState<ResourceOperationResponse>, ResourceOperationResponse>

createOrUpdate

Create a ScheduledAction

createOrUpdate: (resourceGroupName: string, scheduledActionName: string, resource: ScheduledAction, options?: ScheduledActionsCreateOrUpdateOptionalParams) => PollerLike<OperationState<ScheduledAction>, ScheduledAction>

Property Value

(resourceGroupName: string, scheduledActionName: string, resource: ScheduledAction, options?: ScheduledActionsCreateOrUpdateOptionalParams) => PollerLike<OperationState<ScheduledAction>, ScheduledAction>

delete

Delete a ScheduledAction

delete: (resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

detachResources

Detach resources from the scheduled action so they are excluded from future occurrences.

detachResources: (resourceGroupName: string, scheduledActionName: string, body: ResourceDetachRequest, options?: ScheduledActionsDetachResourcesOptionalParams) => PollerLike<OperationState<ResourceOperationResponse>, ResourceOperationResponse>

Property Value

(resourceGroupName: string, scheduledActionName: string, body: ResourceDetachRequest, options?: ScheduledActionsDetachResourcesOptionalParams) => PollerLike<OperationState<ResourceOperationResponse>, ResourceOperationResponse>

disable

Disable the scheduled action so its future occurrences do not run.

disable: (resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsDisableOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsDisableOptionalParams) => PollerLike<OperationState<void>, void>

enable

Enable a previously disabled scheduled action so its future occurrences run.

enable: (resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsEnableOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsEnableOptionalParams) => PollerLike<OperationState<void>, void>

get

Get a ScheduledAction

get: (resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsGetOptionalParams) => Promise<ScheduledAction>

Property Value

(resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsGetOptionalParams) => Promise<ScheduledAction>

listByResourceGroup

List ScheduledAction resources by resource group

listByResourceGroup: (resourceGroupName: string, options?: ScheduledActionsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ScheduledAction, ScheduledAction[], PageSettings>

Property Value

(resourceGroupName: string, options?: ScheduledActionsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ScheduledAction, ScheduledAction[], PageSettings>

listBySubscription

List ScheduledAction resources by subscription ID

listBySubscription: (options?: ScheduledActionsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<ScheduledAction, ScheduledAction[], PageSettings>

Property Value

(options?: ScheduledActionsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<ScheduledAction, ScheduledAction[], PageSettings>

listResources

List resources attached to Scheduled Actions

listResources: (resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsListResourcesOptionalParams) => PagedAsyncIterableIterator<ScheduledActionResource, ScheduledActionResource[], PageSettings>

Property Value

(resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsListResourcesOptionalParams) => PagedAsyncIterableIterator<ScheduledActionResource, ScheduledActionResource[], PageSettings>

patchResources

A synchronous resource action.

patchResources: (resourceGroupName: string, scheduledActionName: string, body: ResourcePatchRequest, options?: ScheduledActionsPatchResourcesOptionalParams) => Promise<ResourceOperationResponse>

Property Value

(resourceGroupName: string, scheduledActionName: string, body: ResourcePatchRequest, options?: ScheduledActionsPatchResourcesOptionalParams) => Promise<ResourceOperationResponse>

triggerManualOccurrence

Trigger a manual occurrence of the scheduled action immediately, outside its normal schedule.

triggerManualOccurrence: (resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsTriggerManualOccurrenceOptionalParams) => PollerLike<OperationState<Occurrence>, Occurrence>

Property Value

(resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsTriggerManualOccurrenceOptionalParams) => PollerLike<OperationState<Occurrence>, Occurrence>

update

Update a ScheduledAction

update: (resourceGroupName: string, scheduledActionName: string, properties: ScheduledActionUpdate, options?: ScheduledActionsUpdateOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, scheduledActionName: string, properties: ScheduledActionUpdate, options?: ScheduledActionsUpdateOptionalParams) => PollerLike<OperationState<void>, void>