schedules

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

Overview

Name	schedules
Type	Resource
Id	azure_extras.lab_services.schedules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
notes	string	Notes for this schedule.
provisioningState	string	Current provisioning state of the schedule. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Locked".
recurrencePattern	object	The recurrence pattern of the scheduled actions.
startAt	string (date-time)	When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead.
stopAt	string (date-time)	When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead.
systemData	object	Metadata pertaining to creation and last modification of the schedule.
timeZoneId	string	The IANA timezone id for the schedule.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_lab

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
notes	string	Notes for this schedule.
provisioningState	string	Current provisioning state of the schedule. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Locked".
recurrencePattern	object	The recurrence pattern of the scheduled actions.
startAt	string (date-time)	When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead.
stopAt	string (date-time)	When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead.
systemData	object	Metadata pertaining to creation and last modification of the schedule.
timeZoneId	string	The IANA timezone id for the schedule.
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, lab_name, schedule_name, subscription_id		Get a lab Schedule. Returns the properties of a lab Schedule.
list_by_lab	select	resource_group_name, lab_name, subscription_id	$filter	Get all schedules for a lab. Returns a list of all schedules for a lab.
create_or_update	insert	resource_group_name, lab_name, schedule_name, subscription_id		Create or update a lab schedule. Operation to create or update a lab schedule.
update	update	resource_group_name, lab_name, schedule_name, subscription_id		Update a lab schedule. Operation to update a lab schedule.
create_or_update	replace	resource_group_name, lab_name, schedule_name, subscription_id		Create or update a lab schedule. Operation to create or update a lab schedule.
delete	delete	resource_group_name, lab_name, schedule_name, subscription_id		Deletes a schedule resource. Operation to delete a schedule resource.

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
lab_name	string	The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. 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 within containing lab. Used in resource URIs. Required.
subscription_id	string
$filter	string	The filter to apply to the operation. Default value is None.

SELECT examples

get

Get a lab Schedule. Returns the properties of a lab Schedule.

SELECT
id,
name,
notes,
provisioningState,
recurrencePattern,
startAt,
stopAt,
systemData,
timeZoneId,
type
FROM azure_extras.lab_services.schedules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_name }}' -- required
AND schedule_name = '{{ schedule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_lab

Get all schedules for a lab. Returns a list of all schedules for a lab.

SELECT
id,
name,
notes,
provisioningState,
recurrencePattern,
startAt,
stopAt,
systemData,
timeZoneId,
type
FROM azure_extras.lab_services.schedules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Create or update a lab schedule. Operation to create or update a lab schedule.

INSERT INTO azure_extras.lab_services.schedules (
properties,
resource_group_name,
lab_name,
schedule_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ lab_name }}',
'{{ schedule_name }}',
'{{ subscription_id }}'
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: lab_name
    value: "{{ lab_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:
      startAt: "{{ startAt }}"
      stopAt: "{{ stopAt }}"
      recurrencePattern:
        frequency: "{{ frequency }}"
        weekDays:
          - "{{ weekDays }}"
        interval: {{ interval }}
        expirationDate: "{{ expirationDate }}"
      timeZoneId: "{{ timeZoneId }}"
      notes: "{{ notes }}"

UPDATE examples

update

Update a lab schedule. Operation to update a lab schedule.

UPDATE azure_extras.lab_services.schedules
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND schedule_name = '{{ schedule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create or update a lab schedule. Operation to create or update a lab schedule.

REPLACE azure_extras.lab_services.schedules
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND schedule_name = '{{ schedule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a schedule resource. Operation to delete a schedule resource.

DELETE FROM azure_extras.lab_services.schedules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND schedule_name = '{{ schedule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;