schedules

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

Overview

Name	schedules
Type	Resource
Id	azure.devcenter.schedules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
frequency	string	The frequency of this scheduled task. "Daily"
location	string	The geo-location where the resource lives.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
state	string	Indicates whether or not this scheduled task is enabled. Known values are: "Enabled" and "Disabled".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_pool

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
frequency	string	The frequency of this scheduled task. "Daily"
location	string	The geo-location where the resource lives.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
state	string	Indicates whether or not this scheduled task is enabled. Known values are: "Enabled" and "Disabled".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, project_name, pool_name, schedule_name, subscription_id	$top	Gets a schedule resource.
list_by_pool	select	resource_group_name, project_name, pool_name, subscription_id	$top	Lists schedules for a pool.
create_or_update	insert	resource_group_name, project_name, pool_name, schedule_name, subscription_id	$top	Creates or updates a Schedule.
update	update	resource_group_name, project_name, pool_name, schedule_name, subscription_id	$top	Partially updates a Scheduled.
create_or_update	replace	resource_group_name, project_name, pool_name, schedule_name, subscription_id	$top	Creates or updates a Schedule.
delete	delete	resource_group_name, project_name, pool_name, schedule_name, subscription_id	$top	Deletes a Scheduled.

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
pool_name	string	Name of the pool. Required.
project_name	string	The name of the project. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
schedule_name	string	The name of the schedule that uniquely identifies it. Required.
subscription_id	string
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Gets a schedule resource.

SELECT
id,
name,
frequency,
location,
provisioningState,
state,
systemData,
tags,
time,
timeZone,
type
FROM azure.devcenter.schedules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND schedule_name = '{{ schedule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

list_by_pool

Lists schedules for a pool.

SELECT
id,
name,
frequency,
location,
provisioningState,
state,
systemData,
tags,
time,
timeZone,
type
FROM azure.devcenter.schedules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a Schedule.

INSERT INTO azure.devcenter.schedules (
properties,
resource_group_name,
project_name,
pool_name,
schedule_name,
subscription_id,
$top
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ project_name }}',
'{{ pool_name }}',
'{{ schedule_name }}',
'{{ subscription_id }}',
'{{ $top }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: schedules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the schedules resource.
  - name: project_name
    value: "{{ project_name }}"
    description: Required parameter for the schedules resource.
  - name: pool_name
    value: "{{ pool_name }}"
    description: Required parameter for the schedules resource.
  - name: schedule_name
    value: "{{ schedule_name }}"
    description: Required parameter for the schedules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the schedules resource.
  - name: properties
    value:
      tags: "{{ tags }}"
      location: "{{ location }}"
      type: "{{ type }}"
      frequency: "{{ frequency }}"
      time: "{{ time }}"
      timeZone: "{{ timeZone }}"
      state: "{{ state }}"
  - name: $top
    value: {{ $top }}
    description: The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.
    description: The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

UPDATE examples

update

Partially updates a Scheduled.

UPDATE azure.devcenter.schedules
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND project_name = '{{ project_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND schedule_name = '{{ schedule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND $top = '{{ $top}}'
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Creates or updates a Schedule.

REPLACE azure.devcenter.schedules
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND project_name = '{{ project_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND schedule_name = '{{ schedule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND $top = '{{ $top}}'
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a Scheduled.

DELETE FROM azure.devcenter.schedules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND project_name = '{{ project_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND schedule_name = '{{ schedule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND $top = '{{ $top }}'
;