beta_routines

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

Overview

Name	beta_routines
Type	Resource
Id	azure.ai_projects.beta_routines

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	The routine name.
action	object	The action executed when the routine fires.
created_at	string (date-time)	The time when the routine was created.
description	string	A human-readable description of the routine.
enabled	boolean	Whether the routine is enabled. Required.
triggers	object	The triggers configured for the routine.
updated_at	string (date-time)	The time when the routine was last updated.

list

Name	Datatype	Description
name	string	The routine name.
action	object	The action executed when the routine fires.
created_at	string (date-time)	The time when the routine was created.
description	string	A human-readable description of the routine.
enabled	boolean	Whether the routine is enabled. Required.
triggers	object	The triggers configured for the routine.
updated_at	string (date-time)	The time when the routine was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	routine_name, endpoint		Get a routine. Retrieves the specified routine and its current configuration.
list	select	endpoint	limit, after, before, order	List routines. Returns the routines available in the current project.
create_or_update	insert	routine_name, endpoint		Create or update a routine. Creates a new routine or replaces an existing routine with the supplied definition.
create_or_update	replace	routine_name, endpoint		Create or update a routine. Creates a new routine or replaces an existing routine with the supplied definition.
delete	delete	routine_name, endpoint		Delete a routine. Deletes the specified routine.
list_runs	exec	routine_name, endpoint	filter, limit, after, before, order	List prior runs for a routine. Returns prior runs recorded for the specified routine.
enable	exec	routine_name, endpoint		Enable a routine. Enables the specified routine so it can be dispatched.
disable	exec	routine_name, endpoint		Disable a routine. Disables the specified routine so it no longer runs.
dispatch	exec	routine_name, endpoint		Queue an asynchronous routine dispatch. Queues an asynchronous dispatch for the specified routine.

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: )
routine_name	string	The unique name of the routine. Required.
after	string
before	string	Unsupported. Reserved for future backward pagination support. Default value is None.
filter	string	An optional MLflow search-runs filter expression applied within the routine's experiment. Default value is None.
limit	integer	The maximum number of runs to return. Default value is None.
order	string	The ordering direction. Supported values are asc and desc. Default value is None.

SELECT examples

get

Get a routine. Retrieves the specified routine and its current configuration.

SELECT
name,
action,
created_at,
description,
enabled,
triggers,
updated_at
FROM azure.ai_projects.beta_routines
WHERE routine_name = '{{ routine_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

List routines. Returns the routines available in the current project.

SELECT
name,
action,
created_at,
description,
enabled,
triggers,
updated_at
FROM azure.ai_projects.beta_routines
WHERE endpoint = '{{ endpoint }}' -- required
AND limit = '{{ limit }}'
AND after = '{{ after }}'
AND before = '{{ before }}'
AND order = '{{ order }}'
;

INSERT examples

create_or_update

Create or update a routine. Creates a new routine or replaces an existing routine with the supplied definition.

INSERT INTO azure.ai_projects.beta_routines (
routine_name,
endpoint
)
SELECT 
'{{ routine_name }}',
'{{ endpoint }}'
RETURNING
name,
action,
created_at,
description,
enabled,
triggers,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: beta_routines
props:
  - name: routine_name
    value: "{{ routine_name }}"
    description: Required parameter for the beta_routines resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the beta_routines resource.

REPLACE examples

create_or_update

Create or update a routine. Creates a new routine or replaces an existing routine with the supplied definition.

REPLACE azure.ai_projects.beta_routines
SET 
-- No updatable properties
WHERE 
routine_name = '{{ routine_name }}' --required
AND endpoint = '{{ endpoint }}' --required
RETURNING
name,
action,
created_at,
description,
enabled,
triggers,
updated_at;

DELETE examples

delete

Delete a routine. Deletes the specified routine.

DELETE FROM azure.ai_projects.beta_routines
WHERE routine_name = '{{ routine_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

list_runs

List prior runs for a routine. Returns prior runs recorded for the specified routine.

EXEC azure.ai_projects.beta_routines.list_runs 
@routine_name='{{ routine_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@filter='{{ filter }}', 
@limit='{{ limit }}', 
@after='{{ after }}', 
@before='{{ before }}', 
@order='{{ order }}'
;

enable

Enable a routine. Enables the specified routine so it can be dispatched.

EXEC azure.ai_projects.beta_routines.enable 
@routine_name='{{ routine_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

disable

Disable a routine. Disables the specified routine so it no longer runs.

EXEC azure.ai_projects.beta_routines.disable 
@routine_name='{{ routine_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

dispatch

Queue an asynchronous routine dispatch. Queues an asynchronous dispatch for the specified routine.

EXEC azure.ai_projects.beta_routines.dispatch 
@routine_name='{{ routine_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;