schedules

Creates, updates, deletes, gets or lists a schedules resource.

Overview

Name	schedules
Type	Resource
Id	azure.developer_devcenter.schedules

Fields

The following fields are returned by SELECT queries:

get_schedule

Name	Datatype	Description
name	string	Display name for the Schedule. Required.
frequency	string	The frequency of this scheduled task. Required. "Daily" (Daily)
time	string	The target time to trigger the action. The format is HH:MM. Required.
timeZone	string	The IANA timezone id at which the schedule should execute. Required.
type	string	Supported type this scheduled task represents. Required. "StopDevBox" (StopDevBox)

list_schedules

Name	Datatype	Description
name	string	Display name for the Schedule. Required.
frequency	string	The frequency of this scheduled task. Required. "Daily" (Daily)
time	string	The target time to trigger the action. The format is HH:MM. Required.
timeZone	string	The IANA timezone id at which the schedule should execute. Required.
type	string	Supported type this scheduled task represents. Required. "StopDevBox" (StopDevBox)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_schedule	select	project_name, pool_name, schedule_name, endpoint		Gets a schedule.
list_schedules	select	project_name, pool_name, endpoint		Lists all schedules within a pool that are configured by your project administrator.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
pool_name	string	The name of a pool of Dev Boxes. Required.
project_name	string	The DevCenter Project upon which to execute operations. Required.
schedule_name	string	Display name for the Schedule. Required.

SELECT examples

get_schedule

Gets a schedule.

SELECT
name,
frequency,
time,
timeZone,
type
FROM azure.developer_devcenter.schedules
WHERE project_name = '{{ project_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND schedule_name = '{{ schedule_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_schedules

Lists all schedules within a pool that are configured by your project administrator.

SELECT
name,
frequency,
time,
timeZone,
type
FROM azure.developer_devcenter.schedules
WHERE project_name = '{{ project_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;