@azure/arm-computeschedule package

The request to cancel an occurrence.

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

This is the response from a cancel operations request

Optional parameters for the client.

The response from a create request

The response from a deallocate request

Request to ask for a delay in an occurrence, delay should be set to client local time eg (ACST) 2025-05-30T22:03:00+09:30, (PST) 2025-05-30T06:35:00-07:00

The response from a delete request

The resource management error additional info.

The error detail.

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

The ExecuteCreateRequest request for create operations

The ExecuteDeallocateRequest request for executeDeallocate operations

The ExecuteDeleteRequest for delete VM operation

The ExecuteHibernateRequest request for executeHibernate operations

The ExecuteStartRequest request for executeStart operations

Extra details needed to run the user's request

The base extension resource.

This is the request to get errors per vm operations

This is the response from a get operations errors request

This is the request to get operation status using operationids

This is the response from a get operations status request

The response from a Hibernate request

The information about notifications to be send to about upcoming operations.

Concrete proxy resource types can be created by aliasing this type using a specific property type.

Optional parameters.

Interface representing a OccurrenceExtension operations.

The properties of the occurrence extension

The scheduled action extension

Properties for an occurrence

Represents an scheduled action resource metadata.

The summarized provisioning result of an occurrence

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Occurrences operations.

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

Localized display information for and operation.

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

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

Optional parameters.

Interface representing a Operations operations.

Options for the byPage method

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

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

The response from scheduled action resource requests, which contains the status of each resource

Common fields that are returned in the response for all Azure Resource Manager resources

Request model to attach a list of scheduled action resources.

Request model to detach a list of scheduled action resources.

High level response from an operation on a resource

The details of a response from an operation on a resource

These describe errors that occur at the resource level

Request model perform a resource operation in a list of resources

Resource creation data model

The status of the resources

The status of a resource after a resource level operation was performed

The resources needed for the user request

The retry policy for the user request

The schedule details for the user request

The scheduled action resource

Optional parameters.

Interface representing a ScheduledActionExtension operations.

Scheduled action properties

Represents an scheduled action resource metadata.

Represents an scheduled action resource metadata.

The scheduled action extension

The type used for update operations of the ScheduledAction.

The updatable properties of the ScheduledAction.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a ScheduledActions operations.

Optional parameters.

Specify the schedule in which the scheduled action is supposed to follow

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

The response from a start request

The deallocate request for resources

This is the request for hibernate

This is the request for start

Metadata pertaining to creation and last modification of the resource.

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

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.

The supported values for cloud setting as a string literal type

An interface that describes a page of results.

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

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.

The notification languages currently supported
KnownLanguage can be used interchangeably with Language, this enum contains the known values that the service supports.

Known values supported by the service

en-us: American english language

Representation of the months available selection in a gregorian calendar
KnownMonth can be used interchangeably with Month, this enum contains the known values that the service supports.

Known values supported by the service

January: The January month.
February: The February month.
March: The March month.
April: The April month.
May: The May month.
June: The June month.
July: The July month.
August: The August month.
September: The September month.
October: The October month.
November: The November month.
December: The December month.
All: All months

The type of notification supported
KnownNotificationType can be used interchangeably with NotificationType, this enum contains the known values that the service supports.

Known values supported by the service

Email: Notify through e-mail

The state the occurrence is at a given time
KnownOccurrenceState can be used interchangeably with OccurrenceState, this enum contains the known values that the service supports.

Known values supported by the service

Created: The occurrence was created
Rescheduling: The occurrence is being rescheduled
Scheduled: The occurrence has been scheduled
Succeeded: The occurrence has successfully ran
Failed: The occurrence has failed during its scheduling
Cancelling: The occurrence is going through cancellation
Canceled: The occurrence has been canceled

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

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

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.

Provisioning state
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Resource has been created.
Failed: Resource creation failed.
Canceled: Resource creation was canceled.
Deleting: Resource is being deleted.

The state the resource is on after the resource operation is applied
KnownResourceOperationStatus can be used interchangeably with ResourceOperationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The resource operation was successful
Failed: The resource operation has failed.

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

The provisioning state of a resource type.
KnownResourceProvisioningState can be used interchangeably with ResourceProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Resource has been created.
Failed: Resource creation failed.
Canceled: Resource creation was canceled.

The type of resource being targeted
KnownResourceType can be used interchangeably with ResourceType, this enum contains the known values that the service supports.

Known values supported by the service

VirtualMachine: Resources defined are Virtual Machines
VirtualMachineScaleSet: Resources defined are Virtual Machines Scale Sets

Specify which action user wants to be performed on the resources
KnownScheduledActionType can be used interchangeably with ScheduledActionType, this enum contains the known values that the service supports.

Known values supported by the service

Start: Perform a start action on the specified resources
Deallocate: Perform a deallocate action on the specified resources
Hibernate: Perform hibernate and deallocate on the specified resources

Representation of the possible selection of days in a week in a gregorian calendar
KnownWeekDay can be used interchangeably with WeekDay, this enum contains the known values that the service supports.

Known values supported by the service

Monday: Monday weekday.
Tuesday: Tuesday weekday.
Wednesday: Wednesday weekday.
Thursday: Thursday weekday.
Friday: Friday weekday.
Saturday: Saturday weekday.
Sunday: Sunday weekday.
All: All week days

An enum to describe Azure Cloud.

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

The kind of entity that created the resource.

The types of deadlines supported by ScheduledActions

The notification languages currently supported

Representation of the months available selection in a gregorian calendar

The type of notification supported

The state the occurrence is at a given time

Values that define the states of operations in Scheduled Actions

The preferences customers can select to optimize their requests to ScheduledActions

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

Provisioning state

The state the resource is on after the resource operation is applied

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

The provisioning state of a resource type.

The type of resource being targeted

Specify which action user wants to be performed on the resources

ComputeSchedule API versions

Representation of the possible selection of days in a week in a gregorian calendar

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.