Microsoft.ComputeSchedule (stable:2025-05-01)

2025/04/24 • 14 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ComputeSchedule/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScheduledActions_VirtualMachinesCancelOperations (new)
Description :  VirtualMachinesCancelOperations: Cancel a previously submitted (start/deallocate/hibernate) request
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesCancelOperations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationparameter:
{
Description: The location name. ,
Required: True ,
}
string ,
requestBody:
{
Description: The request body ,
Required: True ,
}
{
operationIds:
{
Description: The list of operation ids to cancel operations on ,
Required: True ,
}
[
string ,
]
,
correlationid:
{
Description: CorrelationId item ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
results:
{
Description: An array of resource operations that were successfully cancelled ,
Required: True ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScheduledActions_VirtualMachinesExecuteCreate (new)
Description :  VirtualMachinesExecuteCreate: Execute create operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesExecuteCreate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationparameter:
{
Description: The location name. ,
Required: True ,
}
string ,
requestBody:
{
Description: The request body ,
Required: True ,
}
{
resourceConfigParameters:
{
Description: resource creation payload ,
Required: True ,
}
{
baseProfile:
{
Description: baseProfile, Resource properties that common across all resources ,
Required: False ,
}
string ,
resourceOverrides:
{
Description: resourceOverrides, properties per resource that needs to be overwritted from baseProfile ,
Required: False ,
}
[
string ,
]
,
resourceCount:
{
Description: Number of resources to be created ,
Format: int32 ,
Required: True ,
}
integer ,
resourcePrefix:
{
Description: if resourceOverrides doesn't contain "name", service will create name based of prefix and ResourceCount e.g. resourceprefix-0,resourceprefix-1.. ,
Required: False ,
}
string ,
}
,
executionParameters:
{
Description: The execution parameters for the request ,
Required: True ,
}
{
optimizationPreference:
{
Description: Details that could optimize the user's request ,
Enum:
{
Cost: Optimize while considering cost savings ,
Availability: Optimize while considering availability of resources ,
CostAvailabilityBalanced: Optimize while considering a balance of cost and availability ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
correlationid:
{
Description: CorrelationId item ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
description:
{
Description: The description of the operation response ,
Required: True ,
}
string ,
type:
{
Description: The type of resources used in the create request eg virtual machines ,
Required: True ,
}
string ,
location:
{
Description: The location of the start request eg westus ,
Required: True ,
}
string ,
results:
{
Description: The results from the start request if no errors exist ,
Required: False ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScheduledActions_VirtualMachinesExecuteDeallocate (new)
Description :  VirtualMachinesExecuteDeallocate: Execute deallocate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesExecuteDeallocate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationparameter:
{
Description: The location name. ,
Required: True ,
}
string ,
requestBody:
{
Description: The request body ,
Required: True ,
}
{
executionParameters:
{
Description: The execution parameters for the request ,
Required: True ,
}
{
optimizationPreference:
{
Description: Details that could optimize the user's request ,
Enum:
{
Cost: Optimize while considering cost savings ,
Availability: Optimize while considering availability of resources ,
CostAvailabilityBalanced: Optimize while considering a balance of cost and availability ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
resources:
{
Description: The resources for the request ,
Required: True ,
}
{
ids:
{
Description: The resource ids used for the request ,
Required: True ,
}
[
string ,
]
,
}
,
correlationid:
{
Description: CorrelationId item ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
description:
{
Description: The description of the operation response ,
Required: True ,
}
string ,
type:
{
Description: The type of resources used in the deallocate request eg virtual machines ,
Required: True ,
}
string ,
location:
{
Description: The location of the deallocate request eg westus ,
Required: True ,
}
string ,
results:
{
Description: The results from the deallocate request if no errors exist ,
Required: False ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScheduledActions_VirtualMachinesExecuteDelete (new)
Description :  VirtualMachinesExecuteDelete: Execute delete operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesExecuteDelete
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationparameter:
{
Description: The location name. ,
Required: True ,
}
string ,
requestBody:
{
Description: The request body ,
Required: True ,
}
{
executionParameters:
{
Description: The execution parameters for the request ,
Required: True ,
}
{
optimizationPreference:
{
Description: Details that could optimize the user's request ,
Enum:
{
Cost: Optimize while considering cost savings ,
Availability: Optimize while considering availability of resources ,
CostAvailabilityBalanced: Optimize while considering a balance of cost and availability ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
resources:
{
Description: The resources for the request ,
Required: True ,
}
{
ids:
{
Description: The resource ids used for the request ,
Required: True ,
}
[
string ,
]
,
}
,
correlationid:
{
Description: CorrelationId item ,
Required: False ,
}
string ,
forceDeletion:
{
Description: Forced delete resource item ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
description:
{
Description: The description of the operation response ,
Required: True ,
}
string ,
type:
{
Description: The type of resources used in the delete request eg virtual machines ,
Required: True ,
}
string ,
location:
{
Description: The location of the start request eg westus ,
Required: True ,
}
string ,
results:
{
Description: The results from the start request if no errors exist ,
Required: False ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScheduledActions_VirtualMachinesExecuteHibernate (new)
Description :  VirtualMachinesExecuteHibernate: Execute hibernate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesExecuteHibernate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationparameter:
{
Description: The location name. ,
Required: True ,
}
string ,
requestBody:
{
Description: The request body ,
Required: True ,
}
{
executionParameters:
{
Description: The execution parameters for the request ,
Required: True ,
}
{
optimizationPreference:
{
Description: Details that could optimize the user's request ,
Enum:
{
Cost: Optimize while considering cost savings ,
Availability: Optimize while considering availability of resources ,
CostAvailabilityBalanced: Optimize while considering a balance of cost and availability ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
resources:
{
Description: The resources for the request ,
Required: True ,
}
{
ids:
{
Description: The resource ids used for the request ,
Required: True ,
}
[
string ,
]
,
}
,
correlationid:
{
Description: CorrelationId item ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
description:
{
Description: The description of the operation response ,
Required: True ,
}
string ,
type:
{
Description: The type of resources used in the Hibernate request eg virtual machines ,
Required: True ,
}
string ,
location:
{
Description: The location of the Hibernate request eg westus ,
Required: True ,
}
string ,
results:
{
Description: The results from the Hibernate request if no errors exist ,
Required: False ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScheduledActions_VirtualMachinesExecuteStart (new)
Description :  VirtualMachinesExecuteStart: Execute start operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesExecuteStart
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationparameter:
{
Description: The location name. ,
Required: True ,
}
string ,
requestBody:
{
Description: The request body ,
Required: True ,
}
{
executionParameters:
{
Description: The execution parameters for the request ,
Required: True ,
}
{
optimizationPreference:
{
Description: Details that could optimize the user's request ,
Enum:
{
Cost: Optimize while considering cost savings ,
Availability: Optimize while considering availability of resources ,
CostAvailabilityBalanced: Optimize while considering a balance of cost and availability ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
resources:
{
Description: The resources for the request ,
Required: True ,
}
{
ids:
{
Description: The resource ids used for the request ,
Required: True ,
}
[
string ,
]
,
}
,
correlationid:
{
Description: CorrelationId item ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
description:
{
Description: The description of the operation response ,
Required: True ,
}
string ,
type:
{
Description: The type of resources used in the start request eg virtual machines ,
Required: True ,
}
string ,
location:
{
Description: The location of the start request eg westus ,
Required: True ,
}
string ,
results:
{
Description: The results from the start request if no errors exist ,
Required: False ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScheduledActions_VirtualMachinesGetOperationErrors (new)
Description :  VirtualMachinesGetOperationErrors: Get error details on operation errors (like transient errors encountered, additional logs) if they exist.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesGetOperationErrors
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationparameter:
{
Description: The location name. ,
Required: True ,
}
string ,
requestBody:
{
Description: The request body ,
Required: True ,
}
{
operationIds:
{
Description: The list of operation ids to query errors of ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
results:
{
Description: An array of operationids and their corresponding errors if any ,
Required: True ,
}
[
{
operationId:
{
Description: The operationId identifying a vm operation ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of the error result ,
Format: date-time ,
Required: False ,
}
string ,
activationTime:
{
Description: The activation time of a vm operation ,
Format: date-time ,
Required: False ,
}
string ,
completedAt:
{
Description: The completion time of the operation if the operation was completed ,
Format: date-time ,
Required: False ,
}
string ,
operationErrors:
{
Description: A list of errors associated with the operationid ,
Required: False ,
}
[
{
errorCode:
{
Description: The error code of the operation ,
Required: True ,
}
string ,
errorDetails:
{
Description: The error details of the operation ,
Required: True ,
}
string ,
timestamp:
{
Description: The timestamp of the error occurence ,
Format: date-time ,
Required: False ,
}
string ,
timeStamp:
{
Description: The timestamp of the error occurence ,
Format: date-time ,
Required: False ,
}
string ,
azureOperationName:
{
Description: The compute operationid of the Start/Deallocate/Hibernate request ,
Required: False ,
}
string ,
crpOperationId:
{
Description: The compute operationid of the Start/Deallocate/Hibernate request ,
Required: False ,
}
string ,
}
,
]
,
requestErrorCode:
{
Description: Request level error code ,
Required: False ,
}
string ,
requestErrorDetails:
{
Description: Request level error details ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScheduledActions_VirtualMachinesGetOperationStatus (new)
Description :  VirtualMachinesGetOperationStatus: Polling endpoint to read status of operations performed on virtual machines
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesGetOperationStatus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationparameter:
{
Description: The location name. ,
Required: True ,
}
string ,
requestBody:
{
Description: The request body ,
Required: True ,
}
{
operationIds:
{
Description: The list of operation ids to get the status of ,
Required: True ,
}
[
string ,
]
,
correlationid:
{
Description: CorrelationId item ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
results:
{
Description: An array of resource operations based on their operation ids ,
Required: True ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScheduledActions_VirtualMachinesSubmitCreate (new)
Description :  VirtualMachinesSubmitCreate: submit create operation for a batch of virtual machines, at datetime in future.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesSubmitCreate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationparameter:
{
Description: The location name. ,
Required: True ,
}
string ,
requestBody:
{
Description: The request body ,
Required: True ,
}
{
schedule:
{
Description: The schedule for the request ,
Required: True ,
}
{
deadline:
{
Description: The deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadLine:
{
Description: The deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
timezone:
{
Description: The timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone for the operation ,
Required: False ,
}
string ,
deadlineType:
{
Description: The deadlinetype of the operation, this can either be InitiateAt or CompleteBy ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: True ,
}
enum ,
}
,
resourceConfigParameters:
{
Description: resource creation payload ,
Required: True ,
}
{
baseProfile:
{
Description: baseProfile, Resource properties that common across all resources ,
Required: False ,
}
string ,
resourceOverrides:
{
Description: resourceOverrides, properties per resource that needs to be overwritted from baseProfile ,
Required: False ,
}
[
string ,
]
,
resourceCount:
{
Description: Number of resources to be created ,
Format: int32 ,
Required: True ,
}
integer ,
resourcePrefix:
{
Description: if resourceOverrides doesn't contain "name", service will create name based of prefix and ResourceCount e.g. resourceprefix-0,resourceprefix-1.. ,
Required: False ,
}
string ,
}
,
executionParameters:
{
Description: The execution parameters for the request ,
Required: False ,
}
{
optimizationPreference:
{
Description: Details that could optimize the user's request ,
Enum:
{
Cost: Optimize while considering cost savings ,
Availability: Optimize while considering availability of resources ,
CostAvailabilityBalanced: Optimize while considering a balance of cost and availability ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
correlationid:
{
Description: CorrelationId item ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
description:
{
Description: The description of the operation response ,
Required: True ,
}
string ,
type:
{
Description: The type of resources used in the create request eg virtual machines ,
Required: True ,
}
string ,
location:
{
Description: The location of the start request eg westus ,
Required: True ,
}
string ,
results:
{
Description: The results from the start request if no errors exist ,
Required: False ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScheduledActions_VirtualMachinesSubmitDeallocate (new)
Description :  VirtualMachinesSubmitDeallocate: Schedule deallocate operation for a batch of virtual machines at datetime in future.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesSubmitDeallocate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationparameter:
{
Description: The location name. ,
Required: True ,
}
string ,
requestBody:
{
Description: The request body ,
Required: True ,
}
{
schedule:
{
Description: The schedule for the request ,
Required: True ,
}
{
deadline:
{
Description: The deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadLine:
{
Description: The deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
timezone:
{
Description: The timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone for the operation ,
Required: False ,
}
string ,
deadlineType:
{
Description: The deadlinetype of the operation, this can either be InitiateAt or CompleteBy ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: True ,
}
enum ,
}
,
executionParameters:
{
Description: The execution parameters for the request ,
Required: True ,
}
{
optimizationPreference:
{
Description: Details that could optimize the user's request ,
Enum:
{
Cost: Optimize while considering cost savings ,
Availability: Optimize while considering availability of resources ,
CostAvailabilityBalanced: Optimize while considering a balance of cost and availability ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
resources:
{
Description: The resources for the request ,
Required: True ,
}
{
ids:
{
Description: The resource ids used for the request ,
Required: True ,
}
[
string ,
]
,
}
,
correlationid:
{
Description: CorrelationId item ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
description:
{
Description: The description of the operation response ,
Required: True ,
}
string ,
type:
{
Description: The type of resources used in the deallocate request eg virtual machines ,
Required: True ,
}
string ,
location:
{
Description: The location of the deallocate request eg westus ,
Required: True ,
}
string ,
results:
{
Description: The results from the deallocate request if no errors exist ,
Required: False ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScheduledActions_VirtualMachinesSubmitDelete (new)
Description :  VirtualMachinesSubmitDelete: submit delete operation for a batch of virtual machines, at datetime in future.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesSubmitDelete
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationparameter:
{
Description: The location name. ,
Required: True ,
}
string ,
requestBody:
{
Description: The request body ,
Required: True ,
}
{
schedule:
{
Description: The schedule for the request ,
Required: True ,
}
{
deadline:
{
Description: The deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadLine:
{
Description: The deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
timezone:
{
Description: The timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone for the operation ,
Required: False ,
}
string ,
deadlineType:
{
Description: The deadlinetype of the operation, this can either be InitiateAt or CompleteBy ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: True ,
}
enum ,
}
,
executionParameters:
{
Description: The execution parameters for the request ,
Required: True ,
}
{
optimizationPreference:
{
Description: Details that could optimize the user's request ,
Enum:
{
Cost: Optimize while considering cost savings ,
Availability: Optimize while considering availability of resources ,
CostAvailabilityBalanced: Optimize while considering a balance of cost and availability ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
resources:
{
Description: The resources for the request ,
Required: True ,
}
{
ids:
{
Description: The resource ids used for the request ,
Required: True ,
}
[
string ,
]
,
}
,
correlationid:
{
Description: CorrelationId item ,
Required: False ,
}
string ,
forceDeletion:
{
Description: Forced delete resource item ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
description:
{
Description: The description of the operation response ,
Required: True ,
}
string ,
type:
{
Description: The type of resources used in the delete request eg virtual machines ,
Required: True ,
}
string ,
location:
{
Description: The location of the start request eg westus ,
Required: True ,
}
string ,
results:
{
Description: The results from the start request if no errors exist ,
Required: False ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScheduledActions_VirtualMachinesSubmitHibernate (new)
Description :  VirtualMachinesSubmitHibernate: Schedule hibernate operation for a batch of virtual machines at datetime in future.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesSubmitHibernate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationparameter:
{
Description: The location name. ,
Required: True ,
}
string ,
requestBody:
{
Description: The request body ,
Required: True ,
}
{
schedule:
{
Description: The schedule for the request ,
Required: True ,
}
{
deadline:
{
Description: The deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadLine:
{
Description: The deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
timezone:
{
Description: The timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone for the operation ,
Required: False ,
}
string ,
deadlineType:
{
Description: The deadlinetype of the operation, this can either be InitiateAt or CompleteBy ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: True ,
}
enum ,
}
,
executionParameters:
{
Description: The execution parameters for the request ,
Required: True ,
}
{
optimizationPreference:
{
Description: Details that could optimize the user's request ,
Enum:
{
Cost: Optimize while considering cost savings ,
Availability: Optimize while considering availability of resources ,
CostAvailabilityBalanced: Optimize while considering a balance of cost and availability ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
resources:
{
Description: The resources for the request ,
Required: True ,
}
{
ids:
{
Description: The resource ids used for the request ,
Required: True ,
}
[
string ,
]
,
}
,
correlationid:
{
Description: CorrelationId item ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
description:
{
Description: The description of the operation response ,
Required: True ,
}
string ,
type:
{
Description: The type of resources used in the Hibernate request eg virtual machines ,
Required: True ,
}
string ,
location:
{
Description: The location of the Hibernate request eg westus ,
Required: True ,
}
string ,
results:
{
Description: The results from the Hibernate request if no errors exist ,
Required: False ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScheduledActions_VirtualMachinesSubmitStart (new)
Description :  VirtualMachinesSubmitStart: Schedule start operation for a batch of virtual machines at datetime in future.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesSubmitStart
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationparameter:
{
Description: The location name. ,
Required: True ,
}
string ,
requestBody:
{
Description: The request body ,
Required: True ,
}
{
schedule:
{
Description: The schedule for the request ,
Required: True ,
}
{
deadline:
{
Description: The deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadLine:
{
Description: The deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
timezone:
{
Description: The timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone for the operation ,
Required: False ,
}
string ,
deadlineType:
{
Description: The deadlinetype of the operation, this can either be InitiateAt or CompleteBy ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: True ,
}
enum ,
}
,
executionParameters:
{
Description: The execution parameters for the request ,
Required: True ,
}
{
optimizationPreference:
{
Description: Details that could optimize the user's request ,
Enum:
{
Cost: Optimize while considering cost savings ,
Availability: Optimize while considering availability of resources ,
CostAvailabilityBalanced: Optimize while considering a balance of cost and availability ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
resources:
{
Description: The resources for the request ,
Required: True ,
}
{
ids:
{
Description: The resource ids used for the request ,
Required: True ,
}
[
string ,
]
,
}
,
correlationid:
{
Description: CorrelationId item ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
description:
{
Description: The description of the operation response ,
Required: True ,
}
string ,
type:
{
Description: The type of resources used in the start request eg virtual machines ,
Required: True ,
}
string ,
location:
{
Description: The location of the start request eg westus ,
Required: True ,
}
string ,
results:
{
Description: The results from the start request if no errors exist ,
Required: False ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}