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

2024/12/09 • 6 updated methods

ScheduledActions_VirtualMachinesExecuteDeallocate (updated)
Description :  ExecuteDeallocate: Execute deallocate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScheduledActions_VirtualMachinesExecuteDeallocate",
  "$parameters": {
    "requestBody": {
      "$properties": {
        "executionParameters": [
          {
            "@added_504ebd5d3db9443a84843b481c60cc4e": {
              "#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"
            }
          }
        ]
      }
    }
  }
}

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

⚶ Changes

{
  "#id": "ScheduledActions_VirtualMachinesExecuteHibernate",
  "$parameters": {
    "requestBody": {
      "$properties": {
        "executionParameters": [
          {
            "@added_e842d5f83d244a3397961c9c687e6cd1": {
              "#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"
            }
          }
        ]
      }
    }
  }
}

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

⚶ Changes

{
  "#id": "ScheduledActions_VirtualMachinesExecuteStart",
  "$parameters": {
    "requestBody": {
      "$properties": {
        "executionParameters": [
          {
            "@added_1104364e0dae4f5b98dd50fda30b3729": {
              "#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"
            }
          }
        ]
      }
    }
  }
}

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

⚶ Changes

{
  "#id": "ScheduledActions_VirtualMachinesSubmitDeallocate",
  "$parameters": {
    "requestBody": {
      "$properties": {
        "executionParameters": [
          {
            "@added_134e2e5e503d44a0bf1733ffa71c2a81": {
              "#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"
            }
          }
        ]
      }
    }
  }
}

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

⚶ Changes

{
  "#id": "ScheduledActions_VirtualMachinesSubmitHibernate",
  "$parameters": {
    "requestBody": {
      "$properties": {
        "executionParameters": [
          {
            "@added_8e7a24c2700349979ac13d5a23edefc8": {
              "#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"
            }
          }
        ]
      }
    }
  }
}

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

⚶ Changes

{
  "#id": "ScheduledActions_VirtualMachinesSubmitStart",
  "$parameters": {
    "requestBody": {
      "$properties": {
        "executionParameters": [
          {
            "@added_478be14fefab48e8b27464f7e1df0fa0": {
              "#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"
            }
          }
        ]
      }
    }
  }
}

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