Microsoft Azure Routing API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Routing. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.
This API exposes
33 operations
across 21 paths,
and defines 65 schemas.
It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.
The identity and technical contract details declared by the specification.
PagedRouterJob
object
Paged collection of RouterJob items
2 properties
1 required
QueueSelectorAttachmentKind
string
Discriminators for supported queue selector attachment types.
JobMatchingModeKind
string
Discriminators for supported matching mode types.
RouterJobStatus
string
Describes the various status of a job.
ExceptionPolicyCreateOrUpdate
object
A policy that defines actions to execute when exception are triggered.
2 properties
Azure.Core.Foundations.Error
object
The error object.
5 properties
2 required
ExceptionRule
object
A rule that defines actions to execute upon a specific trigger.
3 properties
3 required
PagedRouterWorker
object
Paged collection of RouterWorker items
2 properties
1 required
RouterWorkerSelector
object
Describes a condition that must be met against a set of labels for worker selection.
7 properties
2 required
JobMatchingMode
object
A matching mode of one of the following types: QueueAndMatchMode: Used when matching worker to a job is required to be done right after job is queued. Schedule…
1 property
1 required
LabelOperator
string
Describes supported operations on label values.
ExceptionPolicy
object
A policy that defines actions to execute when exception are triggered.
4 properties
2 required
ExceptionTriggerKind
string
Discriminators for supported exception trigger types.
DistributionModeCreateOrUpdate
object
Abstract base class for defining a distribution mode.
4 properties
1 required
RouterWorkerSelectorStatus
string
Describes the status of a worker selector.
PagedRouterQueue
object
Paged collection of RouterQueue items
2 properties
1 required
RouterRuleKind
string
Discriminators for supported router rule types.
UnassignJobOptions
object
Request payload for unassigning a job.
1 property
RouterWorkerAssignment
object
The assignment for a worker to a job.
4 properties
4 required
DistributionPolicyCreateOrUpdate
object
Policy governing how jobs are distributed to workers
3 properties
WorkerSelectorAttachment
object
An attachment which attaches worker selectors to a job.
1 property
1 required
QueueSelectorAttachment
object
An attachment of queue selectors to resolve a queue to a job from a classification policy.
1 property
1 required
ExceptionActionKind
string
Discriminators for supported exception action types.
ClassificationPolicy
object
A container for the rules that govern how jobs are classified.
7 properties
2 required
UnassignJobResult
object
Response payload after a job has been successfully unassigned.
2 properties
2 required
RouterWorker
object
An entity for jobs to be routed to.
13 properties
2 required
Azure.Core.Foundations.InnerError
object
An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Gu…
2 properties
PagedClassificationPolicy
object
Paged collection of ClassificationPolicy items
2 properties
1 required
DistributionModeKind
string
Discriminators for supported distribution mode types.
RouterRule
object
A rule of one of the following types: StaticRule: A rule providing static rules that always return the same result, regardless of input. DirectMapRule: A rule…
1 property
1 required
RouterJobAssignment
object
Assignment details of a job to a worker.
5 properties
2 required
CompleteJobResult
object
Response payload from completing a job.
CompleteJobOptions
object
Request payload for completing jobs.
1 property
CancelJobOptions
object
Request payload for cancelling a job.
2 properties
DeclineJobOfferResult
object
Response payload from declining a job.
RouterChannel
object
Represents the capacity a job in this channel will consume from a worker.
3 properties
2 required
JobMatchingModeCreateOrUpdate
object
A matching mode of one of the following types: QueueAndMatchMode: Used when matching worker to a job is required to be done right after job is queued. Schedule…
1 property
1 required
RouterJobCreateOrUpdate
object
A unit of work to be routed
11 properties
PagedExceptionPolicy
object
Paged collection of ExceptionPolicy items
2 properties
1 required
CloseJobResult
object
Response payload from closing a job.
CancelJobResult
object
Response payload from cancelling a job.
RouterJob
object
A unit of work to be routed
18 properties
2 required
ReclassifyJobOptions
object
Request payload for reclassifying jobs.
RouterJobNote
object
A note attached to a job.
2 properties
1 required
RouterJobOffer
object
An offer of a job to a worker.
5 properties
3 required
CloseJobOptions
object
Request payload for closing jobs
3 properties
RouterJobPositionDetails
object
Position and estimated wait time for a job.
5 properties
5 required
ExceptionTrigger
object
Abstract base class for defining a trigger for exception rules.
1 property
1 required
ReclassifyJobResult
object
Response payload from reclassifying a job.
Azure.Core.Foundations.ErrorResponse
object
A response containing error details.
1 property
1 required
RouterQueueStatistics
object
Statistics for the queue.
4 properties
2 required
RouterRuleCreateOrUpdate
object
A rule of one of the following types: StaticRule: A rule providing static rules that always return the same result, regardless of input. DirectMapRule: A rule…
1 property
1 required
ExceptionAction
object
The action to take when the exception is triggered.
2 properties
1 required
DistributionMode
object
Abstract base class for defining a distribution mode.
4 properties
1 required
RouterWorkerCreateOrUpdate
object
An entity for jobs to be routed to.
7 properties
AcceptJobOfferResult
object
Response containing ids for the worker, job, and assignment from an accepted offer.
3 properties
3 required
ClassificationPolicyCreateOrUpdate
object
A container for the rules that govern how jobs are classified.
5 properties
DeclineJobOfferOptions
object
Request payload for declining offers.
1 property
RouterQueueCreateOrUpdate
object
A queue that can contain jobs to be routed.
4 properties
PagedDistributionPolicy
object
Paged collection of DistributionPolicy items
2 properties
1 required
RouterQueue
object
A queue that can contain jobs to be routed.
6 properties
2 required
WorkerSelectorAttachmentKind
string
Discriminators for supported worker selector attachment types.
Azure.Core.eTag
string
The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource. It lets caches be more efficient and save bandwidth, as a…
RouterWorkerState
string
Enums for worker states.
DistributionPolicy
object
Policy governing how jobs are distributed to workers
5 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Microsoft Azure publishes across the network.
