feat(ai-foundry): add TypeSpec for Foundry Routines by lindazqli · Pull Request #42779 · Azure/azure-rest-api-specs

lindazqli · 2026-04-30T04:40:17Z

Summary

Adds TypeSpec models and routes for the Foundry Routines feature, based on the C# service contracts in Vienna.

New files

src/routines/models.tsp — all Routines domain models
src/routines/routes.tsp — 7 REST operations

Modified files

src/common/models.tsp — adds routines_v1_preview: "Routines=V1Preview" to FoundryFeaturesOptInKeys
main.tsp — imports src/routines/routes.tsp
openapi3/ — regenerated OpenAPI output

Routes

Method	Path	Description
PUT	`/routines/{routineName}`	Create or update a routine
GET	`/routines/{routineName}`	Get a routine
GET	`/routines`	List all routines
DELETE	`/routines/{routineName}`	Delete a routine
POST	`/routines/{routineName}:dispatch`	Synchronous dispatch
POST	`/routines/{routineName}:dispatchAsync`	Asynchronous dispatch
GET	`/routines/{routineName}/runs`	List routine run history

Key model design

RoutineTrigger discriminated on type: "schedule", "timer", "github_issue"
RoutineAction discriminated on type: "invoke_agent_responses_api", "invoke_agent_invocations_api"
Routine.triggers is Record<RoutineTrigger> (named dict, matching C# Dictionary<string, RoutineTrigger>)
RoutineDispatchPayload discriminated on type matching RoutineActionType
All routes require Foundry-Features: Routines=V1Preview header

github-actions · 2026-04-30T04:40:54Z

Next Steps to Merge

⌛ Please wait. Next steps to merge this PR are being evaluated by automation. ⌛

Comment generated by summarize-checks workflow run.

lindazqli · 2026-04-30T04:42:07Z

@copilot resolve the merge conflicts in this pull request

- Add src/routines/models.tsp with RoutineTrigger (schedule/timer/github_issue), RoutineAction (invoke_agent_responses_api / invoke_agent_invocations_api), RoutineDispatchPayload, RoutineRunDto, and RoutineRunsResponse models - Add src/routines/routes.tsp with createOrUpdate, get, list, delete, dispatch, dispatchAsync, and listRuns operations - Add routines_v1_preview feature flag to FoundryFeaturesOptInKeys - Wire up main.tsp import - Regenerate openapi3 output

github-actions · 2026-04-30T05:00:25Z

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language	API Review for Package
TypeSpec	Azure.AI.Projects
Python	azure-ai-projects
JavaScript	@azure/ai-projects

Comment generated by After APIView workflow run.

glecaros · 2026-05-04T19:34:17Z

+  string,
+
+  @doc("Cron-based recurring schedule trigger.")
+  Schedule: "schedule",


nit:

Suggested change

Schedule: "schedule",

schedule: "schedule",

glecaros · 2026-05-04T19:34:36Z

+  Schedule: "schedule",
+
+  @doc("One-shot timer trigger.")
+  Timer: "timer",


nit:

Suggested change

Timer: "timer",

timer: "timer",

glecaros · 2026-05-04T19:34:52Z

+  Timer: "timer",
+
+  @doc("GitHub issue event trigger.")
+  GitHubIssue: "github_issue",


nit

Suggested change

GitHubIssue: "github_issue",

github_issue: "github_issue",

glecaros · 2026-05-04T19:36:24Z

+  type: RoutineTriggerType.Timer;
+
+  @doc("One-shot fire time in ISO 8601 format. Example: `\"2030-01-02T03:04:05Z\"`.")
+  at?: string;


probably need a more expressive name.

glecaros · 2026-05-04T19:38:48Z

+  string,
+
+  @doc("Invoke a published agent via the workspace responses API.")
+  InvokeAgentResponsesApi: "invoke_agent_responses_api",


From the feedback in the conceptual spec:

Suggested change

InvokeAgentResponsesApi: "invoke_agent_responses_api",

agent_response: "agent_response",

glecaros · 2026-05-04T19:42:39Z

+
+  #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "We need explicit definition for header support"
+  @doc("Get a routine by name.")
+  get is Azure.Core.Foundations.ResourceOperation<


same as above

glecaros · 2026-05-04T19:46:44Z

+  #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "We need explicit definition for header support"
+  @doc("List all routines.")
+  @Rest.listsResource(Routine)
+  list is Azure.Core.Foundations.ResourceList<


similar as above: use the paged operation archetype with the types defined in servicepatterns.tsp, e.g:

@list listRoutines is FoundryDataPlanePreviewOperation< FoundryFeaturesOptInKeys.routines_v1_preview, { ...CommonPageQueryParameters; }, AgentsPagedResult<Routine> >;

glecaros · 2026-05-04T19:48:06Z

+  @doc("List execution history for a routine.")
+  @route("routines/{routine_name}/runs")
+  @get
+  listRuns is FoundryDataPlaneOperation<


same as the other list operation

glecaros · 2026-05-04T19:48:30Z

+
+  #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "We need explicit definition for header support"
+  @doc("Asynchronously dispatch a routine. Returns immediately after enqueueing the action.")
+  @route("routines/{routine_name}:dispatchAsync")


use snake_case for the action

glecaros · 2026-05-04T19:54:26Z

+
+      ...RoutinesPreviewHeader;
+
+      @Http.bodyRoot


since DispatchRoutineRequest does not have non-body fields (path, query, etc)... use @Body here

@doc

…conversation field - Expand TimerRoutineTrigger.at @doc to cover ISO-8601, local+tz, and duration formats (e.g. '30m', '2h'); note reminder tool writes '{minutes}m' - Rename conversation_id -> conversation in InvokeAgentResponsesApiRoutineAction to match actual wire format Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

lindazqli marked this pull request as ready for review April 30, 2026 04:42

lindazqli requested review from balapv, dargilco, glecaros, johanste and trrwilson as code owners April 30, 2026 04:42

lindazqli force-pushed the foundry-routines-typespec branch from 8275815 to 8570a43 Compare April 30, 2026 04:54

github-actions Bot added data-plane TypeSpec Authored with TypeSpec labels Apr 30, 2026

glecaros reviewed May 4, 2026

View reviewed changes

therealjohn mentioned this pull request May 13, 2026

Add azd ai routine create/update/show/list/delete (plus enable, disable, dispatch, and run subcommands) to manage and run Foundry Routines from any directory Azure/azure-dev#8159

Closed

akshaya-a mentioned this pull request May 26, 2026

Align Foundry Routines TypeSpec contracts #43498

Merged

	InvokeAgentResponsesApi: "invoke_agent_responses_api",
	agent_response: "agent_response",

Uh oh!

Conversation

lindazqli commented Apr 30, 2026

Summary

New files

Modified files

Routes

Key model design

Uh oh!

github-actions Bot commented Apr 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Next Steps to Merge

Uh oh!

lindazqli commented Apr 30, 2026

Uh oh!

github-actions Bot commented Apr 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

API Change Check

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions Bot commented Apr 30, 2026 •

edited

Loading

github-actions Bot commented Apr 30, 2026 •

edited

Loading