JobRouterClient class
执行作业路由器作的客户端。
构造函数
| Job |
使用 TokenCredential 构造 JobRouterClient 的实例。 |
| Job |
构造 JobRouterClient 的实例。 |
| Job |
使用 Azure KeyCredential 构造 JobRouterClient 的实例。 |
方法
| accept |
接受工作机会。 |
| cancel |
取消作业。 |
| close |
关闭作业。 |
| complete |
完成作业。 |
| create |
创建作业。 |
| create |
创建 worker。 |
| decline |
拒绝工作机会。 |
| delete |
删除作业。 |
| delete |
删除 worker。 |
| get |
获取作业。 |
| get |
获取作业的队列位置。 |
| get |
获取队列的统计信息。 |
| get |
获取 worker。 |
| list |
获取作业列表。 |
| list |
获取 worker 列表。 |
| reclassify |
更新作业并强制对其进行重新分类。 |
| unassign |
取消分配作业。 |
| update |
更新作业。 |
| update |
更新 worker。 |
构造函数详细信息
JobRouterClient(string, CommunicationTokenCredential, JobRouterClientOptions)
使用 TokenCredential 构造 JobRouterClient 的实例。
new JobRouterClient(endpoint: string, credential: CommunicationTokenCredential, options?: JobRouterClientOptions)参数
- endpoint
-
string
服务的终结点（例如：https://contoso.eastus.communications.azure.net）。
- credential
- CommunicationTokenCredential
CommunicationTokenCredential 用于对服务请求进行身份验证。
- options
- JobRouterClientOptions
（可选）用于配置 HTTP 管道的选项。
JobRouterClient(string, JobRouterClientOptions)
构造 JobRouterClient 的实例。
new JobRouterClient(connectionString: string, options?: JobRouterClientOptions)参数
- connectionString
-
string
用于连接到 Azure 通信服务资源的连接字符串。 （例如：“endpoint=https://contoso.eastus.communications.azure.net/;accesskey=secret”）。
- options
- JobRouterClientOptions
（可选）用于配置 HTTP 管道的选项。
JobRouterClient(string, KeyCredential | TokenCredential, JobRouterClientOptions)
使用 Azure KeyCredential 构造 JobRouterClient 的实例。
new JobRouterClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: JobRouterClientOptions)参数
- endpoint
-
string
服务的终结点（例如：https://contoso.eastus.communications.azure.net）。
- credential
用于对服务的请求进行身份验证的对象。 使用 Azure KeyCredential 或 @azure/identity TokenCredential 创建凭据。
- options
- JobRouterClientOptions
（可选）usingOptions 配置 HTTP 管道。
方法详细信息
acceptJobOffer(string, string, OperationOptions)
接受工作机会。
function acceptJobOffer(workerId: string, offerId: string, options?: OperationOptions): Promise<AcceptJobOfferResponse>参数
- workerId
-
string
接受作业的工作程序的 ID。
- offerId
-
string
要接受的选件的 ID。
- options
- OperationOptions
接受工作机会的选项。
返回
Promise<AcceptJobOfferResponse>
cancelJob(string, CancelJobOptions)
取消作业。
function cancelJob(jobId: string, options?: CancelJobOptions): Promise<CancelJobResponse>参数
- jobId
-
string
要取消的任务的 ID。
- options
- CancelJobOptions
用于取消作业的选项。
返回
Promise<CancelJobResponse>
closeJob(string, string, CloseJobOptions)
关闭作业。
function closeJob(jobId: string, assignmentId: string, options?: CloseJobOptions): Promise<CloseJobResponse>参数
- jobId
-
string
要关闭的任务的 ID。
- assignmentId
-
string
与要关闭的作业对应的分配 ID。
- options
- CloseJobOptions
用于关闭作业的选项。
返回
Promise<CloseJobResponse>
completeJob(string, string, CompleteJobOptions)
完成作业。
function completeJob(jobId: string, assignmentId: string, options?: CompleteJobOptions): Promise<CompleteJobResponse>参数
- jobId
-
string
要完成的作业的 ID。
- assignmentId
-
string
要完成的分配的 ID。
- options
- CompleteJobOptions
用于完成作业的选项。
返回
Promise<CompleteJobResponse>
createJob(string, CreateJobOptions)
创建作业。
function createJob(jobId: string, options?: CreateJobOptions): Promise<RouterJobResponse>参数
- jobId
-
string
要创建的作业的 ID。
- options
- CreateJobOptions
用于创建任务的选项。
返回
Promise<RouterJobResponse>
- 创建的作业。
createWorker(string, CreateWorkerOptions)
创建 worker。
function createWorker(workerId: string, options?: CreateWorkerOptions): Promise<RouterWorkerResponse>参数
- workerId
-
string
要创建的 worker 的 id。
- options
- CreateWorkerOptions
用于创建 worker 的选项。
返回
Promise<RouterWorkerResponse>
- 创建的 worker。
declineJobOffer(string, string, DeclineJobOfferOptions)
拒绝工作机会。
function declineJobOffer(workerId: string, offerId: string, options?: DeclineJobOfferOptions): Promise<DeclineJobOfferResponse>参数
- workerId
-
string
持有 offer 的工作程序的 ID。
- offerId
-
string
要拒绝的选件的 ID。
- options
- DeclineJobOfferOptions
拒绝工作机会的选项。
返回
Promise<DeclineJobOfferResponse>
deleteJob(string, OperationOptions)
删除作业。
function deleteJob(jobId: string, options?: OperationOptions): Promise<void>参数
- jobId
-
string
要删除的任务的 ID。
- options
- OperationOptions
用于删除作业的选项。
返回
Promise<void>
deleteWorker(string, OperationOptions)
删除 worker。
function deleteWorker(workerId: string, options?: OperationOptions): Promise<void>参数
- workerId
-
string
要删除的工作程序的 ID。
- options
- OperationOptions
用于删除工作程序的选项。
返回
Promise<void>
getJob(string, OperationOptions)
获取作业。
function getJob(jobId: string, options?: OperationOptions): Promise<RouterJobResponse>参数
- jobId
-
string
要获取的任务的 ID。
- options
- OperationOptions
找工作的选择。
返回
Promise<RouterJobResponse>
- 作业。
getJobQueuePosition(string, OperationOptions)
获取作业的队列位置。
function getJobQueuePosition(jobId: string, options?: OperationOptions): Promise<RouterJobPositionDetails>参数
- jobId
-
string
要获取其队列位置的作业的 ID。
- options
- OperationOptions
用于获取作业队列位置的选项。
返回
Promise<RouterJobPositionDetails>
- 作业的队列位置。
getQueueStatistics(string, OperationOptions)
获取队列的统计信息。
function getQueueStatistics(queueId: string, options?: OperationOptions): Promise<RouterQueueStatistics>参数
- queueId
-
string
要获取其统计信息的队列的 ID。
- options
- OperationOptions
用于获取队列统计信息的选项。
返回
Promise<RouterQueueStatistics>
- 队列的统计信息。
getWorker(string, OperationOptions)
获取 worker。
function getWorker(workerId: string, options?: OperationOptions): Promise<RouterWorkerResponse>参数
- workerId
-
string
要获取的工作程序的 ID。
- options
- OperationOptions
获取 worker 的选项。
返回
Promise<RouterWorkerResponse>
- 工人。
listJobs(ListJobsOptions)
获取作业列表。
function listJobs(options?: ListJobsOptions): TransformingPagedAsyncIterableIterator<RouterJobItem_2, RouterJobItem, RouterJobItem_2[], RouterJobItem[], PageSettings>参数
- options
- ListJobsOptions
用于列出作业的选项。
返回
TransformingPagedAsyncIterableIterator<RouterJobItem_2, RouterJobItem, RouterJobItem_2[], RouterJobItem[], PageSettings>
- 职位的列表。
listWorkers(ListWorkersOptions)
获取 worker 列表。
function listWorkers(options?: ListWorkersOptions): TransformingPagedAsyncIterableIterator<RouterWorkerItem_2, RouterWorkerItem, RouterWorkerItem_2[], RouterWorkerItem[], PageSettings>参数
- options
- ListWorkersOptions
列出工作人员的选项。
返回
TransformingPagedAsyncIterableIterator<RouterWorkerItem_2, RouterWorkerItem, RouterWorkerItem_2[], RouterWorkerItem[], PageSettings>
- worker 列表。
reclassifyJob(string, ReclassifyJobOptions)
更新作业并强制对其进行重新分类。
function reclassifyJob(jobId: string, options?: ReclassifyJobOptions): Promise<ReclassifyJobResponse>参数
- jobId
-
string
要重新分类的任务的 ID。
- options
- ReclassifyJobOptions
用于对作业进行重新分类的选项。
返回
Promise<ReclassifyJobResponse>
unassignJob(string, string, UnassignJobOptions)
取消分配作业。
function unassignJob(jobId: string, assignmentId: string, options?: UnassignJobOptions): Promise<UnassignJobResponse>参数
- jobId
-
string
要取消分配的作业的 ID。
- assignmentId
-
string
与要取消分配的作业对应的分配 ID。
- options
- UnassignJobOptions
用于取消分配作业的选项。
返回
Promise<UnassignJobResponse>
updateJob(string, UpdateJobOptions)
更新作业。
function updateJob(jobId: string, options?: UpdateJobOptions): Promise<RouterJobResponse>参数
- jobId
-
string
要更新的作业的 ID。
- options
- UpdateJobOptions
用于更新作业的选项。 使用合并补丁语义： https://datatracker.ietf.org/doc/html/rfc7386.
返回
Promise<RouterJobResponse>
- 更新后的作业。
updateWorker(string, UpdateWorkerOptions)
更新 worker。
function updateWorker(workerId: string, options?: UpdateWorkerOptions): Promise<RouterWorkerResponse>参数
- workerId
-
string
要更新的工作程序的 ID。
- options
- UpdateWorkerOptions
用于更新 worker 的选项。 使用合并补丁语义： https://datatracker.ietf.org/doc/html/rfc7386.
返回
Promise<RouterWorkerResponse>
- 更新后的工作程序。
