schedules

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

Overview

Name	schedules
Type	Resource
Id	azure.ai_evaluation.schedules

Fields

The following fields are returned by SELECT queries:

get_run

Name	Datatype	Description
id	string	Identifier of the schedule run. Required.
error	string	Error information for the schedule run.
properties	object	Properties of the schedule run. Required.
scheduleId	string	Identifier of the schedule. Required.
success	boolean	Trigger success status of the schedule run. Required.
triggerTime	string	Trigger time of the schedule run.

get

Name	Datatype	Description
id	string	Identifier of the schedule. Required.
description	string	Description of the schedule.
displayName	string	Name of the schedule.
enabled	boolean	Enabled status of the schedule. Required.
properties	object	Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.
provisioningStatus	string	Provisioning status of the schedule. Known values are: "Creating", "Updating", "Deleting", "Succeeded", and "Failed". (Creating, Updating, Deleting, Succeeded, Failed)
systemData	object	System metadata for the resource. Required.
tags	object	Schedule's tags. Unlike properties, tags are fully mutable.
task	object	Task for the schedule. Required.
trigger	object	Trigger for the schedule. Required.

list_runs

Name	Datatype	Description
id	string	Identifier of the schedule run. Required.
error	string	Error information for the schedule run.
properties	object	Properties of the schedule run. Required.
scheduleId	string	Identifier of the schedule. Required.
success	boolean	Trigger success status of the schedule run. Required.
triggerTime	string	Trigger time of the schedule run.

list

Name	Datatype	Description
id	string	Identifier of the schedule. Required.
description	string	Description of the schedule.
displayName	string	Name of the schedule.
enabled	boolean	Enabled status of the schedule. Required.
properties	object	Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.
provisioningStatus	string	Provisioning status of the schedule. Known values are: "Creating", "Updating", "Deleting", "Succeeded", and "Failed". (Creating, Updating, Deleting, Succeeded, Failed)
systemData	object	System metadata for the resource. Required.
tags	object	Schedule's tags. Unlike properties, tags are fully mutable.
task	object	Task for the schedule. Required.
trigger	object	Trigger for the schedule. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_run	select	schedule_id, run_id, endpoint		Get a schedule run by id.
get	select	id, endpoint		Get a schedule by id.
list_runs	select	schedule_id, endpoint		List all schedule runs.
list	select	endpoint		List all schedules.
create_or_update	insert	id, endpoint, enabled, trigger, task		Create or update a schedule by id.
create_or_update	replace	id, endpoint, enabled, trigger, task		Create or update a schedule by id.
delete	delete	id, endpoint		Delete a schedule.

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: )
id	string	Identifier of the schedule. Required.
run_id	string	Identifier of the schedule run. Required.
schedule_id	string	Identifier of the schedule. Required.

SELECT examples

get_run

Get a schedule run by id.

SELECT
id,
error,
properties,
scheduleId,
success,
triggerTime
FROM azure.ai_evaluation.schedules
WHERE schedule_id = '{{ schedule_id }}' -- required
AND run_id = '{{ run_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

get

Get a schedule by id.

SELECT
id,
description,
displayName,
enabled,
properties,
provisioningStatus,
systemData,
tags,
task,
trigger
FROM azure.ai_evaluation.schedules
WHERE id = '{{ id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_runs

List all schedule runs.

SELECT
id,
error,
properties,
scheduleId,
success,
triggerTime
FROM azure.ai_evaluation.schedules
WHERE schedule_id = '{{ schedule_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

List all schedules.

SELECT
id,
description,
displayName,
enabled,
properties,
provisioningStatus,
systemData,
tags,
task,
trigger
FROM azure.ai_evaluation.schedules
WHERE endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create_or_update

Create or update a schedule by id.

INSERT INTO azure.ai_evaluation.schedules (
displayName,
description,
enabled,
trigger,
task,
tags,
properties,
id,
endpoint
)
SELECT 
'{{ displayName }}',
'{{ description }}',
{{ enabled }} /* required */,
'{{ trigger }}' /* required */,
'{{ task }}' /* required */,
'{{ tags }}',
'{{ properties }}',
'{{ id }}',
'{{ endpoint }}'
RETURNING
id,
description,
displayName,
enabled,
properties,
provisioningStatus,
systemData,
tags,
task,
trigger
;

Manifest

# Description fields are for documentation purposes
- name: schedules
props:
  - name: id
    value: "{{ id }}"
    description: Required parameter for the schedules resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the schedules resource.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Name of the schedule.
  - name: description
    value: "{{ description }}"
    description: |
      Description of the schedule.
  - name: enabled
    value: {{ enabled }}
    description: |
      Enabled status of the schedule. Required.
  - name: trigger
    description: |
      Trigger for the schedule. Required.
    value:
      type: "{{ type }}"
  - name: task
    description: |
      Task for the schedule. Required.
    value:
      type: "{{ type }}"
      configuration: "{{ configuration }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Schedule's tags. Unlike properties, tags are fully mutable.
  - name: properties
    value: "{{ properties }}"
    description: |
      Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.

REPLACE examples

create_or_update

Create or update a schedule by id.

REPLACE azure.ai_evaluation.schedules
SET 
displayName = '{{ displayName }}',
description = '{{ description }}',
enabled = {{ enabled }},
trigger = '{{ trigger }}',
task = '{{ task }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
id = '{{ id }}' --required
AND endpoint = '{{ endpoint }}' --required
AND enabled = {{ enabled }} --required
AND trigger = '{{ trigger }}' --required
AND task = '{{ task }}' --required
RETURNING
id,
description,
displayName,
enabled,
properties,
provisioningStatus,
systemData,
tags,
task,
trigger;

DELETE examples

delete

Delete a schedule.

DELETE FROM azure.ai_evaluation.schedules
WHERE id = '{{ id }}' --required
AND endpoint = '{{ endpoint }}' --required
;