Share via


@azure/arm-computeschedule package

Classes

ComputeScheduleClient

Interfaces

CancelOperationsRequest

This is the request to cancel running operations in scheduled actions using the operation ids

CancelOperationsResponse

This is the response from a cancel operations request

ComputeScheduleClientOptionalParams

Optional parameters for the client.

CreateResourceOperationResponse

The response from a create request

DeallocateResourceOperationResponse

The response from a deallocate request

DeleteResourceOperationResponse

The response from a delete request

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

ExecuteCreateRequest

The ExecuteCreateRequest request for create operations

ExecuteDeallocateRequest

The ExecuteDeallocateRequest request for executeDeallocate operations

ExecuteDeleteRequest

The ExecuteDeleteRequest for delete VM operation

ExecuteHibernateRequest

The ExecuteHibernateRequest request for executeHibernate operations

ExecuteStartRequest

The ExecuteStartRequest request for executeStart operations

ExecutionParameters

Extra details needed to run the user's request

GetOperationErrorsRequest

This is the request to get errors per vm operations

GetOperationErrorsResponse

This is the response from a get operations errors request

GetOperationStatusRequest

This is the request to get operation status using operationids

GetOperationStatusResponse

This is the response from a get operations status request

HibernateResourceOperationResponse

The response from a Hibernate request

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

OperationDisplay

Localized display information for and operation.

OperationErrorDetails

This defines a list of operation errors associated with a unique operationId

OperationErrorsResult

This is the first level of operation errors from the request when clients get errors per vm operation

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

ResourceOperation

High level response from an operation on a resource

ResourceOperationDetails

The details of a response from an operation on a resource

ResourceOperationError

These describe errors that occur at the resource level

ResourceProvisionPayload

Resource creation data model

Resources

The resources needed for the user request

RetryPolicy

The retry policy for the user request

Schedule

The schedule details for the user request

ScheduledActionsOperations

Interface representing a ScheduledActions operations.

ScheduledActionsVirtualMachinesCancelOperationsOptionalParams

Optional parameters.

ScheduledActionsVirtualMachinesExecuteCreateOptionalParams

Optional parameters.

ScheduledActionsVirtualMachinesExecuteDeallocateOptionalParams

Optional parameters.

ScheduledActionsVirtualMachinesExecuteDeleteOptionalParams

Optional parameters.

ScheduledActionsVirtualMachinesExecuteHibernateOptionalParams

Optional parameters.

ScheduledActionsVirtualMachinesExecuteStartOptionalParams

Optional parameters.

ScheduledActionsVirtualMachinesGetOperationErrorsOptionalParams

Optional parameters.

ScheduledActionsVirtualMachinesGetOperationStatusOptionalParams

Optional parameters.

ScheduledActionsVirtualMachinesSubmitDeallocateOptionalParams

Optional parameters.

ScheduledActionsVirtualMachinesSubmitHibernateOptionalParams

Optional parameters.

ScheduledActionsVirtualMachinesSubmitStartOptionalParams

Optional parameters.

StartResourceOperationResponse

The response from a start request

SubmitDeallocateRequest

The deallocate request for resources

SubmitHibernateRequest

This is the request for hibernate

SubmitStartRequest

This is the request for start

Type Aliases

ActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

ContinuablePage

An interface that describes a page of results.

DeadlineType

The types of deadlines supported by ScheduledActions
KnownDeadlineType can be used interchangeably with DeadlineType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Default value of Unknown.
InitiateAt: Initiate the operation at the given deadline.
CompleteBy: Complete the operation by the given deadline.

OperationState

Values that define the states of operations in Scheduled Actions
KnownOperationState can be used interchangeably with OperationState, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: The default value for the operation state enum
PendingScheduling: Operations that are pending scheduling
Scheduled: Operations that have been scheduled
PendingExecution: Operations that are waiting to be executed
Executing: Operations that are in the process of being executed
Succeeded: Operations that suceeded
Failed: Operations that have failed
Cancelled: Operations that have been Cancelled by the user
Blocked: Operations that are blocked

OptimizationPreference

The preferences customers can select to optimize their requests to ScheduledActions
KnownOptimizationPreference can be used interchangeably with OptimizationPreference, this enum contains the known values that the service supports.

Known values supported by the service

Cost: Optimize while considering cost savings
Availability: Optimize while considering availability of resources
CostAvailabilityBalanced: Optimize while considering a balance of cost and availability

Origin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

ResourceOperationType

The kind of operation types that can be performed on resources using ScheduledActions
KnownResourceOperationType can be used interchangeably with ResourceOperationType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: The default value for this enum type
Start: Start operations on the resources
Deallocate: Deallocate operations on the resources
Hibernate: Hibernate operations on the resources

Enums

KnownActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

KnownDeadlineType

The types of deadlines supported by ScheduledActions

KnownOperationState

Values that define the states of operations in Scheduled Actions

KnownOptimizationPreference

The preferences customers can select to optimize their requests to ScheduledActions

KnownOrigin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

KnownResourceOperationType

The kind of operation types that can be performed on resources using ScheduledActions

KnownVersions

ComputeSchedule API versions