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

2025/07/11 • 33 new methods

OccurrenceExtension_ListOccurrenceByVms (new)
Description :  List OccurrenceExtensionResource resources by parent
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.ComputeSchedule/associatedOccurrences
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The OccurrenceExtensionResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM Id of the resource. "subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/virtualMachines/{vmName}" ,
Format: arm-id ,
Required: True ,
}
string ,
notificationSettings:
{
Description: The desired notification settings for the specified resource. ,
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 ,
}
,
]
,
scheduledTime:
{
Description: The time the occurrence is scheduled for the resource. Specified in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for the resource. Only populated if resource is in failed state. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
scheduledActionId:
{
Description: The arm identifier of the scheduled action the occurrence belongs to ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScheduledActionExtension_ListByVms (new)
Description :  List ScheduledActionResources resources by parent
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.ComputeSchedule/associatedScheduledActions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ScheduledActionResources items on this page ,
Required: True ,
}
[
{
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
results:
{
Description: An array of resource operations that were successfully cancelled ,
Required: True ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
Unknown: The default value for this enum type ,
Start: Start operations on the resources ,
Deallocate: Deallocate operations on the resources ,
Hibernate: Hibernate operations on the resources ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
Unknown: The default value for the operation state enum ,
PendingScheduling: Operations that are pending scheduling ,
Scheduled: Operations that have been scheduled ,
PendingExecution: Operations that are waiting to be executed ,
Executing: Operations that are in the process of being executed ,
Succeeded: Operations that suceeded ,
Failed: Operations that have failed ,
Cancelled: Operations that have been Cancelled by the user ,
Blocked: Operations that are blocked ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/locations/{locationparameter}/virtualMachinesExecuteCreate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationparameter:
{
Description: The location name. ,
Required: True ,
}
string ,
requestBody:
{
Description: The request body ,
Required: True ,
}
{
resourceConfigParameters:
{
Description: resource creation payload ,
Required: True ,
}
{
baseProfile:
{
Description: JSON object that contains VM properties that are common across all VMs in this batch (if you want to create 100 VMs in this request, and they all have same vmSize, then include vmSize in baseProfile) ,
Required: False ,
}
object ,
resourceOverrides:
{
Description: JSON array, that contains VM properties that should to be overridden for each VM in the batch (if you want to create 100 VMs, they all need a distinct computerName property, you pass computerNames for each VM in batch in this array), service will merge baseProfile with VM specific overrides and create a merged VMProfile. ,
Required: False ,
}
[
object ,
]
,
resourceCount:
{
Description: Number of VMs to be created ,
Format: int32 ,
Required: True ,
}
integer ,
resourcePrefix:
{
Description: if resourceOverrides doesn't contain "name", service will create name based of prefix and ResourceCount e.g. resourceprefix-0,resourceprefix-1.. ,
Required: False ,
}
string ,
}
,
executionParameters:
{
Description: The execution parameters for the request ,
Required: True ,
}
{
optimizationPreference:
{
Description: Details that could optimize the user's request ,
Enum:
{
Cost: Optimize while considering cost savings ,
Availability: Optimize while considering availability of resources ,
CostAvailabilityBalanced: Optimize while considering a balance of cost and availability ,
}
,
Required: False ,
}
enum ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
correlationid:
{
Description: CorrelationId item ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
description:
{
Description: The description of the operation response ,
Required: True ,
}
string ,
type:
{
Description: The type of resources used in the create request eg virtual machines ,
Required: True ,
}
string ,
location:
{
Description: The location of the start request eg westus ,
Required: True ,
}
string ,
results:
{
Description: The results from the start request if no errors exist ,
Required: False ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
Unknown: The default value for this enum type ,
Start: Start operations on the resources ,
Deallocate: Deallocate operations on the resources ,
Hibernate: Hibernate operations on the resources ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
Unknown: The default value for the operation state enum ,
PendingScheduling: Operations that are pending scheduling ,
Scheduled: Operations that have been scheduled ,
PendingExecution: Operations that are waiting to be executed ,
Executing: Operations that are in the process of being executed ,
Succeeded: Operations that suceeded ,
Failed: Operations that have failed ,
Cancelled: Operations that have been Cancelled by the user ,
Blocked: Operations that are blocked ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
description:
{
Description: The description of the operation response ,
Required: True ,
}
string ,
type:
{
Description: The type of resources used in the deallocate request eg virtual machines ,
Required: True ,
}
string ,
location:
{
Description: The location of the deallocate request eg westus ,
Required: True ,
}
string ,
results:
{
Description: The results from the deallocate request if no errors exist ,
Required: False ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
Unknown: The default value for this enum type ,
Start: Start operations on the resources ,
Deallocate: Deallocate operations on the resources ,
Hibernate: Hibernate operations on the resources ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
Unknown: The default value for the operation state enum ,
PendingScheduling: Operations that are pending scheduling ,
Scheduled: Operations that have been scheduled ,
PendingExecution: Operations that are waiting to be executed ,
Executing: Operations that are in the process of being executed ,
Succeeded: Operations that suceeded ,
Failed: Operations that have failed ,
Cancelled: Operations that have been Cancelled by the user ,
Blocked: Operations that are blocked ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
description:
{
Description: The description of the operation response ,
Required: True ,
}
string ,
type:
{
Description: The type of resources used in the delete request eg virtual machines ,
Required: True ,
}
string ,
location:
{
Description: The location of the start request eg westus ,
Required: True ,
}
string ,
results:
{
Description: The results from the start request if no errors exist ,
Required: False ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
Unknown: The default value for this enum type ,
Start: Start operations on the resources ,
Deallocate: Deallocate operations on the resources ,
Hibernate: Hibernate operations on the resources ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
Unknown: The default value for the operation state enum ,
PendingScheduling: Operations that are pending scheduling ,
Scheduled: Operations that have been scheduled ,
PendingExecution: Operations that are waiting to be executed ,
Executing: Operations that are in the process of being executed ,
Succeeded: Operations that suceeded ,
Failed: Operations that have failed ,
Cancelled: Operations that have been Cancelled by the user ,
Blocked: Operations that are blocked ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
description:
{
Description: The description of the operation response ,
Required: True ,
}
string ,
type:
{
Description: The type of resources used in the Hibernate request eg virtual machines ,
Required: True ,
}
string ,
location:
{
Description: The location of the Hibernate request eg westus ,
Required: True ,
}
string ,
results:
{
Description: The results from the Hibernate request if no errors exist ,
Required: False ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
Unknown: The default value for this enum type ,
Start: Start operations on the resources ,
Deallocate: Deallocate operations on the resources ,
Hibernate: Hibernate operations on the resources ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
Unknown: The default value for the operation state enum ,
PendingScheduling: Operations that are pending scheduling ,
Scheduled: Operations that have been scheduled ,
PendingExecution: Operations that are waiting to be executed ,
Executing: Operations that are in the process of being executed ,
Succeeded: Operations that suceeded ,
Failed: Operations that have failed ,
Cancelled: Operations that have been Cancelled by the user ,
Blocked: Operations that are blocked ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
description:
{
Description: The description of the operation response ,
Required: True ,
}
string ,
type:
{
Description: The type of resources used in the start request eg virtual machines ,
Required: True ,
}
string ,
location:
{
Description: The location of the start request eg westus ,
Required: True ,
}
string ,
results:
{
Description: The results from the start request if no errors exist ,
Required: False ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
Unknown: The default value for this enum type ,
Start: Start operations on the resources ,
Deallocate: Deallocate operations on the resources ,
Hibernate: Hibernate operations on the resources ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
Unknown: The default value for the operation state enum ,
PendingScheduling: Operations that are pending scheduling ,
Scheduled: Operations that have been scheduled ,
PendingExecution: Operations that are waiting to be executed ,
Executing: Operations that are in the process of being executed ,
Succeeded: Operations that suceeded ,
Failed: Operations that have failed ,
Cancelled: Operations that have been Cancelled by the user ,
Blocked: Operations that are blocked ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
results:
{
Description: An array of resource operations based on their operation ids ,
Required: True ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
Unknown: The default value for this enum type ,
Start: Start operations on the resources ,
Deallocate: Deallocate operations on the resources ,
Hibernate: Hibernate operations on the resources ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
Unknown: The default value for the operation state enum ,
PendingScheduling: Operations that are pending scheduling ,
Scheduled: Operations that have been scheduled ,
PendingExecution: Operations that are waiting to be executed ,
Executing: Operations that are in the process of being executed ,
Succeeded: Operations that suceeded ,
Failed: Operations that have failed ,
Cancelled: Operations that have been Cancelled by the user ,
Blocked: Operations that are blocked ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
description:
{
Description: The description of the operation response ,
Required: True ,
}
string ,
type:
{
Description: The type of resources used in the deallocate request eg virtual machines ,
Required: True ,
}
string ,
location:
{
Description: The location of the deallocate request eg westus ,
Required: True ,
}
string ,
results:
{
Description: The results from the deallocate request if no errors exist ,
Required: False ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
Unknown: The default value for this enum type ,
Start: Start operations on the resources ,
Deallocate: Deallocate operations on the resources ,
Hibernate: Hibernate operations on the resources ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
Unknown: The default value for the operation state enum ,
PendingScheduling: Operations that are pending scheduling ,
Scheduled: Operations that have been scheduled ,
PendingExecution: Operations that are waiting to be executed ,
Executing: Operations that are in the process of being executed ,
Succeeded: Operations that suceeded ,
Failed: Operations that have failed ,
Cancelled: Operations that have been Cancelled by the user ,
Blocked: Operations that are blocked ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
description:
{
Description: The description of the operation response ,
Required: True ,
}
string ,
type:
{
Description: The type of resources used in the Hibernate request eg virtual machines ,
Required: True ,
}
string ,
location:
{
Description: The location of the Hibernate request eg westus ,
Required: True ,
}
string ,
results:
{
Description: The results from the Hibernate request if no errors exist ,
Required: False ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
Unknown: The default value for this enum type ,
Start: Start operations on the resources ,
Deallocate: Deallocate operations on the resources ,
Hibernate: Hibernate operations on the resources ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
Unknown: The default value for the operation state enum ,
PendingScheduling: Operations that are pending scheduling ,
Scheduled: Operations that have been scheduled ,
PendingExecution: Operations that are waiting to be executed ,
Executing: Operations that are in the process of being executed ,
Succeeded: Operations that suceeded ,
Failed: Operations that have failed ,
Cancelled: Operations that have been Cancelled by the user ,
Blocked: Operations that are blocked ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
description:
{
Description: The description of the operation response ,
Required: True ,
}
string ,
type:
{
Description: The type of resources used in the start request eg virtual machines ,
Required: True ,
}
string ,
location:
{
Description: The location of the start request eg westus ,
Required: True ,
}
string ,
results:
{
Description: The results from the start request if no errors exist ,
Required: False ,
}
[
{
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
errorCode:
{
Description: Resource level error code if it exists ,
Required: False ,
}
string ,
errorDetails:
{
Description: Resource level error details if they exist ,
Required: False ,
}
string ,
operation:
{
Description: Details of the operation performed on a resource ,
Required: False ,
}
{
operationId:
{
Description: Operation identifier for the unique operation ,
Required: True ,
}
string ,
resourceId:
{
Description: Unique identifier for the resource involved in the operation, eg ArmId ,
Format: arm-id ,
Required: False ,
}
string ,
opType:
{
Description: Type of operation performed on the resources ,
Enum:
{
Unknown: The default value for this enum type ,
Start: Start operations on the resources ,
Deallocate: Deallocate operations on the resources ,
Hibernate: Hibernate operations on the resources ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: Subscription id attached to the request ,
Required: False ,
}
string ,
deadline:
{
Description: Deadline for the operation ,
Format: date-time ,
Required: False ,
}
string ,
deadlineType:
{
Description: Type of deadline of the operation ,
Enum:
{
Unknown: Default value of Unknown. ,
InitiateAt: Initiate the operation at the given deadline. ,
CompleteBy: Complete the operation by the given deadline. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Current state of the operation ,
Enum:
{
Unknown: The default value for the operation state enum ,
PendingScheduling: Operations that are pending scheduling ,
Scheduled: Operations that have been scheduled ,
PendingExecution: Operations that are waiting to be executed ,
Executing: Operations that are in the process of being executed ,
Succeeded: Operations that suceeded ,
Failed: Operations that have failed ,
Cancelled: Operations that have been Cancelled by the user ,
Blocked: Operations that are blocked ,
}
,
Required: False ,
}
enum ,
timezone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone for the operation ,
Required: False ,
}
string ,
resourceOperationError:
{
Description: Operation level errors if they exist ,
Required: False ,
}
{
errorCode:
{
Description: Code for the error eg 404, 500 ,
Required: True ,
}
string ,
errorDetails:
{
Description: Detailed message about the error ,
Required: True ,
}
string ,
}
,
completedAt:
{
Description: Time the operation was complete if errors are null ,
Format: date-time ,
Required: False ,
}
string ,
retryPolicy:
{
Description: Retry policy the user can pass ,
Required: False ,
}
{
retryCount:
{
Description: Retry count for user request ,
Format: int32 ,
Required: False ,
}
integer ,
retryWindowInMinutes:
{
Description: Retry window in minutes for user request ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScheduledActions_ListBySubscription (new)
Description :  List ScheduledAction resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ComputeSchedule/scheduledActions
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The ScheduledAction items on this page ,
Required: True ,
}
[
{
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScheduledActions_ListByResourceGroup (new)
Description :  List ScheduledAction resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ComputeSchedule/scheduledActions
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The ScheduledAction items on this page ,
Required: True ,
}
[
{
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScheduledActions_Get (new)
Description :  Get a ScheduledAction
Reference :  Link ¶

⚼ Request

GET:  /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 ,
}

⚐ 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 ,
}
,
]
,
}
,
}
ScheduledActions_CreateOrUpdate (new)
Description :  Create a ScheduledAction
Reference :  Link ¶

⚼ Request

PUT:  /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 ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
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 (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 (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The scheduled action resource ,
}
{
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 ,
}
,
]
,
}
,
}
ScheduledActions_Update (new)
Description :  Update a ScheduledAction
Reference :  Link ¶

⚼ 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 ,
}
{
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 ,
}
,
]
,
}
,
}
ScheduledActions_Delete (new)
Description :  Delete a ScheduledAction
Reference :  Link ¶

⚼ Request

DELETE:  /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 ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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_AttachResources (new)
Description :  A synchronous resource action.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ComputeSchedule/scheduledActions/{scheduledActionName}/attachResources
{
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 ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
resources:
{
Description: List of resources to be attached/patched ,
Required: True ,
}
[
{
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
id:
{
Description: The compute RP resource id of the resource in the scheduled actions scope. ,
Format: arm-id ,
Required: True ,
}
string ,
type:
{
Description: The type of resource ,
Required: False ,
}
string ,
resourceId:
{
Description: The ARM Id of the resource. "subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/virtualMachines/{vmName}" ,
Format: arm-id ,
Required: True ,
}
string ,
notificationSettings:
{
Description: The desired notification settings for the specified resource. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (200)

{
totalResources:
{
Description: The total number of resources operated on ,
Format: int32 ,
Required: True ,
}
integer ,
resourcesStatuses:
{
Description: The resource status of for each resource ,
Required: True ,
}
[
{
resourceId:
{
Description: The arm identifier of the resource ,
Format: arm-id ,
Required: True ,
}
string ,
status:
{
Description: The state the resource is currently on ,
Enum:
{
Succeeded: The resource operation was successful ,
Failed: The resource operation has failed. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Errors encountered while trying to perform ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
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_CancelNextOccurrence (new)
Description :  A synchronous resource action.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ComputeSchedule/scheduledActions/{scheduledActionName}/cancelNextOccurrence
{
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 ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
resourceIds:
{
Description: The resources the cancellation should act on. If no resource is passed in the list, Scheduled Action will cancel the occurrence for all resources. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
totalResources:
{
Description: The total number of resources operated on ,
Format: int32 ,
Required: True ,
}
integer ,
resourcesStatuses:
{
Description: The resource status of for each resource ,
Required: True ,
}
[
{
resourceId:
{
Description: The arm identifier of the resource ,
Format: arm-id ,
Required: True ,
}
string ,
status:
{
Description: The state the resource is currently on ,
Enum:
{
Succeeded: The resource operation was successful ,
Failed: The resource operation has failed. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Errors encountered while trying to perform ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
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_DetachResources (new)
Description :  A synchronous resource action.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ComputeSchedule/scheduledActions/{scheduledActionName}/detachResources
{
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 ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
resources:
{
Description: List of resources to be detached ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
totalResources:
{
Description: The total number of resources operated on ,
Format: int32 ,
Required: True ,
}
integer ,
resourcesStatuses:
{
Description: The resource status of for each resource ,
Required: True ,
}
[
{
resourceId:
{
Description: The arm identifier of the resource ,
Format: arm-id ,
Required: True ,
}
string ,
status:
{
Description: The state the resource is currently on ,
Enum:
{
Succeeded: The resource operation was successful ,
Failed: The resource operation has failed. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Errors encountered while trying to perform ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
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_Disable (new)
Description :  A synchronous resource action.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ComputeSchedule/scheduledActions/{scheduledActionName}/disable
{
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 ,
}

⚐ Response (200)

{}

⚐ 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_Enable (new)
Description :  A synchronous resource action.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ComputeSchedule/scheduledActions/{scheduledActionName}/enable
{
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 ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Occurrences_ListByScheduledAction (new)
Description :  List Occurrence resources by ScheduledAction
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ComputeSchedule/scheduledActions/{scheduledActionName}/occurrences
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Occurrence items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
scheduledTime:
{
Description: The time the occurrence is scheduled for. This value can be changed by calling the delay API ,
Format: date-time ,
Required: True ,
}
string ,
resultSummary:
{
Description: The result for occurrences that achieved a terminal state ,
Required: True ,
}
{
total:
{
Description: The total number of resources that the occurrence was supposed to act on. ,
Format: int32 ,
Required: True ,
}
integer ,
statuses:
{
Description: The summarized status of the resources. ,
Required: True ,
}
[
{
code:
{
Description: The error code for those resources. In case of success, code is populated with Success. ,
Required: True ,
}
string ,
count:
{
Description: The number of resources that the code applies to. ,
Format: int32 ,
Required: True ,
}
integer ,
errorDetails:
{
Description: The error details for the resources. Not populated on success cases. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The aggregated provisioning state of the occurrence ,
Enum:
{
Created: The occurrence was created ,
Rescheduling: The occurrence is being rescheduled ,
Scheduled: The occurrence has been scheduled ,
Succeeded: The occurrence has successfully ran ,
Failed: The occurrence has failed during its scheduling ,
Cancelling: The occurrence is going through cancellation ,
Canceled: The occurrence has been canceled ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Occurrences_Get (new)
Description :  Get a Occurrence
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ComputeSchedule/scheduledActions/{scheduledActionName}/occurrences/{occurrenceId}
{
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 ,
occurrenceId:
{
Description: The name of the Occurrence ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
scheduledTime:
{
Description: The time the occurrence is scheduled for. This value can be changed by calling the delay API ,
Format: date-time ,
Required: True ,
}
string ,
resultSummary:
{
Description: The result for occurrences that achieved a terminal state ,
Required: True ,
}
{
total:
{
Description: The total number of resources that the occurrence was supposed to act on. ,
Format: int32 ,
Required: True ,
}
integer ,
statuses:
{
Description: The summarized status of the resources. ,
Required: True ,
}
[
{
code:
{
Description: The error code for those resources. In case of success, code is populated with Success. ,
Required: True ,
}
string ,
count:
{
Description: The number of resources that the code applies to. ,
Format: int32 ,
Required: True ,
}
integer ,
errorDetails:
{
Description: The error details for the resources. Not populated on success cases. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The aggregated provisioning state of the occurrence ,
Enum:
{
Created: The occurrence was created ,
Rescheduling: The occurrence is being rescheduled ,
Scheduled: The occurrence has been scheduled ,
Succeeded: The occurrence has successfully ran ,
Failed: The occurrence has failed during its scheduling ,
Cancelling: The occurrence is going through cancellation ,
Canceled: The occurrence has been canceled ,
}
,
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 ,
}
,
]
,
}
,
}
Occurrences_Cancel (new)
Description :  A synchronous resource action.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ComputeSchedule/scheduledActions/{scheduledActionName}/occurrences/{occurrenceId}/cancel
{
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 ,
occurrenceId:
{
Description: The name of the Occurrence ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
resourceIds:
{
Description: The resources the cancellation should act on. If no resource is passed in the list, Scheduled Action will cancel the occurrence for all resources. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
totalResources:
{
Description: The total number of resources operated on ,
Format: int32 ,
Required: True ,
}
integer ,
resourcesStatuses:
{
Description: The resource status of for each resource ,
Required: True ,
}
[
{
resourceId:
{
Description: The arm identifier of the resource ,
Format: arm-id ,
Required: True ,
}
string ,
status:
{
Description: The state the resource is currently on ,
Enum:
{
Succeeded: The resource operation was successful ,
Failed: The resource operation has failed. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Errors encountered while trying to perform ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
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 ,
}
,
]
,
}
,
}
Occurrences_Delay (new)
Description :  A long-running resource action.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ComputeSchedule/scheduledActions/{scheduledActionName}/occurrences/{occurrenceId}/delay
{
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 ,
occurrenceId:
{
Description: The name of the Occurrence ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
delay:
{
Description: The exact time to delay the operations to ,
Format: date-time ,
Required: True ,
}
string ,
resourceIds:
{
Description: The resources that should be delayed. If empty, the delay will apply to the all resources in the occurrence. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
totalResources:
{
Description: The total number of resources operated on ,
Format: int32 ,
Required: True ,
}
integer ,
resourcesStatuses:
{
Description: The resource status of for each resource ,
Required: True ,
}
[
{
resourceId:
{
Description: The arm identifier of the resource ,
Format: arm-id ,
Required: True ,
}
string ,
status:
{
Description: The state the resource is currently on ,
Enum:
{
Succeeded: The resource operation was successful ,
Failed: The resource operation has failed. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Errors encountered while trying to perform ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
Occurrences_ListResources (new)
Description :  List resources attached to Scheduled Actions for the given occurrence
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ComputeSchedule/scheduledActions/{scheduledActionName}/occurrences/{occurrenceId}/resources
{
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 ,
occurrenceId:
{
Description: The name of the Occurrence ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The OccurrenceResource items on this page ,
Required: True ,
}
[
{
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
id:
{
Description: The compute RP resource id of the resource in the scheduled actions scope. ,
Format: arm-id ,
Required: True ,
}
string ,
type:
{
Description: The type of resource ,
Required: False ,
}
string ,
resourceId:
{
Description: The ARM Id of the resource. "subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/virtualMachines/{vmName}" ,
Format: arm-id ,
Required: True ,
}
string ,
notificationSettings:
{
Description: The desired notification settings for the specified resource. ,
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 ,
}
,
]
,
scheduledTime:
{
Description: The time the occurrence is scheduled for the resource. ,
Format: date-time ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for the resource. Only populated if resource is in failed state. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScheduledActions_PatchResources (new)
Description :  A synchronous resource action.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ComputeSchedule/scheduledActions/{scheduledActionName}/patchResources
{
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 ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
resources:
{
Description: The list of resources we watch to patch ,
Required: True ,
}
[
{
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
id:
{
Description: The compute RP resource id of the resource in the scheduled actions scope. ,
Format: arm-id ,
Required: True ,
}
string ,
type:
{
Description: The type of resource ,
Required: False ,
}
string ,
resourceId:
{
Description: The ARM Id of the resource. "subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/virtualMachines/{vmName}" ,
Format: arm-id ,
Required: True ,
}
string ,
notificationSettings:
{
Description: The desired notification settings for the specified resource. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (200)

{
totalResources:
{
Description: The total number of resources operated on ,
Format: int32 ,
Required: True ,
}
integer ,
resourcesStatuses:
{
Description: The resource status of for each resource ,
Required: True ,
}
[
{
resourceId:
{
Description: The arm identifier of the resource ,
Format: arm-id ,
Required: True ,
}
string ,
status:
{
Description: The state the resource is currently on ,
Enum:
{
Succeeded: The resource operation was successful ,
Failed: The resource operation has failed. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Errors encountered while trying to perform ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
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_ListResources (new)
Description :  List resources attached to Scheduled Actions
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ComputeSchedule/scheduledActions/{scheduledActionName}/resources
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The ScheduledActionResource items on this page ,
Required: True ,
}
[
{
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
id:
{
Description: The compute RP resource id of the resource in the scheduled actions scope. ,
Format: arm-id ,
Required: True ,
}
string ,
type:
{
Description: The type of resource ,
Required: False ,
}
string ,
resourceId:
{
Description: The ARM Id of the resource. "subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/virtualMachines/{vmName}" ,
Format: arm-id ,
Required: True ,
}
string ,
notificationSettings:
{
Description: The desired notification settings for the specified resource. ,
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 ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScheduledActions_TriggerManualOccurrence (new)
Description :  A synchronous resource action.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ComputeSchedule/scheduledActions/{scheduledActionName}/triggerManualOccurrence
{
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 ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
scheduledTime:
{
Description: The time the occurrence is scheduled for. This value can be changed by calling the delay API ,
Format: date-time ,
Required: True ,
}
string ,
resultSummary:
{
Description: The result for occurrences that achieved a terminal state ,
Required: True ,
}
{
total:
{
Description: The total number of resources that the occurrence was supposed to act on. ,
Format: int32 ,
Required: True ,
}
integer ,
statuses:
{
Description: The summarized status of the resources. ,
Required: True ,
}
[
{
code:
{
Description: The error code for those resources. In case of success, code is populated with Success. ,
Required: True ,
}
string ,
count:
{
Description: The number of resources that the code applies to. ,
Format: int32 ,
Required: True ,
}
integer ,
errorDetails:
{
Description: The error details for the resources. Not populated on success cases. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The aggregated provisioning state of the occurrence ,
Enum:
{
Created: The occurrence was created ,
Rescheduling: The occurrence is being rescheduled ,
Scheduled: The occurrence has been scheduled ,
Succeeded: The occurrence has successfully ran ,
Failed: The occurrence has failed during its scheduling ,
Cancelling: The occurrence is going through cancellation ,
Canceled: The occurrence has been canceled ,
}
,
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 ,
}
,
]
,
}
,
}