ScheduledActionsOperations interface
Interface representing a ScheduledActions operations.
Properties
| attach |
Adds resources to the specified scheduled action. |
| cancel |
Cancels the next occurrence of the specified scheduled action. |
| create |
Creates or updates a scheduled action. |
| delete | Deletes the specified scheduled action. |
| detach |
Removes resources from the specified scheduled action. |
| disable | Disables the specified scheduled action so future occurrences do not run. |
| enable | Enables the specified scheduled action so new occurrences run. |
| get | Gets the specified scheduled action. |
| list |
Lists scheduled actions in the specified resource group. |
| list |
Lists scheduled actions in the specified subscription. |
| list |
Lists resources associated with the specified scheduled action. |
| patch |
Updates resource-specific settings for the specified scheduled action. |
| trigger |
Runs the specified scheduled action immediately. |
| update | Updates the specified scheduled action. |
Property Details
attachResources
Adds resources to the specified scheduled action.
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
Cancels the next occurrence of the specified 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
Creates or updates a scheduled action.
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
Deletes the specified scheduled action.
delete: (resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>
detachResources
Removes resources from the specified scheduled action.
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
Disables the specified scheduled action so 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
Enables the specified scheduled action so new 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
Gets the specified scheduled action.
get: (resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsGetOptionalParams) => Promise<ScheduledAction>Property Value
(resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsGetOptionalParams) => Promise<ScheduledAction>
listByResourceGroup
Lists scheduled actions in the specified resource group.
listByResourceGroup: (resourceGroupName: string, options?: ScheduledActionsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ScheduledAction, ScheduledAction[], PageSettings>Property Value
(resourceGroupName: string, options?: ScheduledActionsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ScheduledAction, ScheduledAction[], PageSettings>
listBySubscription
Lists scheduled actions in the specified subscription.
listBySubscription: (options?: ScheduledActionsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<ScheduledAction, ScheduledAction[], PageSettings>Property Value
(options?: ScheduledActionsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<ScheduledAction, ScheduledAction[], PageSettings>
listResources
Lists resources associated with the specified scheduled action.
listResources: (resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsListResourcesOptionalParams) => PagedAsyncIterableIterator<ScheduledActionResource, ScheduledActionResource[], PageSettings>Property Value
(resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsListResourcesOptionalParams) => PagedAsyncIterableIterator<ScheduledActionResource, ScheduledActionResource[], PageSettings>
patchResources
Updates resource-specific settings for the specified scheduled 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
Runs the specified scheduled action immediately.
triggerManualOccurrence: (resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsTriggerManualOccurrenceOptionalParams) => PollerLike<OperationState<Occurrence>, Occurrence>Property Value
(resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsTriggerManualOccurrenceOptionalParams) => PollerLike<OperationState<Occurrence>, Occurrence>
update
Updates the specified scheduled action.
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>
