Microsoft.ComputeSchedule (stable:2024-10-01)

2024/12/09 • 9 updated methods

ScheduledActions_VirtualMachinesCancelOperations (updated)
Description :  CancelOperations: Cancel a previously submitted (start/deallocate/hibernate) request for submit-type ComputeSchedule operations
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScheduledActions_VirtualMachinesCancelOperations",
  "Description": {
    "new": "CancelOperations: Cancel a previously submitted (start/deallocate/hibernate) request for submit-type ComputeSchedule operations",
    "old": "virtualMachinesCancelOperations: cancelOperations for a virtual machine"
  },
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": {
            "operation": [
              {
                "#name": "deadlineType",
                "Enum": {
                  "new": [
                    [
                      "Unknown",
                      "Default value of Unknown."
                    ],
                    [
                      "InitiateAt",
                      "Initiate the operation at the given deadline."
                    ]
                  ],
                  "old": [
                    [
                      "Unknown",
                      "Default value of Unknown."
                    ],
                    [
                      "InitiateAt",
                      "Initiate the operation at the given deadline."
                    ],
                    [
                      "CompleteBy",
                      "Complete the operation by the given deadline."
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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. ,
}
,
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 (updated)
Description :  ExecuteDeallocate: Execute deallocate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule recieves it.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScheduledActions_VirtualMachinesExecuteDeallocate",
  "Description": {
    "new": "ExecuteDeallocate: Execute deallocate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule recieves it.",
    "old": "virtualMachinesExecuteDeallocate: executeDeallocate for a virtual machine"
  },
  "$parameters": {
    "requestBody": {
      "$properties": {
        "executionParameters": [
          {
            "@removed_c99a63c1c16e474298e4f57287801237": {
              "#name": "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,
              "Type": "string"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": {
            "operation": [
              {
                "#name": "deadlineType",
                "Enum": {
                  "new": [
                    [
                      "Unknown",
                      "Default value of Unknown."
                    ],
                    [
                      "InitiateAt",
                      "Initiate the operation at the given deadline."
                    ]
                  ],
                  "old": [
                    [
                      "Unknown",
                      "Default value of Unknown."
                    ],
                    [
                      "InitiateAt",
                      "Initiate the operation at the given deadline."
                    ],
                    [
                      "CompleteBy",
                      "Complete the operation by the given deadline."
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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 ,
}
{
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. ,
}
,
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 (updated)
Description :  ExecuteHibernate: Execute hibernate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule recieves it.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScheduledActions_VirtualMachinesExecuteHibernate",
  "Description": {
    "new": "ExecuteHibernate: Execute hibernate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule recieves it.",
    "old": "virtualMachinesExecuteHibernate: executeHibernate for a virtual machine"
  },
  "$parameters": {
    "requestBody": {
      "$properties": {
        "executionParameters": [
          {
            "@removed_a067a1e250594840a4a11933cc51fa29": {
              "#name": "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,
              "Type": "string"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": {
            "operation": [
              {
                "#name": "deadlineType",
                "Enum": {
                  "new": [
                    [
                      "Unknown",
                      "Default value of Unknown."
                    ],
                    [
                      "InitiateAt",
                      "Initiate the operation at the given deadline."
                    ]
                  ],
                  "old": [
                    [
                      "Unknown",
                      "Default value of Unknown."
                    ],
                    [
                      "InitiateAt",
                      "Initiate the operation at the given deadline."
                    ],
                    [
                      "CompleteBy",
                      "Complete the operation by the given deadline."
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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 ,
}
{
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. ,
}
,
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 (updated)
Description :  ExecuteStart: Execute start operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule recieves it.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScheduledActions_VirtualMachinesExecuteStart",
  "Description": {
    "new": "ExecuteStart: Execute start operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule recieves it.",
    "old": "virtualMachinesExecuteStart: executeStart for a virtual machine"
  },
  "$parameters": {
    "requestBody": {
      "$properties": {
        "executionParameters": [
          {
            "@removed_79ac25d2bbc84544a0639f0f23a55944": {
              "#name": "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,
              "Type": "string"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": {
            "operation": [
              {
                "#name": "deadlineType",
                "Enum": {
                  "new": [
                    [
                      "Unknown",
                      "Default value of Unknown."
                    ],
                    [
                      "InitiateAt",
                      "Initiate the operation at the given deadline."
                    ]
                  ],
                  "old": [
                    [
                      "Unknown",
                      "Default value of Unknown."
                    ],
                    [
                      "InitiateAt",
                      "Initiate the operation at the given deadline."
                    ],
                    [
                      "CompleteBy",
                      "Complete the operation by the given deadline."
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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 ,
}
{
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. ,
}
,
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 (updated)
Description :  GetOperationErrors: Get operation error details on operation errors (like transient errors encountered, additional logs) if they exist.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScheduledActions_VirtualMachinesGetOperationErrors",
  "Description": {
    "new": "GetOperationErrors: Get operation error details on operation errors (like transient errors encountered, additional logs) if they exist.",
    "old": "virtualMachinesGetOperationErrors: getOperationErrors associated with an operation on a virtual machine"
  }
}

⚼ 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 (updated)
Description :  GetOperationStatus: Polling endpoint to read status of operations performed on virtual machines
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScheduledActions_VirtualMachinesGetOperationStatus",
  "Description": {
    "new": "GetOperationStatus: Polling endpoint to read status of operations performed on virtual machines",
    "old": "virtualMachinesGetOperationStatus: getOperationStatus for a virtual machine"
  },
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": {
            "operation": [
              {
                "#name": "deadlineType",
                "Enum": {
                  "new": [
                    [
                      "Unknown",
                      "Default value of Unknown."
                    ],
                    [
                      "InitiateAt",
                      "Initiate the operation at the given deadline."
                    ]
                  ],
                  "old": [
                    [
                      "Unknown",
                      "Default value of Unknown."
                    ],
                    [
                      "InitiateAt",
                      "Initiate the operation at the given deadline."
                    ],
                    [
                      "CompleteBy",
                      "Complete the operation by the given deadline."
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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. ,
}
,
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 (updated)
Description :  SubmitDeallocate: Schedule deallocate operation for a batch of virtual machines at datetime in future.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScheduledActions_VirtualMachinesSubmitDeallocate",
  "Description": {
    "new": "SubmitDeallocate: Schedule deallocate operation for a batch of virtual machines at datetime in future.",
    "old": "virtualMachinesSubmitDeallocate: submitDeallocate for a virtual machine"
  },
  "$parameters": {
    "requestBody": {
      "$properties": {
        "schedule": [
          {
            "#name": "deadlineType",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Default value of Unknown."
                ],
                [
                  "InitiateAt",
                  "Initiate the operation at the given deadline."
                ]
              ],
              "old": [
                [
                  "Unknown",
                  "Default value of Unknown."
                ],
                [
                  "InitiateAt",
                  "Initiate the operation at the given deadline."
                ],
                [
                  "CompleteBy",
                  "Complete the operation by the given deadline."
                ]
              ]
            }
          }
        ],
        "executionParameters": [
          {
            "@removed_6245c3a1b49d48278442b2e39de525b3": {
              "#name": "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,
              "Type": "string"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": {
            "operation": [
              {
                "#name": "deadlineType",
                "Enum": {
                  "new": [
                    [
                      "Unknown",
                      "Default value of Unknown."
                    ],
                    [
                      "InitiateAt",
                      "Initiate the operation at the given deadline."
                    ]
                  ],
                  "old": [
                    [
                      "Unknown",
                      "Default value of Unknown."
                    ],
                    [
                      "InitiateAt",
                      "Initiate the operation at the given deadline."
                    ],
                    [
                      "CompleteBy",
                      "Complete the operation by the given deadline."
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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. ,
}
,
Required: True ,
}
enum ,
}
,
executionParameters:
{
Description: The execution parameters for the request ,
Required: True ,
}
{
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. ,
}
,
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 (updated)
Description :  SubmitHibernate: Schedule hibernate operation for a batch of virtual machines at datetime in future.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScheduledActions_VirtualMachinesSubmitHibernate",
  "Description": {
    "new": "SubmitHibernate: Schedule hibernate operation for a batch of virtual machines at datetime in future.",
    "old": "virtualMachinesSubmitHibernate: submitHibernate for a virtual machine"
  },
  "$parameters": {
    "requestBody": {
      "$properties": {
        "schedule": [
          {
            "#name": "deadlineType",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Default value of Unknown."
                ],
                [
                  "InitiateAt",
                  "Initiate the operation at the given deadline."
                ]
              ],
              "old": [
                [
                  "Unknown",
                  "Default value of Unknown."
                ],
                [
                  "InitiateAt",
                  "Initiate the operation at the given deadline."
                ],
                [
                  "CompleteBy",
                  "Complete the operation by the given deadline."
                ]
              ]
            }
          }
        ],
        "executionParameters": [
          {
            "@removed_5198ce195b9d4cd180ad074e13cee74f": {
              "#name": "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,
              "Type": "string"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": {
            "operation": [
              {
                "#name": "deadlineType",
                "Enum": {
                  "new": [
                    [
                      "Unknown",
                      "Default value of Unknown."
                    ],
                    [
                      "InitiateAt",
                      "Initiate the operation at the given deadline."
                    ]
                  ],
                  "old": [
                    [
                      "Unknown",
                      "Default value of Unknown."
                    ],
                    [
                      "InitiateAt",
                      "Initiate the operation at the given deadline."
                    ],
                    [
                      "CompleteBy",
                      "Complete the operation by the given deadline."
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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. ,
}
,
Required: True ,
}
enum ,
}
,
executionParameters:
{
Description: The execution parameters for the request ,
Required: True ,
}
{
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. ,
}
,
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 (updated)
Description :  SubmitStart: Schedule start operation for a batch of virtual machines at datetime in future.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScheduledActions_VirtualMachinesSubmitStart",
  "Description": {
    "new": "SubmitStart: Schedule start operation for a batch of virtual machines at datetime in future.",
    "old": "virtualMachinesSubmitStart: submitStart for a virtual machine"
  },
  "$parameters": {
    "requestBody": {
      "$properties": {
        "schedule": [
          {
            "#name": "deadlineType",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Default value of Unknown."
                ],
                [
                  "InitiateAt",
                  "Initiate the operation at the given deadline."
                ]
              ],
              "old": [
                [
                  "Unknown",
                  "Default value of Unknown."
                ],
                [
                  "InitiateAt",
                  "Initiate the operation at the given deadline."
                ],
                [
                  "CompleteBy",
                  "Complete the operation by the given deadline."
                ]
              ]
            }
          }
        ],
        "executionParameters": [
          {
            "@removed_cfe25d7bfaeb44cb8c7fa1a72d7bac27": {
              "#name": "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,
              "Type": "string"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": {
            "operation": [
              {
                "#name": "deadlineType",
                "Enum": {
                  "new": [
                    [
                      "Unknown",
                      "Default value of Unknown."
                    ],
                    [
                      "InitiateAt",
                      "Initiate the operation at the given deadline."
                    ]
                  ],
                  "old": [
                    [
                      "Unknown",
                      "Default value of Unknown."
                    ],
                    [
                      "InitiateAt",
                      "Initiate the operation at the given deadline."
                    ],
                    [
                      "CompleteBy",
                      "Complete the operation by the given deadline."
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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. ,
}
,
Required: True ,
}
enum ,
}
,
executionParameters:
{
Description: The execution parameters for the request ,
Required: True ,
}
{
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. ,
}
,
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 ,
}
,
]
,
}
,
}