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

2025/12/18 • 2 updated methods

ScheduledActions_VirtualMachinesExecuteCreate (updated)
Description :  [PRIVATE PREVIEW]: VirtualMachinesExecuteCreate: Execute create operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScheduledActions_VirtualMachinesExecuteCreate",
  "Description": {
    "new": "[PRIVATE PREVIEW]: VirtualMachinesExecuteCreate: Execute create operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.",
    "old": "VirtualMachinesExecuteCreate: Execute create operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it."
  }
}

⚼ 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: JSON object that contains VM properties that are common across all VMs in this batch (if you want to create 100 VMs in this request, and they all have same vmSize, then include vmSize in baseProfile) ,
Required: False ,
}
object ,
resourceOverrides:
{
Description: JSON array, that contains VM properties that should to be overridden for each VM in the batch (if you want to create 100 VMs, they all need a distinct computerName property, you pass computerNames for each VM in batch in this array), service will merge baseProfile with VM specific overrides and create a merged VMProfile. ,
Required: False ,
}
[
object ,
]
,
resourceCount:
{
Description: Number of VMs 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_VirtualMachinesExecuteDelete (updated)
Description :  [PRIVATE PREVIEW]: VirtualMachinesExecuteDelete: Execute delete operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScheduledActions_VirtualMachinesExecuteDelete",
  "Description": {
    "new": "[PRIVATE PREVIEW]: VirtualMachinesExecuteDelete: Execute delete operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.",
    "old": "VirtualMachinesExecuteDelete: Execute delete operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it."
  }
}

⚼ 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 ,
}
,
]
,
}
,
}