Dev Boxes - Get Schedule By Pool

Service:

Dev Center

API Version:

2025-02-01

Gets a schedule.

GET {endpoint}/projects/{projectName}/pools/{poolName}/schedules/{scheduleName}?api-version=2025-02-01

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string uri	The DevCenter-specific URI to operate on.
poolName	path	True	string	Pool name. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$
projectName	path	True	string	Name of the project. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$
scheduleName	path	True	string	Display name for the Schedule. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	Schedule	The request has succeeded.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://devcenter.azure.com/.default

Examples

Gets a schedule.

Sample request

HTTP

GET https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default?api-version=2025-02-01

Sample response

Status code:

200

{
  "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default",
  "name": "default",
  "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool",
  "sourceType": "Pool",
  "type": "StopDevBox",
  "timeZone": "America/Los_Angeles",
  "frequency": "Daily",
  "time": "17:30"
}

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Schedule	A Schedule to execute action.
ScheduledFrequency	The frequency of task execution.
ScheduledType	The supported types for a scheduled task.
ScheduleSourceType	The type of the resource that this schedule belongs to.

Azure.Core.Foundations.Error

Object

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

Object

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.

Schedule

Object

A Schedule to execute action.

Name	Type	Description
frequency	ScheduledFrequency	The frequency of this scheduled task.
name	string	Display name for the Schedule.
sourceType	ScheduleSourceType	The type of the resource that this schedule belongs to.
sourceUri	string	The URI of the resource that this schedule belongs to.
time	string	The target time to trigger the action. The format is HH:MM.
timeZone	string	The IANA timezone id at which the schedule should execute.
type	ScheduledType	Supported type this scheduled task represents.
uri	string	The unique URI of the schedule.

ScheduledFrequency

Enumeration

The frequency of task execution.

Value	Description
Daily	The scheduled task will run every day.

ScheduledType

Enumeration

The supported types for a scheduled task.

Value	Description
StopDevBox	The scheduled task will stop impacted Dev Boxes.

ScheduleSourceType

Enumeration

The type of the resource that this schedule belongs to.

Value	Description
Pool	The schedule source is a Dev Box pool.