Microsoft.ComputeSchedule (preview:2025-04-15)

2025/07/23 • 1 updated methods

ScheduledActions_Update (updated)
Description :  Update a ScheduledAction
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScheduledActions_Update",
  "$parameters": {
    "properties": {
      "Description": {
        "new": "The type used for update operations of the ScheduledAction.",
        "old": "The scheduled action resource"
      },
      "$properties": {
        "@added_4b9b806826c34c1f8dc67508cf55e924": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        }
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ComputeSchedule/scheduledActions/{scheduledActionName}
{
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 ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scheduledActionName:
{
Description: The name of the ScheduledAction ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
resourceType:
{
Description: The type of resource the scheduled action is targeting ,
Enum:
{
VirtualMachine: Resources defined are Virtual Machines ,
VirtualMachineScaleSet: Resources defined are Virtual Machines Scale Sets ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: The action the scheduled action should perform in the resources ,
Enum:
{
Start: Perform a start action on the specified resources ,
Deallocate: Perform a deallocate action on the specified resources ,
Hibernate: Perform hibernate and deallocate on the specified resources ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The time which the scheduled action is supposed to start running ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time when the scheduled action is supposed to stop scheduling ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Description: The schedule the scheduled action is supposed to follow ,
Required: False ,
}
{
scheduledTime:
{
Description: The time the scheduled action is supposed to run on ,
Format: time ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone the scheduled time is specified on ,
Required: False ,
}
string ,
requestedWeekDays:
{
Description: The week days the scheduled action is supposed to run on ,
Required: False ,
}
[
string ,
]
,
requestedMonths:
{
Description: The months the scheduled action is supposed to run on ,
Required: False ,
}
[
string ,
]
,
requestedDaysOfTheMonth:
{
Description: The days of the month the scheduled action is supposed to run on. If empty, it means it will run on every day of the month. ,
Required: False ,
}
[
integer ,
]
,
executionParameters:
{
Description: The execution parameters the scheduled action is supposed to follow ,
Required: False ,
}
{
optimizationPreference:
{
Description: Details that could optimize the user's request ,
Enum:
{
Cost: Optimize while considering cost savings ,
Availability: Optimize while considering availability of resources ,
CostAvailabilityBalanced: Optimize while considering a balance of cost and availability ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
deadlineType:
{
Description: The type of deadline the scheduled action is supposed to follow for the schedule. If no value is passed, it will default to InitiateAt. ,
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 ,
}
,
notificationSettings:
{
Description: The notification settings for the scheduled action ,
Required: False ,
}
[
{
destination:
{
Description: Where the notification should be sent. For email, it should follow email format. ,
Required: True ,
}
string ,
type:
{
Description: Type of notification to be sent. ,
Enum:
{
Email: Notify through e-mail ,
}
,
Required: True ,
}
enum ,
language:
{
Description: The language the notification should be sent on. ,
Enum:
{
en-us: American english language ,
}
,
Required: True ,
}
enum ,
disabled:
{
Description: Tells if the notification is enabled or not. ,
Required: False ,
}
boolean ,
}
,
]
,
disabled:
{
Description: Tell if the scheduled action is disabled or not ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
resourceType:
{
Description: The type of resource the scheduled action is targeting ,
Enum:
{
VirtualMachine: Resources defined are Virtual Machines ,
VirtualMachineScaleSet: Resources defined are Virtual Machines Scale Sets ,
}
,
Required: True ,
}
enum ,
actionType:
{
Description: The action the scheduled action should perform in the resources ,
Enum:
{
Start: Perform a start action on the specified resources ,
Deallocate: Perform a deallocate action on the specified resources ,
Hibernate: Perform hibernate and deallocate on the specified resources ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: The time which the scheduled action is supposed to start running ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The time when the scheduled action is supposed to stop scheduling ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Description: The schedule the scheduled action is supposed to follow ,
Required: True ,
}
{
scheduledTime:
{
Description: The time the scheduled action is supposed to run on ,
Format: time ,
Required: True ,
}
string ,
timeZone:
{
Description: The timezone the scheduled time is specified on ,
Required: True ,
}
string ,
requestedWeekDays:
{
Description: The week days the scheduled action is supposed to run on ,
Required: True ,
}
[
string ,
]
,
requestedMonths:
{
Description: The months the scheduled action is supposed to run on ,
Required: True ,
}
[
string ,
]
,
requestedDaysOfTheMonth:
{
Description: The days of the month the scheduled action is supposed to run on. If empty, it means it will run on every day of the month. ,
Required: True ,
}
[
integer ,
]
,
executionParameters:
{
Description: The execution parameters the scheduled action is supposed to follow ,
Required: False ,
}
{
optimizationPreference:
{
Description: Details that could optimize the user's request ,
Enum:
{
Cost: Optimize while considering cost savings ,
Availability: Optimize while considering availability of resources ,
CostAvailabilityBalanced: Optimize while considering a balance of cost and availability ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
deadlineType:
{
Description: The type of deadline the scheduled action is supposed to follow for the schedule. If no value is passed, it will default to InitiateAt. ,
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 ,
}
,
notificationSettings:
{
Description: The notification settings for the scheduled action ,
Required: True ,
}
[
{
destination:
{
Description: Where the notification should be sent. For email, it should follow email format. ,
Required: True ,
}
string ,
type:
{
Description: Type of notification to be sent. ,
Enum:
{
Email: Notify through e-mail ,
}
,
Required: True ,
}
enum ,
language:
{
Description: The language the notification should be sent on. ,
Enum:
{
en-us: American english language ,
}
,
Required: True ,
}
enum ,
disabled:
{
Description: Tells if the notification is enabled or not. ,
Required: False ,
}
boolean ,
}
,
]
,
disabled:
{
Description: Tell if the scheduled action is disabled or not ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The status of the last provisioning operation performed on the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}

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