schedules

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

Overview

Name	schedules
Type	Resource
Id	azure.dev_test_labs.schedules

Fields

vw_schedules

Name	Datatype	Description
id	text	The identifier of the resource.
name	text	The name of the resource.
created_date	text	field from the properties object
daily_recurrence	text	field from the properties object
hourly_recurrence	text	field from the properties object
labName	text	field from the properties object
location	text	The location of the resource.
notification_settings	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
status	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	The tags of the resource.
target_resource_id	text	field from the properties object
task_type	text	field from the properties object
time_zone_id	text	field from the properties object
type	text	The type of the resource.
unique_identifier	text	field from the properties object
weekly_recurrence	text	field from the properties object

schedules

Name	Datatype	Description
id	string	The identifier of the resource.
name	string	The name of the resource.
location	string	The location of the resource.
properties	object	Properties of a schedule.
tags	object	The tags of the resource.
type	string	The type of the resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	labName, name, resourceGroupName, subscriptionId	Get schedule.
list	SELECT	labName, resourceGroupName, subscriptionId	List schedules in a given lab.
create_or_update	INSERT	labName, name, resourceGroupName, subscriptionId, data__properties	Create or replace an existing schedule.
delete	DELETE	labName, name, resourceGroupName, subscriptionId	Delete schedule.
update	UPDATE	labName, name, resourceGroupName, subscriptionId	Allows modifying tags of schedules. All other properties will be ignored.
execute	EXEC	labName, name, resourceGroupName, subscriptionId	Execute a schedule. This operation can take a while to complete.

SELECT examples

List schedules in a given lab.

vw_schedules

SELECT
id,
name,
created_date,
daily_recurrence,
hourly_recurrence,
labName,
location,
notification_settings,
provisioning_state,
resourceGroupName,
status,
subscriptionId,
tags,
target_resource_id,
task_type,
time_zone_id,
type,
unique_identifier,
weekly_recurrence
FROM azure.dev_test_labs.vw_schedules
WHERE labName = '{{ labName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

schedules

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.dev_test_labs.schedules
WHERE labName = '{{ labName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new schedules resource.

All Properties

/*+ create */
INSERT INTO azure.dev_test_labs.schedules (
labName,
name,
resourceGroupName,
subscriptionId,
data__properties,
location,
tags,
properties
)
SELECT 
'{{ labName }}',
'{{ name }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object
    - name: properties
      value:
        - name: status
          value: string
        - name: taskType
          value: string
        - name: weeklyRecurrence
          value:
            - name: weekdays
              value:
                - string
            - name: time
              value: string
        - name: dailyRecurrence
          value:
            - name: time
              value: string
        - name: hourlyRecurrence
          value:
            - name: minute
              value: integer
        - name: timeZoneId
          value: string
        - name: notificationSettings
          value:
            - name: status
              value: string
            - name: timeInMinutes
              value: integer
            - name: webhookUrl
              value: string
            - name: emailRecipient
              value: string
            - name: notificationLocale
              value: string
        - name: createdDate
          value: string
        - name: targetResourceId
          value: string
        - name: provisioningState
          value: string
        - name: uniqueIdentifier
          value: string

UPDATE example

Updates a schedules resource.

/*+ update */
UPDATE azure.dev_test_labs.schedules
SET 
tags = '{{ tags }}'
WHERE 
labName = '{{ labName }}'
AND name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified schedules resource.

/*+ delete */
DELETE FROM azure.dev_test_labs.schedules
WHERE labName = '{{ labName }}'
AND name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';