Azure.Communication.JobRouter Namespace

Classes

AcceptJobOfferResult	Response containing ids for the worker, job, and assignment from an accepted offer.
BestWorkerMode	Jobs are distributed to the worker with the strongest abilities available.
CancelExceptionAction	An action that marks a job as cancelled.
CancelJobOptions	Request payload for cancelling a job.
ClassificationPolicy	A container for the rules that govern how jobs are classified.
CloseJobOptions	Request payload for closing jobs.
CompleteJobOptions	Request payload for completing jobs.
ConditionalQueueSelectorAttachment	Describes a set of queue selectors that will be attached if the given condition resolves to true.
ConditionalWorkerSelectorAttachment	Describes a set of worker selectors that will be attached if the given condition resolves to true.
CreateClassificationPolicyOptions	Options for creating classification policy.
CreateDistributionPolicyOptions	Options for creating distribution policy.
CreateExceptionPolicyOptions	Options for creating exception policy.
CreateJobOptions	Options for creating a new job to be routed.
CreateJobWithClassificationPolicyOptions	Options for creating a new job to be routed with classification property.
CreateQueueOptions	Options for creating a queue.
CreateWorkerOptions	Options for creating a worker.
DeclineJobOfferOptions	Request payload for declining offers.
DirectMapRouterRule	A rule that return the same labels as the input labels.
DistributionMode	Abstract base class for defining a distribution mode. Please note DistributionMode is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include BestWorkerMode, LongestIdleMode and RoundRobinMode.
DistributionPolicy	Policy governing how jobs are distributed to workers.
ExceptionAction	The action to take when the exception is triggered. Please note ExceptionAction is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include CancelExceptionAction, ManualReclassifyExceptionAction and ReclassifyExceptionAction.
ExceptionPolicy	A policy that defines actions to execute when exception are triggered.
ExceptionRule	A rule that defines actions to execute upon a specific trigger.
ExceptionTrigger	Abstract base class for defining a trigger for exception rules. Please note ExceptionTrigger is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include QueueLengthExceptionTrigger and WaitTimeExceptionTrigger.
ExpressionRouterRule	A rule providing inline expression rules.
FunctionRouterRule	A rule providing a binding to an HTTP Triggered Azure Function.
FunctionRouterRuleCredential	Credentials used to access Azure function rule.
JobMatchingMode	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. ScheduleAndSuspendMode: Used for scheduling jobs to be queued at a future time. At specified time, matching of a worker to the job will not start automatically. SuspendMode: Used when matching workers to a job needs to be suspended. Please note JobMatchingMode is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include QueueAndMatchMode, ScheduleAndSuspendMode and SuspendMode.
JobRouterAdministrationClient	The JobRouterAdministration service client.
JobRouterClient	The JobRouter service client.
JobRouterClientBuilderExtensions	Extension methods to add JobRouterAdministrationClient, JobRouterClient to client builder.
JobRouterClientOptions	Client options for Azure.Communication.JobRouter library clients.
JobRouterModelFactory	Model factory for models.
LongestIdleMode	Jobs are directed to the worker who has been idle longest.
ManualReclassifyExceptionAction	An action that manually reclassifies a job by providing the queue, priority and worker selectors.
OAuth2WebhookClientCredential	OAuth2.0 Credentials used to Contoso's Authorization server. Reference: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/.
PassThroughQueueSelectorAttachment	Attaches a queue selector where the value is passed through from a job's label with the same key.
PassThroughWorkerSelectorAttachment	Attaches a worker selector where the value is passed through from a job's label with the same key.
QueueAndMatchMode	Describes a matching mode where matching worker to a job is automatically started after job is queued successfully.
QueueLengthExceptionTrigger	Trigger for an exception action on exceeding queue length.
QueueSelectorAttachment	An attachment of queue selectors to resolve a queue to a job from a classification policy. Please note QueueSelectorAttachment is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ConditionalQueueSelectorAttachment, PassThroughQueueSelectorAttachment, RuleEngineQueueSelectorAttachment, StaticQueueSelectorAttachment and WeightedAllocationQueueSelectorAttachment.
QueueWeightedAllocation	Contains the weight percentage and queue selectors to be applied if selected for weighted distributions.
ReclassifyExceptionAction	An action that modifies labels on a job and then reclassifies it.
RoundRobinMode	Jobs are distributed in order to workers, starting with the worker that is after the last worker to receive a job.
RouterChannel	Represents the capacity a job in this channel will consume from a worker.
RouterJob	A unit of work to be routed.
RouterJobAssignment	Assignment details of a job to a worker.
RouterJobNote	A note attached to a job.
RouterJobOffer	An offer of a job to a worker.
RouterJobPositionDetails	Position and estimated wait time for a job.
RouterQueue	A queue that can contain jobs to be routed.
RouterQueueSelector	Describes a condition that must be met against a set of labels for queue selection.
RouterQueueStatistics	Statistics for the queue.
RouterRule	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 that return the same labels as the input labels. ExpressionRule: A rule providing inline expression rules. FunctionRule: A rule providing a binding to an HTTP Triggered Azure Function. WebhookRule: A rule providing a binding to a webserver following OAuth2.0 authentication protocol. Please note RouterRule is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include DirectMapRouterRule, ExpressionRouterRule, FunctionRouterRule, StaticRouterRule and WebhookRouterRule.
RouterValue	Generic value wrapper. Values must be primitive values - number, string, boolean.
RouterWorker	An entity for jobs to be routed to.
RouterWorkerAssignment	The assignment for a worker to a job.
RouterWorkerSelector	Describes a condition that must be met against a set of labels for worker selection.
RuleEngineQueueSelectorAttachment	Attaches queue selectors to a job when the RouterRule is resolved.
RuleEngineWorkerSelectorAttachment	Attaches worker selectors to a job when a RouterRule is resolved.
ScheduleAndSuspendMode	Describes a matching mode used for scheduling jobs to be queued at a future time. At the specified time, matching worker to a job will not start automatically.
ScoringRuleOptions	Encapsulates all options that can be passed as parameters for scoring rule with BestWorkerMode.
StaticQueueSelectorAttachment	Describes a queue selector that will be attached to a job.
StaticRouterRule	A rule providing static rules that always return the same result, regardless of input.
StaticWorkerSelectorAttachment	Describes a worker selector that will be attached to a job.
SuspendMode	Describes a matching mode where matching worker to a job is suspended.
UnassignJobOptions	Request payload for unassigning a job.
UnassignJobResult	Response payload after a job has been successfully unassigned.
WaitTimeExceptionTrigger	Trigger for an exception action on exceeding wait time.
WebhookRouterRule	A rule providing a binding to an external web server.
WeightedAllocationQueueSelectorAttachment	Describes multiple sets of queue selectors, of which one will be selected and attached according to a weighting.
WeightedAllocationWorkerSelectorAttachment	Describes multiple sets of worker selectors, of which one will be selected and attached according to a weighting.
WorkerSelectorAttachment	An attachment which attaches worker selectors to a job. Please note WorkerSelectorAttachment is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ConditionalWorkerSelectorAttachment, PassThroughWorkerSelectorAttachment, RuleEngineWorkerSelectorAttachment, StaticWorkerSelectorAttachment and WeightedAllocationWorkerSelectorAttachment.
WorkerWeightedAllocation	Contains the weight percentage and worker selectors to be applied if selected for weighted distributions.

Structs

DistributionModeKind	Discriminators for supported distribution mode types.
ExceptionActionKind	Discriminators for supported exception action types.
ExceptionTriggerKind	Discriminators for supported exception trigger types.
JobMatchingModeKind	Discriminators for supported matching mode types.
LabelOperator	Describes supported operations on label values.
QueueSelectorAttachmentKind	Discriminators for supported queue selector attachment types.
RouterJobStatus	Describes the various status of a job.
RouterJobStatusSelector	Enums used to filters jobs by status.
RouterRuleKind	Discriminators for supported router rule types.
RouterWorkerSelectorStatus	Describes the status of a worker selector.
RouterWorkerState	Enums for worker states.
RouterWorkerStateSelector	Enums used to filters workers by state.
ScoringRuleParameterSelector	Supported parameters for scoring workers used with BestWorkerMode.
WorkerSelectorAttachmentKind	Discriminators for supported worker selector attachment types.

Enums

JobRouterClientOptions.ServiceVersion

The version of the service to use.