@azure-rest/communication-job-router package

Interfaces

Accept
Accept200Response

The request has succeeded.
AcceptDefaultHeaders
AcceptDefaultResponse
AcceptJobOfferResultOutput

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.
BestWorkerModeOutput

Jobs are distributed to the worker with the strongest abilities available.
Cancel
Cancel200Response

The request has succeeded.
CancelBodyParam
CancelDefaultHeaders
CancelDefaultResponse
CancelExceptionAction

An action that marks a job as cancelled.
CancelExceptionActionOutput

An action that marks a job as cancelled.
CancelJobOptions

Request payload for cancelling a job.
CancelJobResultOutput

Response payload from cancelling a job.
ClassificationPolicy

A container for the rules that govern how jobs are classified.
ClassificationPolicyOutput

A container for the rules that govern how jobs are classified.
Close
Close200Response

The request has succeeded.
CloseBodyParam
CloseDefaultHeaders
CloseDefaultResponse
CloseJobOptions

Request payload for closing jobs
CloseJobResultOutput

Response payload from closing a job.
Complete
Complete200Response

The request has succeeded.
CompleteBodyParam
CompleteDefaultHeaders
CompleteDefaultResponse
CompleteJobOptions

Request payload for completing jobs.
CompleteJobResultOutput

Response payload from completing a job.
ConditionalQueueSelectorAttachment

Describes a set of queue selectors that will be attached if the given condition resolves to true.
ConditionalQueueSelectorAttachmentOutput

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.
ConditionalWorkerSelectorAttachmentOutput

Describes a set of worker selectors that will be attached if the given condition resolves to true.
Decline
Decline200Response

The request has succeeded.
DeclineBodyParam
DeclineDefaultHeaders
DeclineDefaultResponse
DeclineJobOfferOptions

Request payload for declining offers.
DeclineJobOfferResultOutput

Response payload from declining a job.
DeleteClassificationPolicy204Response

There is no content to send for this request, but the headers may be useful.
DeleteClassificationPolicyDefaultHeaders
DeleteClassificationPolicyDefaultResponse
DeleteDistributionPolicy204Response

There is no content to send for this request, but the headers may be useful.
DeleteDistributionPolicyDefaultHeaders
DeleteDistributionPolicyDefaultResponse
DeleteExceptionPolicy204Response

There is no content to send for this request, but the headers may be useful.
DeleteExceptionPolicyDefaultHeaders
DeleteExceptionPolicyDefaultResponse
DeleteJob204Response

There is no content to send for this request, but the headers may be useful.
DeleteJobDefaultHeaders
DeleteJobDefaultResponse
DeleteQueue204Response

There is no content to send for this request, but the headers may be useful.
DeleteQueueDefaultHeaders
DeleteQueueDefaultResponse
DeleteWorker204Response

There is no content to send for this request, but the headers may be useful.
DeleteWorkerDefaultHeaders
DeleteWorkerDefaultResponse
DirectMapRouterRule

A rule that return the same labels as the input labels.
DirectMapRouterRuleOutput

A rule that return the same labels as the input labels.
DistributionModeOutputParent

Abstract base class for defining a distribution mode.
DistributionModeParent

Abstract base class for defining a distribution mode.
DistributionPolicy

Policy governing how jobs are distributed to workers
DistributionPolicyOutput

Policy governing how jobs are distributed to workers
ExceptionActionOutputParent

The action to take when the exception is triggered.
ExceptionActionParent

The action to take when the exception is triggered.
ExceptionPolicy

A policy that defines actions to execute when exception are triggered.
ExceptionPolicyOutput

A policy that defines actions to execute when exception are triggered.
ExceptionRule

A rule that defines actions to execute upon a specific trigger.
ExceptionRuleOutput

A rule that defines actions to execute upon a specific trigger.
ExceptionTriggerOutputParent

Abstract base class for defining a trigger for exception rules.
ExceptionTriggerParent

Abstract base class for defining a trigger for exception rules.
ExpressionRouterRule

A rule providing inline expression rules.
ExpressionRouterRuleOutput

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.
FunctionRouterRuleCredentialOutput

Credentials used to access Azure function rule.
FunctionRouterRuleOutput

A rule providing a binding to an HTTP Triggered Azure Function.
GetClassificationPolicy200Headers
GetClassificationPolicy200Response

The request has succeeded.
GetClassificationPolicyDefaultHeaders
GetClassificationPolicyDefaultResponse
GetDistributionPolicy200Headers
GetDistributionPolicy200Response

The request has succeeded.
GetDistributionPolicyDefaultHeaders
GetDistributionPolicyDefaultResponse
GetExceptionPolicy200Headers
GetExceptionPolicy200Response

The request has succeeded.
GetExceptionPolicyDefaultHeaders
GetExceptionPolicyDefaultResponse
GetInQueuePosition
GetInQueuePosition200Response

The request has succeeded.
GetInQueuePositionDefaultHeaders
GetInQueuePositionDefaultResponse
GetJob200Headers
GetJob200Response

The request has succeeded.
GetJobDefaultHeaders
GetJobDefaultResponse
GetQueue200Headers
GetQueue200Response

The request has succeeded.
GetQueueDefaultHeaders
GetQueueDefaultResponse
GetQueueStatistics
GetQueueStatistics200Response

The request has succeeded.
GetQueueStatisticsDefaultHeaders
GetQueueStatisticsDefaultResponse
GetWorker200Headers
GetWorker200Response

The request has succeeded.
GetWorkerDefaultHeaders
GetWorkerDefaultResponse
JobMatchingModeOutputParent

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.
JobMatchingModeParent

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.
ListClassificationPolicies
ListClassificationPolicies200Response

The request has succeeded.
ListClassificationPoliciesDefaultHeaders
ListClassificationPoliciesDefaultResponse
ListClassificationPoliciesQueryParam
ListClassificationPoliciesQueryParamProperties
ListDistributionPolicies
ListDistributionPolicies200Response

The request has succeeded.
ListDistributionPoliciesDefaultHeaders
ListDistributionPoliciesDefaultResponse
ListDistributionPoliciesQueryParam
ListDistributionPoliciesQueryParamProperties
ListExceptionPolicies
ListExceptionPolicies200Response

The request has succeeded.
ListExceptionPoliciesDefaultHeaders
ListExceptionPoliciesDefaultResponse
ListExceptionPoliciesQueryParam
ListExceptionPoliciesQueryParamProperties
ListJobs
ListJobs200Response

The request has succeeded.
ListJobsDefaultHeaders
ListJobsDefaultResponse
ListJobsQueryParam
ListJobsQueryParamProperties
ListQueues
ListQueues200Response

The request has succeeded.
ListQueuesDefaultHeaders
ListQueuesDefaultResponse
ListQueuesQueryParam
ListQueuesQueryParamProperties
ListWorkers
ListWorkers200Response

The request has succeeded.
ListWorkersDefaultHeaders
ListWorkersDefaultResponse
ListWorkersQueryParam
ListWorkersQueryParamProperties
LongestIdleMode

Jobs are directed to the worker who has been idle longest.
LongestIdleModeOutput

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.
ManualReclassifyExceptionActionOutput

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/
OAuth2WebhookClientCredentialOutput

OAuth2.0 Credentials used to Contoso's Authorization server. Reference: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
PagingOptions

Options for the paging helper
PassThroughQueueSelectorAttachment

Attaches a queue selector where the value is passed through from a job's label with the same key.
PassThroughQueueSelectorAttachmentOutput

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.
PassThroughWorkerSelectorAttachmentOutput

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.
QueueAndMatchModeOutput

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.
QueueLengthExceptionTriggerOutput

Trigger for an exception action on exceeding queue length.
QueueSelectorAttachmentOutputParent

An attachment of queue selectors to resolve a queue to a job from a classification policy.
QueueSelectorAttachmentParent

An attachment of queue selectors to resolve a queue to a job from a classification policy.
QueueWeightedAllocation

Contains the weight percentage and queue selectors to be applied if selected for weighted distributions.
QueueWeightedAllocationOutput

Contains the weight percentage and queue selectors to be applied if selected for weighted distributions.
Reclassify
Reclassify200Response

The request has succeeded.
ReclassifyBodyParam
ReclassifyDefaultHeaders
ReclassifyDefaultResponse
ReclassifyExceptionAction

An action that modifies labels on a job and then reclassifies it.
ReclassifyExceptionActionOutput

An action that modifies labels on a job and then reclassifies it.
ReclassifyJobOptions

Request payload for reclassifying jobs.
ReclassifyJobResultOutput

Response payload from reclassifying a job.
RoundRobinMode

Jobs are distributed in order to workers, starting with the worker that is after the last worker to receive a job.
RoundRobinModeOutput

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.
RouterChannelOutput

Represents the capacity a job in this channel will consume from a worker.
RouterConditionalRequestHeadersOutput

Provides the 'If-*' headers to enable conditional (cached) responses for JobRouter.
RouterJob

A unit of work to be routed
RouterJobAssignment

Assignment details of a job to a worker.
RouterJobAssignmentOutput

Assignment details of a job to a worker.
RouterJobNote

A note attached to a job.
RouterJobNoteOutput

A note attached to a job.
RouterJobOffer

An offer of a job to a worker.
RouterJobOfferOutput

An offer of a job to a worker.
RouterJobOutput

A unit of work to be routed
RouterJobPositionDetailsOutput

Position and estimated wait time for a job.
RouterQueue

A queue that can contain jobs to be routed.
RouterQueueOutput

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.
RouterQueueSelectorOutput

Describes a condition that must be met against a set of labels for queue selection.
RouterQueueStatisticsOutput

Statistics for the queue.
RouterRuleOutputParent

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.
RouterRuleParent

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.
RouterWorker

An entity for jobs to be routed to.
RouterWorkerAssignment

The assignment for a worker to a job.
RouterWorkerAssignmentOutput

The assignment for a worker to a job.
RouterWorkerOutput

An entity for jobs to be routed to.
RouterWorkerSelector

Describes a condition that must be met against a set of labels for worker selection.
RouterWorkerSelectorOutput

Describes a condition that must be met against a set of labels for worker selection.
Routes
RuleEngineQueueSelectorAttachment

Attaches queue selectors to a job when the RouterRule is resolved.
RuleEngineQueueSelectorAttachmentOutput

Attaches queue selectors to a job when the RouterRule is resolved.
RuleEngineWorkerSelectorAttachment

Attaches worker selectors to a job when a RouterRule is resolved.
RuleEngineWorkerSelectorAttachmentOutput

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.
ScheduleAndSuspendModeOutput

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.
ScoringRuleOptionsOutput

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.
StaticQueueSelectorAttachmentOutput

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.
StaticRouterRuleOutput

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.
StaticWorkerSelectorAttachmentOutput

Describes a worker selector that will be attached to a job.
SuspendMode

Describes a matching mode where matching worker to a job is suspended.
SuspendModeOutput

Describes a matching mode where matching worker to a job is suspended.
Unassign
Unassign200Response

The request has succeeded.
UnassignBodyParam
UnassignDefaultHeaders
UnassignDefaultResponse
UnassignJobOptions

Request payload for unassigning a job.
UnassignJobResultOutput

Response payload after a job has been successfully unassigned.
UpsertClassificationPolicy
UpsertClassificationPolicy200Headers
UpsertClassificationPolicy200Response

The request has succeeded.
UpsertClassificationPolicy201Headers
UpsertClassificationPolicy201Response

The request has succeeded and a new resource has been created as a result.
UpsertClassificationPolicyBodyParam
UpsertClassificationPolicyDefaultHeaders
UpsertClassificationPolicyDefaultResponse
UpsertClassificationPolicyHeaderParam
UpsertClassificationPolicyHeaders
UpsertClassificationPolicyMediaTypesParam
UpsertDistributionPolicy
UpsertDistributionPolicy200Headers
UpsertDistributionPolicy200Response

The request has succeeded.
UpsertDistributionPolicy201Headers
UpsertDistributionPolicy201Response

The request has succeeded and a new resource has been created as a result.
UpsertDistributionPolicyBodyParam
UpsertDistributionPolicyDefaultHeaders
UpsertDistributionPolicyDefaultResponse
UpsertDistributionPolicyHeaderParam
UpsertDistributionPolicyHeaders
UpsertDistributionPolicyMediaTypesParam
UpsertExceptionPolicy
UpsertExceptionPolicy200Headers
UpsertExceptionPolicy200Response

The request has succeeded.
UpsertExceptionPolicy201Headers
UpsertExceptionPolicy201Response

The request has succeeded and a new resource has been created as a result.
UpsertExceptionPolicyBodyParam
UpsertExceptionPolicyDefaultHeaders
UpsertExceptionPolicyDefaultResponse
UpsertExceptionPolicyHeaderParam
UpsertExceptionPolicyHeaders
UpsertExceptionPolicyMediaTypesParam
UpsertJob
UpsertJob200Headers
UpsertJob200Response

The request has succeeded.
UpsertJob201Headers
UpsertJob201Response

The request has succeeded and a new resource has been created as a result.
UpsertJobBodyParam
UpsertJobDefaultHeaders
UpsertJobDefaultResponse
UpsertJobHeaderParam
UpsertJobHeaders
UpsertJobMediaTypesParam
UpsertQueue
UpsertQueue200Headers
UpsertQueue200Response

The request has succeeded.
UpsertQueue201Headers
UpsertQueue201Response

The request has succeeded and a new resource has been created as a result.
UpsertQueueBodyParam
UpsertQueueDefaultHeaders
UpsertQueueDefaultResponse
UpsertQueueHeaderParam
UpsertQueueHeaders
UpsertQueueMediaTypesParam
UpsertWorker
UpsertWorker200Headers
UpsertWorker200Response

The request has succeeded.
UpsertWorker201Headers
UpsertWorker201Response

The request has succeeded and a new resource has been created as a result.
UpsertWorkerBodyParam
UpsertWorkerDefaultHeaders
UpsertWorkerDefaultResponse
UpsertWorkerHeaderParam
UpsertWorkerHeaders
UpsertWorkerMediaTypesParam
WaitTimeExceptionTrigger

Trigger for an exception action on exceeding wait time.
WaitTimeExceptionTriggerOutput

Trigger for an exception action on exceeding wait time.
WebhookRouterRule

A rule providing a binding to an external web server.
WebhookRouterRuleOutput

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.
WeightedAllocationQueueSelectorAttachmentOutput

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.
WeightedAllocationWorkerSelectorAttachmentOutput

Describes multiple sets of worker selectors, of which one will be selected and attached according to a weighting.
WorkerSelectorAttachmentOutputParent

An attachment which attaches worker selectors to a job.
WorkerSelectorAttachmentParent

An attachment which attaches worker selectors to a job.
WorkerWeightedAllocation

Contains the weight percentage and worker selectors to be applied if selected for weighted distributions.
WorkerWeightedAllocationOutput

Contains the weight percentage and worker selectors to be applied if selected for weighted distributions.

Type Aliases

AcceptParameters
AzureCommunicationRoutingServiceClient
CancelParameters
ClassificationPolicyResourceMergeAndPatch

The resource instance.
CloseParameters
CompleteParameters
DeclineParameters
DeleteClassificationPolicyParameters
DeleteDistributionPolicyParameters
DeleteExceptionPolicyParameters
DeleteJobParameters
DeleteQueueParameters
DeleteWorkerParameters
DistributionMode

Abstract base class for defining a distribution mode.
DistributionModeOutput

Abstract base class for defining a distribution mode.
DistributionPolicyResourceMergeAndPatch

The resource instance.
ExceptionAction

The action to take when the exception is triggered.
ExceptionActionOutput

The action to take when the exception is triggered.
ExceptionPolicyResourceMergeAndPatch

The resource instance.
ExceptionTrigger

Abstract base class for defining a trigger for exception rules.
ExceptionTriggerOutput

Abstract base class for defining a trigger for exception rules.
GetArrayType

Helper type to extract the type of an array
GetClassificationPolicyParameters
GetDistributionPolicyParameters
GetExceptionPolicyParameters
GetInQueuePositionParameters
GetJobParameters
GetPage

The type of a custom function that defines how to get a page and a link to the next one if any.
GetQueueParameters
GetQueueStatisticsParameters
GetWorkerParameters
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.
JobMatchingModeOutput

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.
ListClassificationPoliciesParameters
ListDistributionPoliciesParameters
ListExceptionPoliciesParameters
ListJobsParameters
ListQueuesParameters
ListWorkersParameters
PagedClassificationPolicyOutput

Paged collection of ClassificationPolicy items
PagedDistributionPolicyOutput

Paged collection of DistributionPolicy items
PagedExceptionPolicyOutput

Paged collection of ExceptionPolicy items
PagedRouterJobOutput

Paged collection of RouterJob items
PagedRouterQueueOutput

Paged collection of RouterQueue items
PagedRouterWorkerOutput

Paged collection of RouterWorker items
PaginateReturn

Helper type to infer the Type of the paged elements from the response type This type is generated based on the swagger information for x-ms-pageable specifically on the itemName property which indicates the property of the response where the page items are found. The default value is value. This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
QueueSelectorAttachment

An attachment of queue selectors to resolve a queue to a job from a classification policy.
QueueSelectorAttachmentOutput

An attachment of queue selectors to resolve a queue to a job from a classification policy.
ReclassifyParameters
RouterJobResourceMergeAndPatch

The resource instance.
RouterQueueResourceMergeAndPatch

The resource instance.
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.
RouterRuleOutput

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.
RouterWorkerResourceMergeAndPatch

The resource instance.
UnassignParameters
UpsertClassificationPolicyParameters
UpsertDistributionPolicyParameters
UpsertExceptionPolicyParameters
UpsertJobParameters
UpsertQueueParameters
UpsertWorkerParameters
WorkerSelectorAttachment

An attachment which attaches worker selectors to a job.
WorkerSelectorAttachmentOutput

An attachment which attaches worker selectors to a job.

Functions

default(string, ClientOptions)

Initialize a new instance of AzureCommunicationRoutingServiceClient
default(string, KeyCredential | TokenCredential, ClientOptions)

Initialize a new instance of AzureCommunicationRoutingServiceClient
isUnexpected(UpsertClassificationPolicy200Response | UpsertClassificationPolicy201Response | UpsertClassificationPolicyDefaultResponse)
isUnexpected(GetClassificationPolicy200Response | GetClassificationPolicyDefaultResponse)
isUnexpected(DeleteClassificationPolicy204Response | DeleteClassificationPolicyDefaultResponse)
isUnexpected(ListClassificationPolicies200Response | ListClassificationPoliciesDefaultResponse)
isUnexpected(UpsertDistributionPolicy200Response | UpsertDistributionPolicy201Response | UpsertDistributionPolicyDefaultResponse)
isUnexpected(GetDistributionPolicy200Response | GetDistributionPolicyDefaultResponse)
isUnexpected(DeleteDistributionPolicy204Response | DeleteDistributionPolicyDefaultResponse)
isUnexpected(ListDistributionPolicies200Response | ListDistributionPoliciesDefaultResponse)
isUnexpected(UpsertExceptionPolicy200Response | UpsertExceptionPolicy201Response | UpsertExceptionPolicyDefaultResponse)
isUnexpected(GetExceptionPolicy200Response | GetExceptionPolicyDefaultResponse)
isUnexpected(DeleteExceptionPolicy204Response | DeleteExceptionPolicyDefaultResponse)
isUnexpected(ListExceptionPolicies200Response | ListExceptionPoliciesDefaultResponse)
isUnexpected(UpsertQueue200Response | UpsertQueue201Response | UpsertQueueDefaultResponse)
isUnexpected(GetQueue200Response | GetQueueDefaultResponse)
isUnexpected(DeleteQueue204Response | DeleteQueueDefaultResponse)
isUnexpected(ListQueues200Response | ListQueuesDefaultResponse)
isUnexpected(UpsertJob200Response | UpsertJob201Response | UpsertJobDefaultResponse)
isUnexpected(GetJob200Response | GetJobDefaultResponse)
isUnexpected(DeleteJob204Response | DeleteJobDefaultResponse)
isUnexpected(Reclassify200Response | ReclassifyDefaultResponse)
isUnexpected(Cancel200Response | CancelDefaultResponse)
isUnexpected(Complete200Response | CompleteDefaultResponse)
isUnexpected(Close200Response | CloseDefaultResponse)
isUnexpected(ListJobs200Response | ListJobsDefaultResponse)
isUnexpected(GetInQueuePosition200Response | GetInQueuePositionDefaultResponse)
isUnexpected(Unassign200Response | UnassignDefaultResponse)
isUnexpected(Accept200Response | AcceptDefaultResponse)
isUnexpected(Decline200Response | DeclineDefaultResponse)
isUnexpected(GetQueueStatistics200Response | GetQueueStatisticsDefaultResponse)
isUnexpected(UpsertWorker200Response | UpsertWorker201Response | UpsertWorkerDefaultResponse)
isUnexpected(GetWorker200Response | GetWorkerDefaultResponse)
isUnexpected(DeleteWorker204Response | DeleteWorkerDefaultResponse)
isUnexpected(ListWorkers200Response | ListWorkersDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

Function Details

default(string, ClientOptions)

Initialize a new instance of AzureCommunicationRoutingServiceClient

function default(connectionString: string, options: ClientOptions): AzureCommunicationRoutingServiceClient

Parameters

connectionString

string

The connectionString or url of your Communication Services resource.

options
ClientOptions

the parameter for all optional parameters

Returns

AzureCommunicationRoutingServiceClient

default(string, KeyCredential | TokenCredential, ClientOptions)

Initialize a new instance of AzureCommunicationRoutingServiceClient

function default(endpoint: string, credentialOrOptions?: KeyCredential | TokenCredential, options?: ClientOptions): AzureCommunicationRoutingServiceClient

Parameters

endpoint

string

The endpoint of your Communication Services resource.

credentialOrOptions

KeyCredential | TokenCredential

The key or token credential.

options
ClientOptions

the parameter for all optional parameters

Returns

AzureCommunicationRoutingServiceClient

isUnexpected(UpsertClassificationPolicy200Response | UpsertClassificationPolicy201Response | UpsertClassificationPolicyDefaultResponse) 

function isUnexpected(response: UpsertClassificationPolicy200Response | UpsertClassificationPolicy201Response | UpsertClassificationPolicyDefaultResponse): response

Parameters

response

UpsertClassificationPolicy200Response | UpsertClassificationPolicy201Response | UpsertClassificationPolicyDefaultResponse

Returns

response

isUnexpected(GetClassificationPolicy200Response | GetClassificationPolicyDefaultResponse) 

function isUnexpected(response: GetClassificationPolicy200Response | GetClassificationPolicyDefaultResponse): response

Parameters

response

GetClassificationPolicy200Response | GetClassificationPolicyDefaultResponse

Returns

response

isUnexpected(DeleteClassificationPolicy204Response | DeleteClassificationPolicyDefaultResponse) 

function isUnexpected(response: DeleteClassificationPolicy204Response | DeleteClassificationPolicyDefaultResponse): response

Parameters

response

DeleteClassificationPolicy204Response | DeleteClassificationPolicyDefaultResponse

Returns

response

isUnexpected(ListClassificationPolicies200Response | ListClassificationPoliciesDefaultResponse) 

function isUnexpected(response: ListClassificationPolicies200Response | ListClassificationPoliciesDefaultResponse): response

Parameters

response

ListClassificationPolicies200Response | ListClassificationPoliciesDefaultResponse

Returns

response

isUnexpected(UpsertDistributionPolicy200Response | UpsertDistributionPolicy201Response | UpsertDistributionPolicyDefaultResponse) 

function isUnexpected(response: UpsertDistributionPolicy200Response | UpsertDistributionPolicy201Response | UpsertDistributionPolicyDefaultResponse): response

Parameters

response

UpsertDistributionPolicy200Response | UpsertDistributionPolicy201Response | UpsertDistributionPolicyDefaultResponse

Returns

response

isUnexpected(GetDistributionPolicy200Response | GetDistributionPolicyDefaultResponse) 

function isUnexpected(response: GetDistributionPolicy200Response | GetDistributionPolicyDefaultResponse): response

Parameters

response

GetDistributionPolicy200Response | GetDistributionPolicyDefaultResponse

Returns

response

isUnexpected(DeleteDistributionPolicy204Response | DeleteDistributionPolicyDefaultResponse) 

function isUnexpected(response: DeleteDistributionPolicy204Response | DeleteDistributionPolicyDefaultResponse): response

Parameters

response

DeleteDistributionPolicy204Response | DeleteDistributionPolicyDefaultResponse

Returns

response

isUnexpected(ListDistributionPolicies200Response | ListDistributionPoliciesDefaultResponse) 

function isUnexpected(response: ListDistributionPolicies200Response | ListDistributionPoliciesDefaultResponse): response

Parameters

response

ListDistributionPolicies200Response | ListDistributionPoliciesDefaultResponse

Returns

response

isUnexpected(UpsertExceptionPolicy200Response | UpsertExceptionPolicy201Response | UpsertExceptionPolicyDefaultResponse) 

function isUnexpected(response: UpsertExceptionPolicy200Response | UpsertExceptionPolicy201Response | UpsertExceptionPolicyDefaultResponse): response

Parameters

response

UpsertExceptionPolicy200Response | UpsertExceptionPolicy201Response | UpsertExceptionPolicyDefaultResponse

Returns

response

isUnexpected(GetExceptionPolicy200Response | GetExceptionPolicyDefaultResponse) 

function isUnexpected(response: GetExceptionPolicy200Response | GetExceptionPolicyDefaultResponse): response

Parameters

response

GetExceptionPolicy200Response | GetExceptionPolicyDefaultResponse

Returns

response

isUnexpected(DeleteExceptionPolicy204Response | DeleteExceptionPolicyDefaultResponse) 

function isUnexpected(response: DeleteExceptionPolicy204Response | DeleteExceptionPolicyDefaultResponse): response

Parameters

response

DeleteExceptionPolicy204Response | DeleteExceptionPolicyDefaultResponse

Returns

response

isUnexpected(ListExceptionPolicies200Response | ListExceptionPoliciesDefaultResponse) 

function isUnexpected(response: ListExceptionPolicies200Response | ListExceptionPoliciesDefaultResponse): response

Parameters

response

ListExceptionPolicies200Response | ListExceptionPoliciesDefaultResponse

Returns

response

isUnexpected(UpsertQueue200Response | UpsertQueue201Response | UpsertQueueDefaultResponse) 

function isUnexpected(response: UpsertQueue200Response | UpsertQueue201Response | UpsertQueueDefaultResponse): response

Parameters

response

UpsertQueue200Response | UpsertQueue201Response | UpsertQueueDefaultResponse

Returns

response

isUnexpected(GetQueue200Response | GetQueueDefaultResponse) 

function isUnexpected(response: GetQueue200Response | GetQueueDefaultResponse): response

Parameters

response

GetQueue200Response | GetQueueDefaultResponse

Returns

response

isUnexpected(DeleteQueue204Response | DeleteQueueDefaultResponse) 

function isUnexpected(response: DeleteQueue204Response | DeleteQueueDefaultResponse): response

Parameters

response

DeleteQueue204Response | DeleteQueueDefaultResponse

Returns

response

isUnexpected(ListQueues200Response | ListQueuesDefaultResponse) 

function isUnexpected(response: ListQueues200Response | ListQueuesDefaultResponse): response

Parameters

response

ListQueues200Response | ListQueuesDefaultResponse

Returns

response

isUnexpected(UpsertJob200Response | UpsertJob201Response | UpsertJobDefaultResponse) 

function isUnexpected(response: UpsertJob200Response | UpsertJob201Response | UpsertJobDefaultResponse): response

Parameters

response

UpsertJob200Response | UpsertJob201Response | UpsertJobDefaultResponse

Returns

response

isUnexpected(GetJob200Response | GetJobDefaultResponse) 

function isUnexpected(response: GetJob200Response | GetJobDefaultResponse): response

Parameters

response

GetJob200Response | GetJobDefaultResponse

Returns

response

isUnexpected(DeleteJob204Response | DeleteJobDefaultResponse) 

function isUnexpected(response: DeleteJob204Response | DeleteJobDefaultResponse): response

Parameters

response

DeleteJob204Response | DeleteJobDefaultResponse

Returns

response

isUnexpected(Reclassify200Response | ReclassifyDefaultResponse) 

function isUnexpected(response: Reclassify200Response | ReclassifyDefaultResponse): response

Parameters

response

Reclassify200Response | ReclassifyDefaultResponse

Returns

response

isUnexpected(Cancel200Response | CancelDefaultResponse) 

function isUnexpected(response: Cancel200Response | CancelDefaultResponse): response

Parameters

response

Cancel200Response | CancelDefaultResponse

Returns

response

isUnexpected(Complete200Response | CompleteDefaultResponse) 

function isUnexpected(response: Complete200Response | CompleteDefaultResponse): response

Parameters

response

Complete200Response | CompleteDefaultResponse

Returns

response

isUnexpected(Close200Response | CloseDefaultResponse) 

function isUnexpected(response: Close200Response | CloseDefaultResponse): response

Parameters

response

Close200Response | CloseDefaultResponse

Returns

response

isUnexpected(ListJobs200Response | ListJobsDefaultResponse) 

function isUnexpected(response: ListJobs200Response | ListJobsDefaultResponse): response

Parameters

response

ListJobs200Response | ListJobsDefaultResponse

Returns

response

isUnexpected(GetInQueuePosition200Response | GetInQueuePositionDefaultResponse) 

function isUnexpected(response: GetInQueuePosition200Response | GetInQueuePositionDefaultResponse): response

Parameters

response

GetInQueuePosition200Response | GetInQueuePositionDefaultResponse

Returns

response

isUnexpected(Unassign200Response | UnassignDefaultResponse) 

function isUnexpected(response: Unassign200Response | UnassignDefaultResponse): response

Parameters

response

Unassign200Response | UnassignDefaultResponse

Returns

response

isUnexpected(Accept200Response | AcceptDefaultResponse) 

function isUnexpected(response: Accept200Response | AcceptDefaultResponse): response

Parameters

response

Accept200Response | AcceptDefaultResponse

Returns

response

isUnexpected(Decline200Response | DeclineDefaultResponse) 

function isUnexpected(response: Decline200Response | DeclineDefaultResponse): response

Parameters

response

Decline200Response | DeclineDefaultResponse

Returns

response

isUnexpected(GetQueueStatistics200Response | GetQueueStatisticsDefaultResponse) 

function isUnexpected(response: GetQueueStatistics200Response | GetQueueStatisticsDefaultResponse): response

Parameters

response

GetQueueStatistics200Response | GetQueueStatisticsDefaultResponse

Returns

response

isUnexpected(UpsertWorker200Response | UpsertWorker201Response | UpsertWorkerDefaultResponse) 

function isUnexpected(response: UpsertWorker200Response | UpsertWorker201Response | UpsertWorkerDefaultResponse): response

Parameters

response

UpsertWorker200Response | UpsertWorker201Response | UpsertWorkerDefaultResponse

Returns

response

isUnexpected(GetWorker200Response | GetWorkerDefaultResponse) 

function isUnexpected(response: GetWorker200Response | GetWorkerDefaultResponse): response

Parameters

response

GetWorker200Response | GetWorkerDefaultResponse

Returns

response

isUnexpected(DeleteWorker204Response | DeleteWorkerDefaultResponse) 

function isUnexpected(response: DeleteWorker204Response | DeleteWorkerDefaultResponse): response

Parameters

response

DeleteWorker204Response | DeleteWorkerDefaultResponse

Returns

response

isUnexpected(ListWorkers200Response | ListWorkersDefaultResponse) 

function isUnexpected(response: ListWorkers200Response | ListWorkersDefaultResponse): response

Parameters

response

ListWorkers200Response | ListWorkersDefaultResponse

Returns

response

paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>

Parameters

client
Client

Client to use for sending the next page requests

initialResponse

TResponse

Initial response containing the nextLink and current page of elements

options

PagingOptions<TResponse>

Returns

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

  • PagedAsyncIterableIterator to iterate the elements