BulkActionsOperations interface

Package:

@azure/arm-computebulkactions

Interface representing a BulkActions operations.

Properties

cancel	Cancels LaunchBulkInstancesOperation instances that have not yet launched.
createOrUpdate	Creates or updates LaunchBulkInstancesOperations.
delete
get	Gets an instance of LaunchBulkInstancesOperations.
getOperationStatus	Get the status of a LaunchBulkInstancesOperation.
listByResourceGroup	List LaunchBulkInstancesOperation resources by resource group.
listBySubscription	List LaunchBulkInstancesOperation resources by subscriptionId.
listVirtualMachines	List VirtualMachine resources of a LaunchBulkInstancesOperation.
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.
virtualMachinesGetOperationStatus	VirtualMachinesGetOperationStatus: Polling endpoint to read status of operations performed on virtual machines

Property Details

cancel

Cancels LaunchBulkInstancesOperation instances that have not yet launched.

cancel: (resourceGroupName: string, location: string, name: string, options?: BulkActionsCancelOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, location: string, name: string, options?: BulkActionsCancelOptionalParams) => PollerLike<OperationState<void>, void>

createOrUpdate

Creates or updates LaunchBulkInstancesOperations.

createOrUpdate: (resourceGroupName: string, location: string, name: string, resource: LocationBasedLaunchBulkInstancesOperation, options?: BulkActionsCreateOrUpdateOptionalParams) => PollerLike<OperationState<LocationBasedLaunchBulkInstancesOperation>, LocationBasedLaunchBulkInstancesOperation>

Property Value

(resourceGroupName: string, location: string, name: string, resource: LocationBasedLaunchBulkInstancesOperation, options?: BulkActionsCreateOrUpdateOptionalParams) => PollerLike<OperationState<LocationBasedLaunchBulkInstancesOperation>, LocationBasedLaunchBulkInstancesOperation>

delete

delete: (resourceGroupName: string, location: string, name: string, options?: BulkActionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, location: string, name: string, options?: BulkActionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets an instance of LaunchBulkInstancesOperations.

get: (resourceGroupName: string, location: string, name: string, options?: BulkActionsGetOptionalParams) => Promise<LocationBasedLaunchBulkInstancesOperation>

Property Value

(resourceGroupName: string, location: string, name: string, options?: BulkActionsGetOptionalParams) => Promise<LocationBasedLaunchBulkInstancesOperation>

getOperationStatus

Get the status of a LaunchBulkInstancesOperation.

getOperationStatus: (location: string, id: string, options?: BulkActionsGetOperationStatusOptionalParams) => Promise<OperationStatusResult>

Property Value

(location: string, id: string, options?: BulkActionsGetOperationStatusOptionalParams) => Promise<OperationStatusResult>

listByResourceGroup

List LaunchBulkInstancesOperation resources by resource group.

listByResourceGroup: (resourceGroupName: string, location: string, options?: BulkActionsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<LocationBasedLaunchBulkInstancesOperation, LocationBasedLaunchBulkInstancesOperation[], PageSettings>

Property Value

(resourceGroupName: string, location: string, options?: BulkActionsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<LocationBasedLaunchBulkInstancesOperation, LocationBasedLaunchBulkInstancesOperation[], PageSettings>

listBySubscription

List LaunchBulkInstancesOperation resources by subscriptionId.

listBySubscription: (location: string, options?: BulkActionsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<LocationBasedLaunchBulkInstancesOperation, LocationBasedLaunchBulkInstancesOperation[], PageSettings>

Property Value

(location: string, options?: BulkActionsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<LocationBasedLaunchBulkInstancesOperation, LocationBasedLaunchBulkInstancesOperation[], PageSettings>

listVirtualMachines

List VirtualMachine resources of a LaunchBulkInstancesOperation.

listVirtualMachines: (resourceGroupName: string, location: string, name: string, options?: BulkActionsListVirtualMachinesOptionalParams) => PagedAsyncIterableIterator<VirtualMachine, VirtualMachine[], PageSettings>

Property Value

(resourceGroupName: string, location: string, name: string, options?: BulkActionsListVirtualMachinesOptionalParams) => PagedAsyncIterableIterator<VirtualMachine, VirtualMachine[], PageSettings>

virtualMachinesCancelOperations

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

virtualMachinesCancelOperations: (location: string, requestBody: CancelOperationsRequest, options?: BulkActionsVirtualMachinesCancelOperationsOptionalParams) => Promise<CancelOperationsResponse>

Property Value

(location: string, requestBody: CancelOperationsRequest, options?: BulkActionsVirtualMachinesCancelOperationsOptionalParams) => Promise<CancelOperationsResponse>

virtualMachinesExecuteCreate

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

virtualMachinesExecuteCreate: (location: string, requestBody: ExecuteCreateRequest, options?: BulkActionsVirtualMachinesExecuteCreateOptionalParams) => Promise<CreateResourceOperationResponse>

Property Value

(location: string, requestBody: ExecuteCreateRequest, options?: BulkActionsVirtualMachinesExecuteCreateOptionalParams) => Promise<CreateResourceOperationResponse>

virtualMachinesExecuteDeallocate

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

virtualMachinesExecuteDeallocate: (location: string, requestBody: ExecuteDeallocateRequest, options?: BulkActionsVirtualMachinesExecuteDeallocateOptionalParams) => Promise<DeallocateResourceOperationResponse>

Property Value

(location: string, requestBody: ExecuteDeallocateRequest, options?: BulkActionsVirtualMachinesExecuteDeallocateOptionalParams) => Promise<DeallocateResourceOperationResponse>

virtualMachinesExecuteDelete

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

virtualMachinesExecuteDelete: (location: string, requestBody: ExecuteDeleteRequest, options?: BulkActionsVirtualMachinesExecuteDeleteOptionalParams) => Promise<DeleteResourceOperationResponse>

Property Value

(location: string, requestBody: ExecuteDeleteRequest, options?: BulkActionsVirtualMachinesExecuteDeleteOptionalParams) => Promise<DeleteResourceOperationResponse>

virtualMachinesExecuteHibernate

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

virtualMachinesExecuteHibernate: (location: string, requestBody: ExecuteHibernateRequest, options?: BulkActionsVirtualMachinesExecuteHibernateOptionalParams) => Promise<HibernateResourceOperationResponse>

Property Value

(location: string, requestBody: ExecuteHibernateRequest, options?: BulkActionsVirtualMachinesExecuteHibernateOptionalParams) => Promise<HibernateResourceOperationResponse>

virtualMachinesExecuteStart

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

virtualMachinesExecuteStart: (location: string, requestBody: ExecuteStartRequest, options?: BulkActionsVirtualMachinesExecuteStartOptionalParams) => Promise<StartResourceOperationResponse>

Property Value

(location: string, requestBody: ExecuteStartRequest, options?: BulkActionsVirtualMachinesExecuteStartOptionalParams) => Promise<StartResourceOperationResponse>

virtualMachinesGetOperationStatus

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

virtualMachinesGetOperationStatus: (location: string, requestBody: GetOperationStatusRequest, options?: BulkActionsVirtualMachinesGetOperationStatusOptionalParams) => Promise<GetOperationStatusResponse>

Property Value

(location: string, requestBody: GetOperationStatusRequest, options?: BulkActionsVirtualMachinesGetOperationStatusOptionalParams) => Promise<GetOperationStatusResponse>