Microsoft Azure Routing API

The Routing API from Microsoft Azure — 21 operation(s) for routing.

Documentation GitHub OpenAPI

Operations 33

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /routing/classificationPolicies List job classification policies · Microsoft Azure Retrieves Existing Classification Policies #

Ask an LLM

“How do I see every classification policy set up in Job Router?”

“Which classification policies decide how incoming jobs get their queue and priority?”

Tell an agent

List all my Job Router classification policies.

Show up to {maxpagesize} classification policies per page.

GET /routing/classificationPolicies/{classificationPolicyId} Get a classification policy · Microsoft Azure Retrieves An Existing Classification Policy By Id #

Ask an LLM

“Can I look up the rules inside one specific classification policy?”

“What fallback queue does a given classification policy use?”

Tell an agent

Get classification policy {classificationPolicyId}.

Show me the queue selectors and prioritization rule on classification policy {classificationPolicyId}.

PATCH /routing/classificationPolicies/{classificationPolicyId} Create or update a classification policy · Microsoft Azure Creates Or Updates A Classification Policy #

Ask an LLM

“How do I set up a classification policy that assigns a fallback queue to jobs?”

“Can I change the prioritization rule on an existing classification policy?”

Tell an agent

Create classification policy {classificationPolicyId} named {name} with fallback queue {fallbackQueueId}.

Update classification policy {classificationPolicyId} to use prioritization rule {prioritizationRule}.

DELETE /routing/classificationPolicies/{classificationPolicyId} Delete a classification policy · Microsoft Azure Delete A Classification Policy By Id #

Ask an LLM

“How do I remove a classification policy I no longer use for routing jobs?”

“Can a classification policy be deleted by its id?”

Tell an agent destructive · confirm first

Delete classification policy {classificationPolicyId}.

Remove the job classification policy {classificationPolicyId} from Job Router.

GET /routing/distributionPolicies List job distribution policies · Microsoft Azure Retrieves Existing Distribution Policies #

Ask an LLM

“Where can I see all the distribution policies that control how job offers go out to workers?”

“Which distribution policies exist in my Job Router setup?”

Tell an agent

List all Job Router distribution policies.

Page through distribution policies {maxpagesize} at a time.

GET /routing/distributionPolicies/{distributionPolicyId} Get a distribution policy · Microsoft Azure Retrieves An Existing Distribution Policy By Id #

Ask an LLM

“How long do offers last under a particular distribution policy?”

“Can I check which distribution mode a specific policy uses?”

Tell an agent

Get distribution policy {distributionPolicyId}.

Show the offer expiry and mode for distribution policy {distributionPolicyId}.

PATCH /routing/distributionPolicies/{distributionPolicyId} Create or update a distribution policy · Microsoft Azure Creates Or Updates A Distribution Policy #

Ask an LLM

“How do I create a distribution policy that expires job offers after a set number of seconds?”

“Can I switch the distribution mode on an existing policy?”

Tell an agent

Create distribution policy {distributionPolicyId} named {name} with offers expiring after {offerExpiresAfterSeconds} seconds.

Set the mode of distribution policy {distributionPolicyId} to {mode}.

DELETE /routing/distributionPolicies/{distributionPolicyId} Delete a distribution policy · Microsoft Azure Delete A Distribution Policy By Id #

Ask an LLM

“How do I get rid of a distribution policy no queue uses anymore?”

“Can I delete a job distribution policy by id?”

Tell an agent destructive · confirm first

Delete distribution policy {distributionPolicyId}.

Remove the distribution policy {distributionPolicyId} from Job Router.

GET /routing/exceptionPolicies List job exception policies · Microsoft Azure Retrieves Existing Exception Policies #

Ask an LLM

“Which exception policies are defined for handling jobs that wait too long or overflow?”

“How can I view all Job Router exception policies?”

Tell an agent

List all Job Router exception policies.

Show exception policies with {maxpagesize} per page.

GET /routing/exceptionPolicies/{exceptionPolicyId} Get an exception policy · Microsoft Azure Retrieves An Existing Exception Policy By Id #

Ask an LLM

“What exception rules are inside one particular exception policy?”

“Can I inspect a single exception policy by its id?”

Tell an agent

Get exception policy {exceptionPolicyId}.

Show me the exception rules in policy {exceptionPolicyId}.

PATCH /routing/exceptionPolicies/{exceptionPolicyId} Create or update an exception policy · Microsoft Azure Creates Or Updates A Exception Policy #

Ask an LLM

“How do I define exception rules that trigger when a job sits in a queue too long?”

“Can I rename or change the rules on an existing exception policy?”

Tell an agent

Create exception policy {exceptionPolicyId} named {name}.

Replace the exception rules on policy {exceptionPolicyId} with {exceptionRules}.

DELETE /routing/exceptionPolicies/{exceptionPolicyId} Delete an exception policy · Microsoft Azure Deletes A Exception Policy By Id #

Ask an LLM

“How do I delete an exception policy from Job Router?”

“Can I remove an exception policy that queues no longer reference?”

Tell an agent destructive · confirm first

Delete exception policy {exceptionPolicyId}.

Remove the exception policy {exceptionPolicyId}.

GET /routing/jobs List router jobs with filters · Microsoft Azure Retrieves List Of Jobs Based On Filter Parameters #

Ask an LLM

“How do I find all router jobs sitting in a particular queue?”

“Can I filter jobs by status or by the channel they came in on?”

Tell an agent

List router jobs with status {status}.

Show jobs in queue {queueId} on channel {channelId}.

GET /routing/jobs/{jobId} Get a router job · Microsoft Azure Retrieves An Existing Job By Id #

Ask an LLM

“Can I pull up the full details of one router job by its id?”

“What priority and labels does a specific job currently have?”

Tell an agent

Get router job {jobId}.

Show me the details of job {jobId}.

PATCH /routing/jobs/{jobId} Create or update a router job · Microsoft Azure Creates Or Updates A Router Job #

Ask an LLM

“How do I submit a new job into a Job Router queue?”

“Can I change the priority of a job that's already waiting?”

Tell an agent

Create job {jobId} on channel {channelId} in queue {queueId} with priority {priority}.

Update job {jobId} to use classification policy {classificationPolicyId}.

DELETE /routing/jobs/{jobId} Delete a job and its traces · Microsoft Azure Deletes A Job And All Of Its Traces #

Ask an LLM

“How do I permanently delete a router job along with all its traces?”

“Can I purge a job's history completely from Job Router?”

Tell an agent destructive · confirm first

Delete router job {jobId} and all of its traces.

Purge job {jobId} from Job Router.

POST /routing/jobs/{jobId}:reclassify Reclassify a job · Microsoft Azure Reclassify A Job #

Ask an LLM

“How do I rerun classification on a job after its labels changed?”

“Can a waiting job be sent back through its classification policy?”

Tell an agent

Reclassify job {jobId}.

Run classification again on router job {jobId}.

POST /routing/jobs/{jobId}:cancel Cancel a router job · Microsoft Azure Submits Request To Cancel An Existing Job By Id While Supplying… #

Ask an LLM

“How do I cancel a job before any worker picks it up?”

“Can I record a reason or disposition code when cancelling a job?”

Tell an agent destructive · confirm first

Cancel job {jobId}.

Cancel job {jobId} with the note {note} and disposition code {dispositionCode}.

POST /routing/jobs/{jobId}/assignments/{assignmentId}:complete Complete an assigned job · Microsoft Azure Completes An Assigned Job #

Ask an LLM

“How does a worker mark an assigned job as done?”

“Can I attach a note when completing a job assignment?”

Tell an agent

Complete assignment {assignmentId} of job {jobId}.

Mark job {jobId} assignment {assignmentId} complete with note {note}.

POST /routing/jobs/{jobId}/assignments/{assignmentId}:close Close a completed job · Microsoft Azure Closes A Completed Job #

Ask an LLM

“How do I close out a job that has already been completed?”

“Can I schedule a completed job to close at a later time with a disposition code?”

Tell an agent destructive · confirm first

Close job {jobId} for assignment {assignmentId}.

Close completed job {jobId} assignment {assignmentId} at {closeAt} with disposition {dispositionCode}.

POST /routing/jobs/{jobId}/assignments/{assignmentId}:unassign Unassign a job from a worker · Microsoft Azure Unassign A Job #

Ask an LLM

“How do I take a job back from the worker it was assigned to?”

“Can I unassign a job and stop it from being matched again right away?”

Tell an agent

Unassign job {jobId} from assignment {assignmentId}.

Unassign job {jobId} assignment {assignmentId} and set suspend matching to {suspendMatching}.

GET /routing/jobs/{jobId}/position Get a job's position in its queue · Microsoft Azure Gets A Job S Position Details #

Ask an LLM

“Where is my job in the queue right now?”

“How many jobs are ahead of a particular waiting job?”

Tell an agent

Get the queue position of job {jobId}.

Tell me where job {jobId} sits in its queue.

GET /routing/queues List job queues · Microsoft Azure Retrieves Existing Queues #

Ask an LLM

“What queues are configured in Job Router?”

“How can I list every queue jobs can be routed to?”

Tell an agent

List all Job Router queues.

Show queues {maxpagesize} per page.

GET /routing/queues/{queueId} Get a queue's configuration · Microsoft Azure Retrieves An Existing Queue By Id #

Ask an LLM

“Which distribution and exception policies does one queue use?”

“Can I read the labels set on a specific queue?”

Tell an agent

Get queue {queueId}.

Show the policies attached to queue {queueId}.

PATCH /routing/queues/{queueId} Create or update a queue · Microsoft Azure Creates Or Updates A Queue #

Ask an LLM

“How do I create a new queue with its own distribution policy?”

“Can I attach an exception policy to an existing queue?”

Tell an agent

Create queue {queueId} named {name} using distribution policy {distributionPolicyId}.

Attach exception policy {exceptionPolicyId} to queue {queueId}.

DELETE /routing/queues/{queueId} Delete a queue · Microsoft Azure Deletes A Queue By Id #

Ask an LLM

“How do I delete a Job Router queue I no longer need?”

“Can a queue be removed by its id?”

Tell an agent destructive · confirm first

Delete queue {queueId}.

Remove Job Router queue {queueId}.

GET /routing/queues/{queueId}/statistics Get queue statistics · Microsoft Azure Retrieves A Queue S Statistics #

Ask an LLM

“How many jobs are waiting in a queue and how long have they waited?”

“Is there a way to see live statistics for a single queue?”

Tell an agent

Get statistics for queue {queueId}.

Show me the current wait metrics for queue {queueId}.

GET /routing/workers List router workers · Microsoft Azure Retrieves Existing Workers #

Ask an LLM

“Which workers are currently active and have capacity to take jobs?”

“Can I list workers that serve a specific queue or channel?”

Tell an agent

List workers in state {state}.

Show workers on queue {queueId} with capacity available set to {hasCapacity}.

GET /routing/workers/{workerId} Get a router worker · Microsoft Azure Retrieves An Existing Worker By Id #

Ask an LLM

“What queues and channels is a specific worker registered for?”

“Can I check whether one worker is available for offers?”

Tell an agent

Get worker {workerId}.

Show the capacity and offers for worker {workerId}.

PATCH /routing/workers/{workerId} Create or update a worker · Microsoft Azure Creates Or Updates A Worker #

Ask an LLM

“How do I register a new worker with a set capacity?”

“Can I toggle whether a worker is available for job offers?”

Tell an agent

Register worker {workerId} with capacity {capacity}.

Set worker {workerId} available for offers to {availableForOffers}.

DELETE /routing/workers/{workerId} Delete a worker and its traces · Microsoft Azure Deletes A Worker And All Of Its Traces #

Ask an LLM

“How do I remove a worker and all its history from Job Router?”

“Can I delete a worker who has left the team?”

Tell an agent destructive · confirm first

Delete worker {workerId} and all of its traces.

Remove worker {workerId} from Job Router.

POST /routing/workers/{workerId}/offers/{offerId}:accept Accept a job offer · Microsoft Azure Accepts An Offer To Work On A Job And Returns A 409 Conflict If… #

Ask an LLM

“How does a worker accept an offer to work on a job?”

“What happens if another agent already accepted the same job offer?”

Tell an agent

Accept offer {offerId} for worker {workerId}.

Have worker {workerId} take the job in offer {offerId}.

POST /routing/workers/{workerId}/offers/{offerId}:decline Decline a job offer · Microsoft Azure Declines An Offer To Work On A Job #

Ask an LLM

“How can a worker turn down a job offer?”

“Can I decline an offer but have it retried at a later time?”

Tell an agent

Decline offer {offerId} for worker {workerId}.

Decline offer {offerId} for worker {workerId} and retry it at {retryOfferAt}.

Microsoft Azure Routing API

Operations 33

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification