Share via

ScheduledActionsOperations interface

Package:
@azure/arm-computeschedule

Interface representing a ScheduledActions operations.

Properties

attachResources

A synchronous resource action.
cancelNextOccurrence

A synchronous resource action.
createOrUpdate

Create a ScheduledAction
delete
detachResources

A synchronous resource action.
disable

A synchronous resource action.
enable

A synchronous resource action.
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

A synchronous resource action.
update

Update a ScheduledAction
virtualMachinesCancelOperations

VirtualMachinesCancelOperations: Cancel a previously submitted (start/deallocate/hibernate) request
virtualMachinesExecuteCreate

VirtualMachinesExecuteCreate: Execute create operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
virtualMachinesExecuteDeallocate

VirtualMachinesExecuteDeallocate: Execute deallocate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
virtualMachinesExecuteDelete

VirtualMachinesExecuteDelete: Execute delete operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
virtualMachinesExecuteHibernate

VirtualMachinesExecuteHibernate: Execute hibernate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
virtualMachinesExecuteStart

VirtualMachinesExecuteStart: Execute start operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
virtualMachinesGetOperationErrors

VirtualMachinesGetOperationErrors: Get error details on operation errors (like transient errors encountered, additional logs) if they exist.
virtualMachinesGetOperationStatus

VirtualMachinesGetOperationStatus: Polling endpoint to read status of operations performed on virtual machines
virtualMachinesSubmitDeallocate

VirtualMachinesSubmitDeallocate: Schedule deallocate operation for a batch of virtual machines at datetime in future.
virtualMachinesSubmitHibernate

VirtualMachinesSubmitHibernate: Schedule hibernate operation for a batch of virtual machines at datetime in future.
virtualMachinesSubmitStart

VirtualMachinesSubmitStart: Schedule start operation for a batch of virtual machines at datetime in future.

Property Details

attachResources

A synchronous resource action.

attachResources: (resourceGroupName: string, scheduledActionName: string, body: ResourceAttachRequest, options?: ScheduledActionsAttachResourcesOptionalParams) => Promise<RecurringActionsResourceOperationResult>

Property Value

(resourceGroupName: string, scheduledActionName: string, body: ResourceAttachRequest, options?: ScheduledActionsAttachResourcesOptionalParams) => Promise<RecurringActionsResourceOperationResult>

cancelNextOccurrence

A synchronous resource action.

cancelNextOccurrence: (resourceGroupName: string, scheduledActionName: string, body: CancelOccurrenceRequest, options?: ScheduledActionsCancelNextOccurrenceOptionalParams) => Promise<RecurringActionsResourceOperationResult>

Property Value

(resourceGroupName: string, scheduledActionName: string, body: CancelOccurrenceRequest, options?: ScheduledActionsCancelNextOccurrenceOptionalParams) => Promise<RecurringActionsResourceOperationResult>

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: (resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

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

detachResources

A synchronous resource action.

detachResources: (resourceGroupName: string, scheduledActionName: string, body: ResourceDetachRequest, options?: ScheduledActionsDetachResourcesOptionalParams) => Promise<RecurringActionsResourceOperationResult>

Property Value

(resourceGroupName: string, scheduledActionName: string, body: ResourceDetachRequest, options?: ScheduledActionsDetachResourcesOptionalParams) => Promise<RecurringActionsResourceOperationResult>

disable

A synchronous resource action.

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

Property Value

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

enable

A synchronous resource action.

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

Property Value

(resourceGroupName: string, scheduledActionName: string, options?: ScheduledActionsEnableOptionalParams) => Promise<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<RecurringActionsResourceOperationResult>

Property Value

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

triggerManualOccurrence

A synchronous resource action.

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

Property Value

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

update

Update a ScheduledAction

update: (resourceGroupName: string, scheduledActionName: string, properties: ScheduledActionUpdate, options?: ScheduledActionsUpdateOptionalParams) => Promise<ScheduledAction>

Property Value

(resourceGroupName: string, scheduledActionName: string, properties: ScheduledActionUpdate, options?: ScheduledActionsUpdateOptionalParams) => Promise<ScheduledAction>

virtualMachinesCancelOperations

VirtualMachinesCancelOperations: Cancel a previously submitted (start/deallocate/hibernate) request

virtualMachinesCancelOperations: (locationparameter: string, requestBody: CancelOperationsRequest, options?: ScheduledActionsVirtualMachinesCancelOperationsOptionalParams) => Promise<CancelOperationsResponse>

Property Value

(locationparameter: string, requestBody: CancelOperationsRequest, options?: ScheduledActionsVirtualMachinesCancelOperationsOptionalParams) => Promise<CancelOperationsResponse>

virtualMachinesExecuteCreate

VirtualMachinesExecuteCreate: Execute create operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.

virtualMachinesExecuteCreate: (locationparameter: string, requestBody: ExecuteCreateRequest, options?: ScheduledActionsVirtualMachinesExecuteCreateOptionalParams) => Promise<CreateResourceOperationResponse>

Property Value

(locationparameter: string, requestBody: ExecuteCreateRequest, options?: ScheduledActionsVirtualMachinesExecuteCreateOptionalParams) => Promise<CreateResourceOperationResponse>

virtualMachinesExecuteDeallocate

VirtualMachinesExecuteDeallocate: Execute deallocate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.

virtualMachinesExecuteDeallocate: (locationparameter: string, requestBody: ExecuteDeallocateRequest, options?: ScheduledActionsVirtualMachinesExecuteDeallocateOptionalParams) => Promise<DeallocateResourceOperationResponse>

Property Value

(locationparameter: string, requestBody: ExecuteDeallocateRequest, options?: ScheduledActionsVirtualMachinesExecuteDeallocateOptionalParams) => Promise<DeallocateResourceOperationResponse>

virtualMachinesExecuteDelete

VirtualMachinesExecuteDelete: Execute delete operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.

virtualMachinesExecuteDelete: (locationparameter: string, requestBody: ExecuteDeleteRequest, options?: ScheduledActionsVirtualMachinesExecuteDeleteOptionalParams) => Promise<DeleteResourceOperationResponse>

Property Value

(locationparameter: string, requestBody: ExecuteDeleteRequest, options?: ScheduledActionsVirtualMachinesExecuteDeleteOptionalParams) => Promise<DeleteResourceOperationResponse>

virtualMachinesExecuteHibernate

VirtualMachinesExecuteHibernate: Execute hibernate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.

virtualMachinesExecuteHibernate: (locationparameter: string, requestBody: ExecuteHibernateRequest, options?: ScheduledActionsVirtualMachinesExecuteHibernateOptionalParams) => Promise<HibernateResourceOperationResponse>

Property Value

(locationparameter: string, requestBody: ExecuteHibernateRequest, options?: ScheduledActionsVirtualMachinesExecuteHibernateOptionalParams) => Promise<HibernateResourceOperationResponse>

virtualMachinesExecuteStart

VirtualMachinesExecuteStart: Execute start operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.

virtualMachinesExecuteStart: (locationparameter: string, requestBody: ExecuteStartRequest, options?: ScheduledActionsVirtualMachinesExecuteStartOptionalParams) => Promise<StartResourceOperationResponse>

Property Value

(locationparameter: string, requestBody: ExecuteStartRequest, options?: ScheduledActionsVirtualMachinesExecuteStartOptionalParams) => Promise<StartResourceOperationResponse>

virtualMachinesGetOperationErrors

VirtualMachinesGetOperationErrors: Get error details on operation errors (like transient errors encountered, additional logs) if they exist.

virtualMachinesGetOperationErrors: (locationparameter: string, requestBody: GetOperationErrorsRequest, options?: ScheduledActionsVirtualMachinesGetOperationErrorsOptionalParams) => Promise<GetOperationErrorsResponse>

Property Value

(locationparameter: string, requestBody: GetOperationErrorsRequest, options?: ScheduledActionsVirtualMachinesGetOperationErrorsOptionalParams) => Promise<GetOperationErrorsResponse>

virtualMachinesGetOperationStatus

VirtualMachinesGetOperationStatus: Polling endpoint to read status of operations performed on virtual machines

virtualMachinesGetOperationStatus: (locationparameter: string, requestBody: GetOperationStatusRequest, options?: ScheduledActionsVirtualMachinesGetOperationStatusOptionalParams) => Promise<GetOperationStatusResponse>

Property Value

(locationparameter: string, requestBody: GetOperationStatusRequest, options?: ScheduledActionsVirtualMachinesGetOperationStatusOptionalParams) => Promise<GetOperationStatusResponse>

virtualMachinesSubmitDeallocate

VirtualMachinesSubmitDeallocate: Schedule deallocate operation for a batch of virtual machines at datetime in future.

virtualMachinesSubmitDeallocate: (locationparameter: string, requestBody: SubmitDeallocateRequest, options?: ScheduledActionsVirtualMachinesSubmitDeallocateOptionalParams) => Promise<DeallocateResourceOperationResponse>

Property Value

(locationparameter: string, requestBody: SubmitDeallocateRequest, options?: ScheduledActionsVirtualMachinesSubmitDeallocateOptionalParams) => Promise<DeallocateResourceOperationResponse>

virtualMachinesSubmitHibernate

VirtualMachinesSubmitHibernate: Schedule hibernate operation for a batch of virtual machines at datetime in future.

virtualMachinesSubmitHibernate: (locationparameter: string, requestBody: SubmitHibernateRequest, options?: ScheduledActionsVirtualMachinesSubmitHibernateOptionalParams) => Promise<HibernateResourceOperationResponse>

Property Value

(locationparameter: string, requestBody: SubmitHibernateRequest, options?: ScheduledActionsVirtualMachinesSubmitHibernateOptionalParams) => Promise<HibernateResourceOperationResponse>

virtualMachinesSubmitStart

VirtualMachinesSubmitStart: Schedule start operation for a batch of virtual machines at datetime in future.

virtualMachinesSubmitStart: (locationparameter: string, requestBody: SubmitStartRequest, options?: ScheduledActionsVirtualMachinesSubmitStartOptionalParams) => Promise<StartResourceOperationResponse>

Property Value

(locationparameter: string, requestBody: SubmitStartRequest, options?: ScheduledActionsVirtualMachinesSubmitStartOptionalParams) => Promise<StartResourceOperationResponse>