beta_schedules

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

Overview

Name	beta_schedules
Type	Resource
Id	azure.ai_projects.beta_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 (date-time)	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

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. Retrieves the specified run for a schedule.
get	select	id, endpoint		Get a schedule. Retrieves the specified schedule resource.
list	select	endpoint	type, enabled	List schedules. Returns schedules that match the supplied type and enabled filters.
create_or_update	insert	id, endpoint, enabled, trigger, task		Create or update a schedule. Creates a new schedule or updates an existing schedule with the supplied definition.
create_or_update	replace	id, endpoint, enabled, trigger, task		Create or update a schedule. Creates a new schedule or updates an existing schedule with the supplied definition.
delete	delete	id, endpoint		Delete a schedule. Deletes the specified schedule resource.
list_runs	exec	id, endpoint	type, enabled	List schedule runs. Returns schedule runs that match the supplied filters.

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	The unique identifier of the schedule run. Required.
schedule_id	string	The unique identifier of the schedule. Required.
enabled	boolean	Filter by the enabled status. Default value is None.
type	string	Filter by the type of schedule. Known values are: "Evaluation" and "Insight". Default value is None.

SELECT examples

get_run

Get a schedule run. Retrieves the specified run for a schedule.

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

get

Get a schedule. Retrieves the specified schedule resource.

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

list

List schedules. Returns schedules that match the supplied type and enabled filters.

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

INSERT examples

create_or_update

Create or update a schedule. Creates a new schedule or updates an existing schedule with the supplied definition.

INSERT INTO azure.ai_projects.beta_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: beta_schedules
props:
  - name: id
    value: "{{ id }}"
    description: Required parameter for the beta_schedules resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the beta_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. Creates a new schedule or updates an existing schedule with the supplied definition.

REPLACE azure.ai_projects.beta_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. Deletes the specified schedule resource.

DELETE FROM azure.ai_projects.beta_schedules
WHERE id = '{{ id }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

list_runs

List schedule runs. Returns schedule runs that match the supplied filters.

EXEC azure.ai_projects.beta_schedules.list_runs 
@id='{{ id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@type='{{ type }}', 
@enabled={{ enabled }}
;