@azure-rest/communication-job-router 1.1.0-beta.1 → 1.1.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +168 -115
- package/dist/browser/azureCommunicationRoutingServiceClient.d.ts +14 -0
- package/dist/browser/azureCommunicationRoutingServiceClient.d.ts.map +1 -0
- package/dist/browser/azureCommunicationRoutingServiceClient.js +40 -0
- package/dist/browser/azureCommunicationRoutingServiceClient.js.map +1 -0
- package/dist/browser/azureCommunicationRoutingServiceCustmizedClient.d.ts +17 -0
- package/dist/browser/azureCommunicationRoutingServiceCustmizedClient.d.ts.map +1 -0
- package/dist/browser/azureCommunicationRoutingServiceCustmizedClient.js +29 -0
- package/dist/browser/azureCommunicationRoutingServiceCustmizedClient.js.map +1 -0
- package/dist/browser/clientDefinitions.d.ts +159 -0
- package/dist/browser/clientDefinitions.d.ts.map +1 -0
- package/dist/browser/clientDefinitions.js +4 -0
- package/dist/browser/clientDefinitions.js.map +1 -0
- package/dist/browser/index.d.ts +11 -0
- package/dist/browser/index.d.ts.map +1 -0
- package/dist/browser/index.js +13 -0
- package/dist/browser/index.js.map +1 -0
- package/dist/browser/isUnexpected.d.ts +35 -0
- package/dist/browser/isUnexpected.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/isUnexpected.js +1 -1
- package/dist/browser/isUnexpected.js.map +1 -0
- package/dist/browser/logger.d.ts +2 -0
- package/dist/browser/logger.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/logger.js +1 -1
- package/{dist-esm/src → dist/browser}/logger.js.map +1 -1
- package/dist/browser/models.d.ts +562 -0
- package/dist/browser/models.d.ts.map +1 -0
- package/dist/browser/models.js +4 -0
- package/dist/browser/models.js.map +1 -0
- package/dist/browser/outputModels.d.ts +683 -0
- package/dist/browser/outputModels.d.ts.map +1 -0
- package/dist/browser/outputModels.js +4 -0
- package/dist/browser/outputModels.js.map +1 -0
- package/dist/browser/package.json +3 -0
- package/dist/browser/paginateHelper.d.ts +68 -0
- package/dist/browser/paginateHelper.d.ts.map +1 -0
- package/dist/browser/paginateHelper.js +167 -0
- package/dist/browser/paginateHelper.js.map +1 -0
- package/dist/browser/parameters.d.ts +245 -0
- package/dist/browser/parameters.d.ts.map +1 -0
- package/dist/browser/parameters.js +4 -0
- package/dist/browser/parameters.js.map +1 -0
- package/dist/browser/responses.d.ts +616 -0
- package/dist/browser/responses.d.ts.map +1 -0
- package/dist/browser/responses.js +4 -0
- package/dist/browser/responses.js.map +1 -0
- package/dist/commonjs/azureCommunicationRoutingServiceClient.d.ts +14 -0
- package/dist/commonjs/azureCommunicationRoutingServiceClient.d.ts.map +1 -0
- package/dist/commonjs/azureCommunicationRoutingServiceClient.js +43 -0
- package/dist/commonjs/azureCommunicationRoutingServiceClient.js.map +1 -0
- package/dist/commonjs/azureCommunicationRoutingServiceCustmizedClient.d.ts +17 -0
- package/dist/commonjs/azureCommunicationRoutingServiceCustmizedClient.d.ts.map +1 -0
- package/dist/commonjs/azureCommunicationRoutingServiceCustmizedClient.js +33 -0
- package/dist/commonjs/azureCommunicationRoutingServiceCustmizedClient.js.map +1 -0
- package/dist/commonjs/clientDefinitions.d.ts +159 -0
- package/dist/commonjs/clientDefinitions.d.ts.map +1 -0
- package/dist/commonjs/clientDefinitions.js +5 -0
- package/dist/commonjs/clientDefinitions.js.map +1 -0
- package/dist/commonjs/index.d.ts +11 -0
- package/dist/commonjs/index.d.ts.map +1 -0
- package/dist/commonjs/index.js +16 -0
- package/dist/commonjs/index.js.map +1 -0
- package/dist/commonjs/isUnexpected.d.ts +35 -0
- package/dist/commonjs/isUnexpected.d.ts.map +1 -0
- package/dist/commonjs/isUnexpected.js +105 -0
- package/dist/commonjs/isUnexpected.js.map +1 -0
- package/dist/commonjs/logger.d.ts +2 -0
- package/dist/commonjs/logger.d.ts.map +1 -0
- package/dist/commonjs/logger.js +8 -0
- package/dist/commonjs/logger.js.map +1 -0
- package/dist/commonjs/models.d.ts +562 -0
- package/dist/commonjs/models.d.ts.map +1 -0
- package/dist/commonjs/models.js +5 -0
- package/dist/commonjs/models.js.map +1 -0
- package/dist/commonjs/outputModels.d.ts +683 -0
- package/dist/commonjs/outputModels.d.ts.map +1 -0
- package/dist/commonjs/outputModels.js +5 -0
- package/dist/commonjs/outputModels.js.map +1 -0
- package/dist/commonjs/package.json +3 -0
- package/dist/commonjs/paginateHelper.d.ts +68 -0
- package/dist/commonjs/paginateHelper.d.ts.map +1 -0
- package/dist/commonjs/paginateHelper.js +170 -0
- package/dist/commonjs/paginateHelper.js.map +1 -0
- package/dist/commonjs/parameters.d.ts +245 -0
- package/dist/commonjs/parameters.d.ts.map +1 -0
- package/dist/commonjs/parameters.js +5 -0
- package/dist/commonjs/parameters.js.map +1 -0
- package/dist/commonjs/responses.d.ts +616 -0
- package/dist/commonjs/responses.d.ts.map +1 -0
- package/dist/commonjs/responses.js +5 -0
- package/dist/commonjs/responses.js.map +1 -0
- package/dist/commonjs/tsdoc-metadata.json +11 -0
- package/dist/esm/azureCommunicationRoutingServiceClient.d.ts +14 -0
- package/dist/esm/azureCommunicationRoutingServiceClient.d.ts.map +1 -0
- package/dist/esm/azureCommunicationRoutingServiceClient.js +40 -0
- package/dist/esm/azureCommunicationRoutingServiceClient.js.map +1 -0
- package/dist/esm/azureCommunicationRoutingServiceCustmizedClient.d.ts +17 -0
- package/dist/esm/azureCommunicationRoutingServiceCustmizedClient.d.ts.map +1 -0
- package/dist/esm/azureCommunicationRoutingServiceCustmizedClient.js +29 -0
- package/dist/esm/azureCommunicationRoutingServiceCustmizedClient.js.map +1 -0
- package/dist/esm/clientDefinitions.d.ts +159 -0
- package/dist/esm/clientDefinitions.d.ts.map +1 -0
- package/dist/esm/clientDefinitions.js +4 -0
- package/dist/esm/clientDefinitions.js.map +1 -0
- package/dist/esm/index.d.ts +11 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +13 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/isUnexpected.d.ts +35 -0
- package/dist/esm/isUnexpected.d.ts.map +1 -0
- package/dist/esm/isUnexpected.js +102 -0
- package/dist/esm/isUnexpected.js.map +1 -0
- package/dist/esm/logger.d.ts +2 -0
- package/dist/esm/logger.d.ts.map +1 -0
- package/dist/esm/logger.js +5 -0
- package/dist/esm/logger.js.map +1 -0
- package/dist/esm/models.d.ts +562 -0
- package/dist/esm/models.d.ts.map +1 -0
- package/dist/esm/models.js +4 -0
- package/dist/esm/models.js.map +1 -0
- package/dist/esm/outputModels.d.ts +683 -0
- package/dist/esm/outputModels.d.ts.map +1 -0
- package/dist/esm/outputModels.js +4 -0
- package/dist/esm/outputModels.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/paginateHelper.d.ts +68 -0
- package/dist/esm/paginateHelper.d.ts.map +1 -0
- package/dist/esm/paginateHelper.js +167 -0
- package/dist/esm/paginateHelper.js.map +1 -0
- package/dist/esm/parameters.d.ts +245 -0
- package/dist/esm/parameters.d.ts.map +1 -0
- package/dist/esm/parameters.js +4 -0
- package/dist/esm/parameters.js.map +1 -0
- package/dist/esm/responses.d.ts +616 -0
- package/dist/esm/responses.d.ts.map +1 -0
- package/dist/esm/responses.js +4 -0
- package/dist/esm/responses.js.map +1 -0
- package/dist/react-native/azureCommunicationRoutingServiceClient.d.ts +14 -0
- package/dist/react-native/azureCommunicationRoutingServiceClient.d.ts.map +1 -0
- package/dist/react-native/azureCommunicationRoutingServiceClient.js +40 -0
- package/dist/react-native/azureCommunicationRoutingServiceClient.js.map +1 -0
- package/dist/react-native/azureCommunicationRoutingServiceCustmizedClient.d.ts +17 -0
- package/dist/react-native/azureCommunicationRoutingServiceCustmizedClient.d.ts.map +1 -0
- package/dist/react-native/azureCommunicationRoutingServiceCustmizedClient.js +29 -0
- package/dist/react-native/azureCommunicationRoutingServiceCustmizedClient.js.map +1 -0
- package/dist/react-native/clientDefinitions.d.ts +159 -0
- package/dist/react-native/clientDefinitions.d.ts.map +1 -0
- package/dist/react-native/clientDefinitions.js +4 -0
- package/dist/react-native/clientDefinitions.js.map +1 -0
- package/dist/react-native/index.d.ts +11 -0
- package/dist/react-native/index.d.ts.map +1 -0
- package/dist/react-native/index.js +13 -0
- package/dist/react-native/index.js.map +1 -0
- package/dist/react-native/isUnexpected.d.ts +35 -0
- package/dist/react-native/isUnexpected.d.ts.map +1 -0
- package/dist/react-native/isUnexpected.js +102 -0
- package/dist/react-native/isUnexpected.js.map +1 -0
- package/dist/react-native/logger.d.ts +2 -0
- package/dist/react-native/logger.d.ts.map +1 -0
- package/dist/react-native/logger.js +5 -0
- package/dist/react-native/logger.js.map +1 -0
- package/dist/react-native/models.d.ts +562 -0
- package/dist/react-native/models.d.ts.map +1 -0
- package/dist/react-native/models.js +4 -0
- package/dist/react-native/models.js.map +1 -0
- package/dist/react-native/outputModels.d.ts +683 -0
- package/dist/react-native/outputModels.d.ts.map +1 -0
- package/dist/react-native/outputModels.js +4 -0
- package/dist/react-native/outputModels.js.map +1 -0
- package/dist/react-native/package.json +3 -0
- package/dist/react-native/paginateHelper.d.ts +68 -0
- package/dist/react-native/paginateHelper.d.ts.map +1 -0
- package/dist/react-native/paginateHelper.js +167 -0
- package/dist/react-native/paginateHelper.js.map +1 -0
- package/dist/react-native/parameters.d.ts +245 -0
- package/dist/react-native/parameters.d.ts.map +1 -0
- package/dist/react-native/parameters.js +4 -0
- package/dist/react-native/parameters.js.map +1 -0
- package/dist/react-native/responses.d.ts +616 -0
- package/dist/react-native/responses.d.ts.map +1 -0
- package/dist/react-native/responses.js +4 -0
- package/dist/react-native/responses.js.map +1 -0
- package/package.json +79 -63
- package/dist/index.js +0 -229
- package/dist/index.js.map +0 -1
- package/dist-esm/src/azureCommunicationRoutingServiceClient.js +0 -42
- package/dist-esm/src/azureCommunicationRoutingServiceClient.js.map +0 -1
- package/dist-esm/src/clientDefinitions.js +0 -4
- package/dist-esm/src/clientDefinitions.js.map +0 -1
- package/dist-esm/src/index.js +0 -13
- package/dist-esm/src/index.js.map +0 -1
- package/dist-esm/src/isUnexpected.js.map +0 -1
- package/dist-esm/src/models.js +0 -4
- package/dist-esm/src/models.js.map +0 -1
- package/dist-esm/src/outputModels.js +0 -4
- package/dist-esm/src/outputModels.js.map +0 -1
- package/dist-esm/src/paginateHelper.js +0 -70
- package/dist-esm/src/paginateHelper.js.map +0 -1
- package/dist-esm/src/parameters.js +0 -4
- package/dist-esm/src/parameters.js.map +0 -1
- package/dist-esm/src/responses.js +0 -4
- package/dist-esm/src/responses.js.map +0 -1
- package/review/communication-job-router.api.md +0 -2485
- package/types/communication-job-router.d.ts +0 -2677
|
@@ -1,2677 +0,0 @@
|
|
|
1
|
-
import { Client } from '@azure-rest/core-client';
|
|
2
|
-
import { ClientOptions } from '@azure-rest/core-client';
|
|
3
|
-
import { ErrorResponse } from '@azure-rest/core-client';
|
|
4
|
-
import { HttpResponse } from '@azure-rest/core-client';
|
|
5
|
-
import { KeyCredential } from '@azure/core-auth';
|
|
6
|
-
import { Paged } from '@azure/core-paging';
|
|
7
|
-
import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
|
8
|
-
import { PathUncheckedResponse } from '@azure-rest/core-client';
|
|
9
|
-
import { RawHttpHeaders } from '@azure/core-rest-pipeline';
|
|
10
|
-
import { RawHttpHeadersInput } from '@azure/core-rest-pipeline';
|
|
11
|
-
import { RequestParameters } from '@azure-rest/core-client';
|
|
12
|
-
import { StreamableMethod } from '@azure-rest/core-client';
|
|
13
|
-
import { TokenCredential } from '@azure/core-auth';
|
|
14
|
-
|
|
15
|
-
export declare interface Accept {
|
|
16
|
-
/** Accepts an offer to work on a job and returns a 409/Conflict if another agent accepted the job already. */
|
|
17
|
-
post(options?: AcceptParameters): StreamableMethod<Accept200Response | AcceptDefaultResponse>;
|
|
18
|
-
}
|
|
19
|
-
|
|
20
|
-
/** The request has succeeded. */
|
|
21
|
-
export declare interface Accept200Response extends HttpResponse {
|
|
22
|
-
status: "200";
|
|
23
|
-
body: AcceptJobOfferResultOutput;
|
|
24
|
-
}
|
|
25
|
-
|
|
26
|
-
export declare interface AcceptDefaultHeaders {
|
|
27
|
-
/** String error code indicating what went wrong. */
|
|
28
|
-
"x-ms-error-code"?: string;
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
export declare interface AcceptDefaultResponse extends HttpResponse {
|
|
32
|
-
status: string;
|
|
33
|
-
body: ErrorResponse;
|
|
34
|
-
headers: RawHttpHeaders & AcceptDefaultHeaders;
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
/** Response containing ids for the worker, job, and assignment from an accepted offer. */
|
|
38
|
-
export declare interface AcceptJobOfferResultOutput {
|
|
39
|
-
/** Id of job assignment that assigns a worker that has accepted an offer to a job. */
|
|
40
|
-
assignmentId: string;
|
|
41
|
-
/** Id of the job assigned. */
|
|
42
|
-
jobId: string;
|
|
43
|
-
/** Id of the worker that has been assigned this job. */
|
|
44
|
-
workerId: string;
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
export declare type AcceptParameters = RequestParameters;
|
|
48
|
-
|
|
49
|
-
export declare type AzureCommunicationRoutingServiceClient = Client & {
|
|
50
|
-
path: Routes;
|
|
51
|
-
};
|
|
52
|
-
|
|
53
|
-
/** Jobs are distributed to the worker with the strongest abilities available. */
|
|
54
|
-
export declare interface BestWorkerMode extends DistributionModeParent {
|
|
55
|
-
/** Define a scoring rule to use, when calculating a score to determine the best worker. If not set, will use a default scoring formula that uses the number of job labels that the worker labels match, as well as the number of label selectors the worker labels match and/or exceed using a logistic function (https://en.wikipedia.org/wiki/Logistic_function). */
|
|
56
|
-
scoringRule?: RouterRule;
|
|
57
|
-
/** Options to configure 'scoringRule'. If not set, default values are used. */
|
|
58
|
-
scoringRuleOptions?: ScoringRuleOptions;
|
|
59
|
-
/** The type discriminator describing a sub-type of Mode */
|
|
60
|
-
kind: "bestWorker";
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
/** Jobs are distributed to the worker with the strongest abilities available. */
|
|
64
|
-
export declare interface BestWorkerModeOutput extends DistributionModeOutputParent {
|
|
65
|
-
/** Define a scoring rule to use, when calculating a score to determine the best worker. If not set, will use a default scoring formula that uses the number of job labels that the worker labels match, as well as the number of label selectors the worker labels match and/or exceed using a logistic function (https://en.wikipedia.org/wiki/Logistic_function). */
|
|
66
|
-
scoringRule?: RouterRuleOutput;
|
|
67
|
-
/** Options to configure 'scoringRule'. If not set, default values are used. */
|
|
68
|
-
scoringRuleOptions?: ScoringRuleOptionsOutput;
|
|
69
|
-
/** The type discriminator describing a sub-type of Mode */
|
|
70
|
-
kind: "bestWorker";
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
export declare interface Cancel {
|
|
74
|
-
/** Submits request to cancel an existing job by Id while supplying free-form cancellation reason. */
|
|
75
|
-
post(options?: CancelParameters): StreamableMethod<Cancel200Response | CancelDefaultResponse>;
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
/** The request has succeeded. */
|
|
79
|
-
export declare interface Cancel200Response extends HttpResponse {
|
|
80
|
-
status: "200";
|
|
81
|
-
body: CancelJobResultOutput;
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
export declare interface CancelBodyParam {
|
|
85
|
-
/** Request model for cancelling job. */
|
|
86
|
-
body?: CancelJobOptions;
|
|
87
|
-
}
|
|
88
|
-
|
|
89
|
-
export declare interface CancelDefaultHeaders {
|
|
90
|
-
/** String error code indicating what went wrong. */
|
|
91
|
-
"x-ms-error-code"?: string;
|
|
92
|
-
}
|
|
93
|
-
|
|
94
|
-
export declare interface CancelDefaultResponse extends HttpResponse {
|
|
95
|
-
status: string;
|
|
96
|
-
body: ErrorResponse;
|
|
97
|
-
headers: RawHttpHeaders & CancelDefaultHeaders;
|
|
98
|
-
}
|
|
99
|
-
|
|
100
|
-
/** An action that marks a job as cancelled. */
|
|
101
|
-
export declare interface CancelExceptionAction extends ExceptionActionParent {
|
|
102
|
-
/** A note that will be appended to a job's notes collection with the current timestamp. */
|
|
103
|
-
note?: string;
|
|
104
|
-
/** Indicates the outcome of a job, populate this field with your own custom values. */
|
|
105
|
-
dispositionCode?: string;
|
|
106
|
-
/** The type discriminator describing a sub-type of ExceptionAction. */
|
|
107
|
-
kind: "cancel";
|
|
108
|
-
}
|
|
109
|
-
|
|
110
|
-
/** An action that marks a job as cancelled. */
|
|
111
|
-
export declare interface CancelExceptionActionOutput extends ExceptionActionOutputParent {
|
|
112
|
-
/** A note that will be appended to a job's notes collection with the current timestamp. */
|
|
113
|
-
note?: string;
|
|
114
|
-
/** Indicates the outcome of a job, populate this field with your own custom values. */
|
|
115
|
-
dispositionCode?: string;
|
|
116
|
-
/** The type discriminator describing a sub-type of ExceptionAction. */
|
|
117
|
-
kind: "cancel";
|
|
118
|
-
}
|
|
119
|
-
|
|
120
|
-
/** Request payload for cancelling a job. */
|
|
121
|
-
export declare interface CancelJobOptions {
|
|
122
|
-
/** A note that will be appended to a job's Notes collection with the current timestamp. */
|
|
123
|
-
note?: string;
|
|
124
|
-
/** Indicates the outcome of a job, populate this field with your own custom values. If not provided, default value of "Cancelled" is set. */
|
|
125
|
-
dispositionCode?: string;
|
|
126
|
-
}
|
|
127
|
-
|
|
128
|
-
/** Response payload from cancelling a job. */
|
|
129
|
-
export declare interface CancelJobResultOutput {
|
|
130
|
-
}
|
|
131
|
-
|
|
132
|
-
export declare type CancelParameters = CancelBodyParam & RequestParameters;
|
|
133
|
-
|
|
134
|
-
/** A container for the rules that govern how jobs are classified. */
|
|
135
|
-
export declare interface ClassificationPolicy {
|
|
136
|
-
/** Friendly name of this policy. */
|
|
137
|
-
name?: string;
|
|
138
|
-
/** Id of a fallback queue to select if queue selector attachments doesn't find a match. */
|
|
139
|
-
fallbackQueueId?: string;
|
|
140
|
-
/** Queue selector attachments used to resolve a queue for a job. */
|
|
141
|
-
queueSelectorAttachments?: Array<QueueSelectorAttachment>;
|
|
142
|
-
/** A rule to determine a priority score for a job. */
|
|
143
|
-
prioritizationRule?: RouterRule;
|
|
144
|
-
/** Worker selector attachments used to attach worker selectors to a job. */
|
|
145
|
-
workerSelectorAttachments?: Array<WorkerSelectorAttachment>;
|
|
146
|
-
}
|
|
147
|
-
|
|
148
|
-
/** A container for the rules that govern how jobs are classified. */
|
|
149
|
-
export declare interface ClassificationPolicyOutput {
|
|
150
|
-
/** The entity tag for this resource. */
|
|
151
|
-
readonly etag: string;
|
|
152
|
-
/** Id of a classification policy. */
|
|
153
|
-
readonly id: string;
|
|
154
|
-
/** Friendly name of this policy. */
|
|
155
|
-
name?: string;
|
|
156
|
-
/** Id of a fallback queue to select if queue selector attachments doesn't find a match. */
|
|
157
|
-
fallbackQueueId?: string;
|
|
158
|
-
/** Queue selector attachments used to resolve a queue for a job. */
|
|
159
|
-
queueSelectorAttachments?: Array<QueueSelectorAttachmentOutput>;
|
|
160
|
-
/** A rule to determine a priority score for a job. */
|
|
161
|
-
prioritizationRule?: RouterRuleOutput;
|
|
162
|
-
/** Worker selector attachments used to attach worker selectors to a job. */
|
|
163
|
-
workerSelectorAttachments?: Array<WorkerSelectorAttachmentOutput>;
|
|
164
|
-
}
|
|
165
|
-
|
|
166
|
-
/** The resource instance. */
|
|
167
|
-
export declare type ClassificationPolicyResourceMergeAndPatch = Partial<ClassificationPolicy>;
|
|
168
|
-
|
|
169
|
-
export declare interface Close {
|
|
170
|
-
/** Closes a completed job. */
|
|
171
|
-
post(options?: CloseParameters): StreamableMethod<Close200Response | CloseDefaultResponse>;
|
|
172
|
-
}
|
|
173
|
-
|
|
174
|
-
/** The request has succeeded. */
|
|
175
|
-
export declare interface Close200Response extends HttpResponse {
|
|
176
|
-
status: "200";
|
|
177
|
-
body: CloseJobResultOutput;
|
|
178
|
-
}
|
|
179
|
-
|
|
180
|
-
export declare interface CloseBodyParam {
|
|
181
|
-
/** Request model for closing job. */
|
|
182
|
-
body?: CloseJobOptions;
|
|
183
|
-
}
|
|
184
|
-
|
|
185
|
-
export declare interface CloseDefaultHeaders {
|
|
186
|
-
/** String error code indicating what went wrong. */
|
|
187
|
-
"x-ms-error-code"?: string;
|
|
188
|
-
}
|
|
189
|
-
|
|
190
|
-
export declare interface CloseDefaultResponse extends HttpResponse {
|
|
191
|
-
status: string;
|
|
192
|
-
body: ErrorResponse;
|
|
193
|
-
headers: RawHttpHeaders & CloseDefaultHeaders;
|
|
194
|
-
}
|
|
195
|
-
|
|
196
|
-
/** Request payload for closing jobs */
|
|
197
|
-
export declare interface CloseJobOptions {
|
|
198
|
-
/** Indicates the outcome of a job, populate this field with your own custom values. */
|
|
199
|
-
dispositionCode?: string;
|
|
200
|
-
/** If not provided, worker capacity is released immediately along with a JobClosedEvent notification. If provided, worker capacity is released along with a JobClosedEvent notification at a future time in UTC. */
|
|
201
|
-
closeAt?: Date | string;
|
|
202
|
-
/** A note that will be appended to a job's Notes collection with the current timestamp. */
|
|
203
|
-
note?: string;
|
|
204
|
-
}
|
|
205
|
-
|
|
206
|
-
/** Response payload from closing a job. */
|
|
207
|
-
export declare interface CloseJobResultOutput {
|
|
208
|
-
}
|
|
209
|
-
|
|
210
|
-
export declare type CloseParameters = CloseBodyParam & RequestParameters;
|
|
211
|
-
|
|
212
|
-
export declare interface Complete {
|
|
213
|
-
/** Completes an assigned job. */
|
|
214
|
-
post(options?: CompleteParameters): StreamableMethod<Complete200Response | CompleteDefaultResponse>;
|
|
215
|
-
}
|
|
216
|
-
|
|
217
|
-
/** The request has succeeded. */
|
|
218
|
-
export declare interface Complete200Response extends HttpResponse {
|
|
219
|
-
status: "200";
|
|
220
|
-
body: CompleteJobResultOutput;
|
|
221
|
-
}
|
|
222
|
-
|
|
223
|
-
export declare interface CompleteBodyParam {
|
|
224
|
-
/** Request model for completing job. */
|
|
225
|
-
body?: CompleteJobOptions;
|
|
226
|
-
}
|
|
227
|
-
|
|
228
|
-
export declare interface CompleteDefaultHeaders {
|
|
229
|
-
/** String error code indicating what went wrong. */
|
|
230
|
-
"x-ms-error-code"?: string;
|
|
231
|
-
}
|
|
232
|
-
|
|
233
|
-
export declare interface CompleteDefaultResponse extends HttpResponse {
|
|
234
|
-
status: string;
|
|
235
|
-
body: ErrorResponse;
|
|
236
|
-
headers: RawHttpHeaders & CompleteDefaultHeaders;
|
|
237
|
-
}
|
|
238
|
-
|
|
239
|
-
/** Request payload for completing jobs. */
|
|
240
|
-
export declare interface CompleteJobOptions {
|
|
241
|
-
/** A note that will be appended to a job's Notes collection with the current timestamp. */
|
|
242
|
-
note?: string;
|
|
243
|
-
}
|
|
244
|
-
|
|
245
|
-
/** Response payload from completing a job. */
|
|
246
|
-
export declare interface CompleteJobResultOutput {
|
|
247
|
-
}
|
|
248
|
-
|
|
249
|
-
export declare type CompleteParameters = CompleteBodyParam & RequestParameters;
|
|
250
|
-
|
|
251
|
-
/** Describes a set of queue selectors that will be attached if the given condition resolves to true. */
|
|
252
|
-
export declare interface ConditionalQueueSelectorAttachment extends QueueSelectorAttachmentParent {
|
|
253
|
-
/** The condition that must be true for the queue selectors to be attached. */
|
|
254
|
-
condition: RouterRule;
|
|
255
|
-
/** The queue selectors to attach. */
|
|
256
|
-
queueSelectors: Array<RouterQueueSelector>;
|
|
257
|
-
/** The type discriminator describing the type of queue selector attachment. */
|
|
258
|
-
kind: "conditional";
|
|
259
|
-
}
|
|
260
|
-
|
|
261
|
-
/** Describes a set of queue selectors that will be attached if the given condition resolves to true. */
|
|
262
|
-
export declare interface ConditionalQueueSelectorAttachmentOutput extends QueueSelectorAttachmentOutputParent {
|
|
263
|
-
/** The condition that must be true for the queue selectors to be attached. */
|
|
264
|
-
condition: RouterRuleOutput;
|
|
265
|
-
/** The queue selectors to attach. */
|
|
266
|
-
queueSelectors: Array<RouterQueueSelectorOutput>;
|
|
267
|
-
/** The type discriminator describing the type of queue selector attachment. */
|
|
268
|
-
kind: "conditional";
|
|
269
|
-
}
|
|
270
|
-
|
|
271
|
-
/** Describes a set of worker selectors that will be attached if the given condition resolves to true. */
|
|
272
|
-
export declare interface ConditionalWorkerSelectorAttachment extends WorkerSelectorAttachmentParent {
|
|
273
|
-
/** The condition that must be true for the worker selectors to be attached. */
|
|
274
|
-
condition: RouterRule;
|
|
275
|
-
/** The worker selectors to attach. */
|
|
276
|
-
workerSelectors: Array<RouterWorkerSelector>;
|
|
277
|
-
/** The type discriminator describing the type of worker selector attachment. */
|
|
278
|
-
kind: "conditional";
|
|
279
|
-
}
|
|
280
|
-
|
|
281
|
-
/** Describes a set of worker selectors that will be attached if the given condition resolves to true. */
|
|
282
|
-
export declare interface ConditionalWorkerSelectorAttachmentOutput extends WorkerSelectorAttachmentOutputParent {
|
|
283
|
-
/** The condition that must be true for the worker selectors to be attached. */
|
|
284
|
-
condition: RouterRuleOutput;
|
|
285
|
-
/** The worker selectors to attach. */
|
|
286
|
-
workerSelectors: Array<RouterWorkerSelectorOutput>;
|
|
287
|
-
/** The type discriminator describing the type of worker selector attachment. */
|
|
288
|
-
kind: "conditional";
|
|
289
|
-
}
|
|
290
|
-
|
|
291
|
-
/**
|
|
292
|
-
* Initialize a new instance of `AzureCommunicationRoutingServiceClient`
|
|
293
|
-
* @param connectionString - The connectionString or url of your Communication Services resource.
|
|
294
|
-
* @param options - the parameter for all optional parameters
|
|
295
|
-
*/
|
|
296
|
-
declare function createClient(connectionString: string, options: ClientOptions): AzureCommunicationRoutingServiceClient;
|
|
297
|
-
|
|
298
|
-
/**
|
|
299
|
-
* Initialize a new instance of `AzureCommunicationRoutingServiceClient`
|
|
300
|
-
* @param endpoint - Uri of your Communication resource
|
|
301
|
-
* @param credentialOrOptions The key or token credential.
|
|
302
|
-
* @param options - the parameter for all optional parameters
|
|
303
|
-
*/
|
|
304
|
-
declare function createClient(endpoint: string, credentialOrOptions?: KeyCredential | TokenCredential, options?: ClientOptions): AzureCommunicationRoutingServiceClient;
|
|
305
|
-
export default createClient;
|
|
306
|
-
|
|
307
|
-
export declare interface Decline {
|
|
308
|
-
/** Declines an offer to work on a job. */
|
|
309
|
-
post(options?: DeclineParameters): StreamableMethod<Decline200Response | DeclineDefaultResponse>;
|
|
310
|
-
}
|
|
311
|
-
|
|
312
|
-
/** The request has succeeded. */
|
|
313
|
-
export declare interface Decline200Response extends HttpResponse {
|
|
314
|
-
status: "200";
|
|
315
|
-
body: DeclineJobOfferResultOutput;
|
|
316
|
-
}
|
|
317
|
-
|
|
318
|
-
export declare interface DeclineBodyParam {
|
|
319
|
-
/** Request model for declining offer. */
|
|
320
|
-
body?: DeclineJobOfferOptions;
|
|
321
|
-
}
|
|
322
|
-
|
|
323
|
-
export declare interface DeclineDefaultHeaders {
|
|
324
|
-
/** String error code indicating what went wrong. */
|
|
325
|
-
"x-ms-error-code"?: string;
|
|
326
|
-
}
|
|
327
|
-
|
|
328
|
-
export declare interface DeclineDefaultResponse extends HttpResponse {
|
|
329
|
-
status: string;
|
|
330
|
-
body: ErrorResponse;
|
|
331
|
-
headers: RawHttpHeaders & DeclineDefaultHeaders;
|
|
332
|
-
}
|
|
333
|
-
|
|
334
|
-
/** Request payload for declining offers. */
|
|
335
|
-
export declare interface DeclineJobOfferOptions {
|
|
336
|
-
/** If the RetryOfferAt is not provided, then this job will not be offered again to the worker who declined this job unless the worker is de-registered and re-registered. If a RetryOfferAt time is provided, then the job will be re-matched to eligible workers at the retry time in UTC. The worker that declined the job will also be eligible for the job at that time. */
|
|
337
|
-
retryOfferAt?: Date | string;
|
|
338
|
-
}
|
|
339
|
-
|
|
340
|
-
/** Response payload from declining a job. */
|
|
341
|
-
export declare interface DeclineJobOfferResultOutput {
|
|
342
|
-
}
|
|
343
|
-
|
|
344
|
-
export declare type DeclineParameters = DeclineBodyParam & RequestParameters;
|
|
345
|
-
|
|
346
|
-
/** There is no content to send for this request, but the headers may be useful. */
|
|
347
|
-
export declare interface DeleteClassificationPolicy204Response extends HttpResponse {
|
|
348
|
-
status: "204";
|
|
349
|
-
}
|
|
350
|
-
|
|
351
|
-
export declare interface DeleteClassificationPolicyDefaultHeaders {
|
|
352
|
-
/** String error code indicating what went wrong. */
|
|
353
|
-
"x-ms-error-code"?: string;
|
|
354
|
-
}
|
|
355
|
-
|
|
356
|
-
export declare interface DeleteClassificationPolicyDefaultResponse extends HttpResponse {
|
|
357
|
-
status: string;
|
|
358
|
-
body: ErrorResponse;
|
|
359
|
-
headers: RawHttpHeaders & DeleteClassificationPolicyDefaultHeaders;
|
|
360
|
-
}
|
|
361
|
-
|
|
362
|
-
export declare type DeleteClassificationPolicyParameters = RequestParameters;
|
|
363
|
-
|
|
364
|
-
/** There is no content to send for this request, but the headers may be useful. */
|
|
365
|
-
export declare interface DeleteDistributionPolicy204Response extends HttpResponse {
|
|
366
|
-
status: "204";
|
|
367
|
-
}
|
|
368
|
-
|
|
369
|
-
export declare interface DeleteDistributionPolicyDefaultHeaders {
|
|
370
|
-
/** String error code indicating what went wrong. */
|
|
371
|
-
"x-ms-error-code"?: string;
|
|
372
|
-
}
|
|
373
|
-
|
|
374
|
-
export declare interface DeleteDistributionPolicyDefaultResponse extends HttpResponse {
|
|
375
|
-
status: string;
|
|
376
|
-
body: ErrorResponse;
|
|
377
|
-
headers: RawHttpHeaders & DeleteDistributionPolicyDefaultHeaders;
|
|
378
|
-
}
|
|
379
|
-
|
|
380
|
-
export declare type DeleteDistributionPolicyParameters = RequestParameters;
|
|
381
|
-
|
|
382
|
-
/** There is no content to send for this request, but the headers may be useful. */
|
|
383
|
-
export declare interface DeleteExceptionPolicy204Response extends HttpResponse {
|
|
384
|
-
status: "204";
|
|
385
|
-
}
|
|
386
|
-
|
|
387
|
-
export declare interface DeleteExceptionPolicyDefaultHeaders {
|
|
388
|
-
/** String error code indicating what went wrong. */
|
|
389
|
-
"x-ms-error-code"?: string;
|
|
390
|
-
}
|
|
391
|
-
|
|
392
|
-
export declare interface DeleteExceptionPolicyDefaultResponse extends HttpResponse {
|
|
393
|
-
status: string;
|
|
394
|
-
body: ErrorResponse;
|
|
395
|
-
headers: RawHttpHeaders & DeleteExceptionPolicyDefaultHeaders;
|
|
396
|
-
}
|
|
397
|
-
|
|
398
|
-
export declare type DeleteExceptionPolicyParameters = RequestParameters;
|
|
399
|
-
|
|
400
|
-
/** There is no content to send for this request, but the headers may be useful. */
|
|
401
|
-
export declare interface DeleteJob204Response extends HttpResponse {
|
|
402
|
-
status: "204";
|
|
403
|
-
}
|
|
404
|
-
|
|
405
|
-
export declare interface DeleteJobDefaultHeaders {
|
|
406
|
-
/** String error code indicating what went wrong. */
|
|
407
|
-
"x-ms-error-code"?: string;
|
|
408
|
-
}
|
|
409
|
-
|
|
410
|
-
export declare interface DeleteJobDefaultResponse extends HttpResponse {
|
|
411
|
-
status: string;
|
|
412
|
-
body: ErrorResponse;
|
|
413
|
-
headers: RawHttpHeaders & DeleteJobDefaultHeaders;
|
|
414
|
-
}
|
|
415
|
-
|
|
416
|
-
export declare type DeleteJobParameters = RequestParameters;
|
|
417
|
-
|
|
418
|
-
/** There is no content to send for this request, but the headers may be useful. */
|
|
419
|
-
export declare interface DeleteQueue204Response extends HttpResponse {
|
|
420
|
-
status: "204";
|
|
421
|
-
}
|
|
422
|
-
|
|
423
|
-
export declare interface DeleteQueueDefaultHeaders {
|
|
424
|
-
/** String error code indicating what went wrong. */
|
|
425
|
-
"x-ms-error-code"?: string;
|
|
426
|
-
}
|
|
427
|
-
|
|
428
|
-
export declare interface DeleteQueueDefaultResponse extends HttpResponse {
|
|
429
|
-
status: string;
|
|
430
|
-
body: ErrorResponse;
|
|
431
|
-
headers: RawHttpHeaders & DeleteQueueDefaultHeaders;
|
|
432
|
-
}
|
|
433
|
-
|
|
434
|
-
export declare type DeleteQueueParameters = RequestParameters;
|
|
435
|
-
|
|
436
|
-
/** There is no content to send for this request, but the headers may be useful. */
|
|
437
|
-
export declare interface DeleteWorker204Response extends HttpResponse {
|
|
438
|
-
status: "204";
|
|
439
|
-
}
|
|
440
|
-
|
|
441
|
-
export declare interface DeleteWorkerDefaultHeaders {
|
|
442
|
-
/** String error code indicating what went wrong. */
|
|
443
|
-
"x-ms-error-code"?: string;
|
|
444
|
-
}
|
|
445
|
-
|
|
446
|
-
export declare interface DeleteWorkerDefaultResponse extends HttpResponse {
|
|
447
|
-
status: string;
|
|
448
|
-
body: ErrorResponse;
|
|
449
|
-
headers: RawHttpHeaders & DeleteWorkerDefaultHeaders;
|
|
450
|
-
}
|
|
451
|
-
|
|
452
|
-
export declare type DeleteWorkerParameters = RequestParameters;
|
|
453
|
-
|
|
454
|
-
/** A rule that return the same labels as the input labels. */
|
|
455
|
-
export declare interface DirectMapRouterRule extends RouterRuleParent {
|
|
456
|
-
/** The type discriminator describing a sub-type of Rule. */
|
|
457
|
-
kind: "directMap";
|
|
458
|
-
}
|
|
459
|
-
|
|
460
|
-
/** A rule that return the same labels as the input labels. */
|
|
461
|
-
export declare interface DirectMapRouterRuleOutput extends RouterRuleOutputParent {
|
|
462
|
-
/** The type discriminator describing a sub-type of Rule. */
|
|
463
|
-
kind: "directMap";
|
|
464
|
-
}
|
|
465
|
-
|
|
466
|
-
/** Abstract base class for defining a distribution mode. */
|
|
467
|
-
export declare type DistributionMode = DistributionModeParent | BestWorkerMode | LongestIdleMode | RoundRobinMode;
|
|
468
|
-
|
|
469
|
-
/** Abstract base class for defining a distribution mode. */
|
|
470
|
-
export declare type DistributionModeOutput = DistributionModeOutputParent | BestWorkerModeOutput | LongestIdleModeOutput | RoundRobinModeOutput;
|
|
471
|
-
|
|
472
|
-
/** Abstract base class for defining a distribution mode. */
|
|
473
|
-
export declare interface DistributionModeOutputParent {
|
|
474
|
-
/** Governs the minimum desired number of active concurrent offers a job can have. */
|
|
475
|
-
minConcurrentOffers?: number;
|
|
476
|
-
/** Governs the maximum number of active concurrent offers a job can have. */
|
|
477
|
-
maxConcurrentOffers?: number;
|
|
478
|
-
/** If set to true, then router will match workers to jobs even if they don't match label selectors. Warning: You may get workers that are not qualified for a job they are matched with if you set this variable to true. This flag is intended more for temporary usage. By default, set to false. */
|
|
479
|
-
bypassSelectors?: boolean;
|
|
480
|
-
kind: string;
|
|
481
|
-
}
|
|
482
|
-
|
|
483
|
-
/** Abstract base class for defining a distribution mode. */
|
|
484
|
-
export declare interface DistributionModeParent {
|
|
485
|
-
/** Governs the minimum desired number of active concurrent offers a job can have. */
|
|
486
|
-
minConcurrentOffers?: number;
|
|
487
|
-
/** Governs the maximum number of active concurrent offers a job can have. */
|
|
488
|
-
maxConcurrentOffers?: number;
|
|
489
|
-
/** If set to true, then router will match workers to jobs even if they don't match label selectors. Warning: You may get workers that are not qualified for a job they are matched with if you set this variable to true. This flag is intended more for temporary usage. By default, set to false. */
|
|
490
|
-
bypassSelectors?: boolean;
|
|
491
|
-
kind: string;
|
|
492
|
-
}
|
|
493
|
-
|
|
494
|
-
/** Policy governing how jobs are distributed to workers */
|
|
495
|
-
export declare interface DistributionPolicy {
|
|
496
|
-
/** Friendly name of this policy. */
|
|
497
|
-
name?: string;
|
|
498
|
-
/** Number of seconds after which any offers created under this policy will be expired. */
|
|
499
|
-
offerExpiresAfterSeconds?: number;
|
|
500
|
-
/** Mode governing the specific distribution method. */
|
|
501
|
-
mode?: DistributionMode;
|
|
502
|
-
}
|
|
503
|
-
|
|
504
|
-
/** Policy governing how jobs are distributed to workers */
|
|
505
|
-
export declare interface DistributionPolicyOutput {
|
|
506
|
-
/** The entity tag for this resource. */
|
|
507
|
-
readonly etag: string;
|
|
508
|
-
/** Id of a distribution policy. */
|
|
509
|
-
readonly id: string;
|
|
510
|
-
/** Friendly name of this policy. */
|
|
511
|
-
name?: string;
|
|
512
|
-
/** Number of seconds after which any offers created under this policy will be expired. */
|
|
513
|
-
offerExpiresAfterSeconds?: number;
|
|
514
|
-
/** Mode governing the specific distribution method. */
|
|
515
|
-
mode?: DistributionModeOutput;
|
|
516
|
-
}
|
|
517
|
-
|
|
518
|
-
/** The resource instance. */
|
|
519
|
-
export declare type DistributionPolicyResourceMergeAndPatch = Partial<DistributionPolicy>;
|
|
520
|
-
|
|
521
|
-
/** The action to take when the exception is triggered. */
|
|
522
|
-
export declare type ExceptionAction = ExceptionActionParent | CancelExceptionAction | ManualReclassifyExceptionAction | ReclassifyExceptionAction;
|
|
523
|
-
|
|
524
|
-
/** The action to take when the exception is triggered. */
|
|
525
|
-
export declare type ExceptionActionOutput = ExceptionActionOutputParent | CancelExceptionActionOutput | ManualReclassifyExceptionActionOutput | ReclassifyExceptionActionOutput;
|
|
526
|
-
|
|
527
|
-
/** The action to take when the exception is triggered. */
|
|
528
|
-
export declare interface ExceptionActionOutputParent {
|
|
529
|
-
/** Unique Id of the exception action. */
|
|
530
|
-
id?: string;
|
|
531
|
-
kind: string;
|
|
532
|
-
}
|
|
533
|
-
|
|
534
|
-
/** The action to take when the exception is triggered. */
|
|
535
|
-
export declare interface ExceptionActionParent {
|
|
536
|
-
/** Unique Id of the exception action. */
|
|
537
|
-
id?: string;
|
|
538
|
-
kind: string;
|
|
539
|
-
}
|
|
540
|
-
|
|
541
|
-
/** A policy that defines actions to execute when exception are triggered. */
|
|
542
|
-
export declare interface ExceptionPolicy {
|
|
543
|
-
/** Friendly name of this policy. */
|
|
544
|
-
name?: string;
|
|
545
|
-
/** A collection of exception rules on the exception policy. */
|
|
546
|
-
exceptionRules?: Array<ExceptionRule>;
|
|
547
|
-
}
|
|
548
|
-
|
|
549
|
-
/** A policy that defines actions to execute when exception are triggered. */
|
|
550
|
-
export declare interface ExceptionPolicyOutput {
|
|
551
|
-
/** The entity tag for this resource. */
|
|
552
|
-
readonly etag: string;
|
|
553
|
-
/** Id of an exception policy. */
|
|
554
|
-
readonly id: string;
|
|
555
|
-
/** Friendly name of this policy. */
|
|
556
|
-
name?: string;
|
|
557
|
-
/** A collection of exception rules on the exception policy. */
|
|
558
|
-
exceptionRules?: Array<ExceptionRuleOutput>;
|
|
559
|
-
}
|
|
560
|
-
|
|
561
|
-
/** The resource instance. */
|
|
562
|
-
export declare type ExceptionPolicyResourceMergeAndPatch = Partial<ExceptionPolicy>;
|
|
563
|
-
|
|
564
|
-
/** A rule that defines actions to execute upon a specific trigger. */
|
|
565
|
-
export declare interface ExceptionRule {
|
|
566
|
-
/** Id of an exception rule. */
|
|
567
|
-
id: string;
|
|
568
|
-
/** The trigger for this exception rule. */
|
|
569
|
-
trigger: ExceptionTrigger;
|
|
570
|
-
/** A collection of actions to perform once the exception is triggered. */
|
|
571
|
-
actions: Array<ExceptionAction>;
|
|
572
|
-
}
|
|
573
|
-
|
|
574
|
-
/** A rule that defines actions to execute upon a specific trigger. */
|
|
575
|
-
export declare interface ExceptionRuleOutput {
|
|
576
|
-
/** Id of an exception rule. */
|
|
577
|
-
id: string;
|
|
578
|
-
/** The trigger for this exception rule. */
|
|
579
|
-
trigger: ExceptionTriggerOutput;
|
|
580
|
-
/** A collection of actions to perform once the exception is triggered. */
|
|
581
|
-
actions: Array<ExceptionActionOutput>;
|
|
582
|
-
}
|
|
583
|
-
|
|
584
|
-
/** Abstract base class for defining a trigger for exception rules. */
|
|
585
|
-
export declare type ExceptionTrigger = ExceptionTriggerParent | QueueLengthExceptionTrigger | WaitTimeExceptionTrigger;
|
|
586
|
-
|
|
587
|
-
/** Abstract base class for defining a trigger for exception rules. */
|
|
588
|
-
export declare type ExceptionTriggerOutput = ExceptionTriggerOutputParent | QueueLengthExceptionTriggerOutput | WaitTimeExceptionTriggerOutput;
|
|
589
|
-
|
|
590
|
-
/** Abstract base class for defining a trigger for exception rules. */
|
|
591
|
-
export declare interface ExceptionTriggerOutputParent {
|
|
592
|
-
kind: string;
|
|
593
|
-
}
|
|
594
|
-
|
|
595
|
-
/** Abstract base class for defining a trigger for exception rules. */
|
|
596
|
-
export declare interface ExceptionTriggerParent {
|
|
597
|
-
kind: string;
|
|
598
|
-
}
|
|
599
|
-
|
|
600
|
-
/** A rule providing inline expression rules. */
|
|
601
|
-
export declare interface ExpressionRouterRule extends RouterRuleParent {
|
|
602
|
-
/**
|
|
603
|
-
* The expression language to compile to and execute.
|
|
604
|
-
*
|
|
605
|
-
* Possible values: "powerFx"
|
|
606
|
-
*/
|
|
607
|
-
language?: string;
|
|
608
|
-
/** An expression to evaluate. Should contain return statement with calculated values. */
|
|
609
|
-
expression: string;
|
|
610
|
-
/** The type discriminator describing a sub-type of Rule. */
|
|
611
|
-
kind: "expression";
|
|
612
|
-
}
|
|
613
|
-
|
|
614
|
-
/** A rule providing inline expression rules. */
|
|
615
|
-
export declare interface ExpressionRouterRuleOutput extends RouterRuleOutputParent {
|
|
616
|
-
/**
|
|
617
|
-
* The expression language to compile to and execute.
|
|
618
|
-
*
|
|
619
|
-
* Possible values: "powerFx"
|
|
620
|
-
*/
|
|
621
|
-
language?: string;
|
|
622
|
-
/** An expression to evaluate. Should contain return statement with calculated values. */
|
|
623
|
-
expression: string;
|
|
624
|
-
/** The type discriminator describing a sub-type of Rule. */
|
|
625
|
-
kind: "expression";
|
|
626
|
-
}
|
|
627
|
-
|
|
628
|
-
/** A rule providing a binding to an HTTP Triggered Azure Function. */
|
|
629
|
-
export declare interface FunctionRouterRule extends RouterRuleParent {
|
|
630
|
-
/** URL for Azure Function. */
|
|
631
|
-
functionUri: string;
|
|
632
|
-
/** Credentials used to access Azure function rule. */
|
|
633
|
-
credential?: FunctionRouterRuleCredential;
|
|
634
|
-
/** The type discriminator describing a sub-type of Rule. */
|
|
635
|
-
kind: "function";
|
|
636
|
-
}
|
|
637
|
-
|
|
638
|
-
/** Credentials used to access Azure function rule. */
|
|
639
|
-
export declare interface FunctionRouterRuleCredential {
|
|
640
|
-
/** Access key scoped to a particular function. */
|
|
641
|
-
functionKey?: string;
|
|
642
|
-
/** Access key scoped to a Azure Function app. This key grants access to all functions under the app. */
|
|
643
|
-
appKey?: string;
|
|
644
|
-
/** Client id, when AppKey is provided In context of Azure function, this is usually the name of the key. */
|
|
645
|
-
clientId?: string;
|
|
646
|
-
}
|
|
647
|
-
|
|
648
|
-
/** Credentials used to access Azure function rule. */
|
|
649
|
-
export declare interface FunctionRouterRuleCredentialOutput {
|
|
650
|
-
/** Access key scoped to a particular function. */
|
|
651
|
-
functionKey?: string;
|
|
652
|
-
/** Access key scoped to a Azure Function app. This key grants access to all functions under the app. */
|
|
653
|
-
appKey?: string;
|
|
654
|
-
/** Client id, when AppKey is provided In context of Azure function, this is usually the name of the key. */
|
|
655
|
-
clientId?: string;
|
|
656
|
-
}
|
|
657
|
-
|
|
658
|
-
/** A rule providing a binding to an HTTP Triggered Azure Function. */
|
|
659
|
-
export declare interface FunctionRouterRuleOutput extends RouterRuleOutputParent {
|
|
660
|
-
/** URL for Azure Function. */
|
|
661
|
-
functionUri: string;
|
|
662
|
-
/** Credentials used to access Azure function rule. */
|
|
663
|
-
credential?: FunctionRouterRuleCredentialOutput;
|
|
664
|
-
/** The type discriminator describing a sub-type of Rule. */
|
|
665
|
-
kind: "function";
|
|
666
|
-
}
|
|
667
|
-
|
|
668
|
-
/**
|
|
669
|
-
* Helper type to extract the type of an array
|
|
670
|
-
*/
|
|
671
|
-
export declare type GetArrayType<T> = T extends Array<infer TData> ? TData : never;
|
|
672
|
-
|
|
673
|
-
export declare interface GetClassificationPolicy200Headers {
|
|
674
|
-
/** The entity tag for the response. */
|
|
675
|
-
etag?: string;
|
|
676
|
-
/** The last modified timestamp. */
|
|
677
|
-
"last-modified"?: string;
|
|
678
|
-
}
|
|
679
|
-
|
|
680
|
-
/** The request has succeeded. */
|
|
681
|
-
export declare interface GetClassificationPolicy200Response extends HttpResponse {
|
|
682
|
-
status: "200";
|
|
683
|
-
body: ClassificationPolicyOutput;
|
|
684
|
-
headers: RawHttpHeaders & GetClassificationPolicy200Headers;
|
|
685
|
-
}
|
|
686
|
-
|
|
687
|
-
export declare interface GetClassificationPolicyDefaultHeaders {
|
|
688
|
-
/** String error code indicating what went wrong. */
|
|
689
|
-
"x-ms-error-code"?: string;
|
|
690
|
-
}
|
|
691
|
-
|
|
692
|
-
export declare interface GetClassificationPolicyDefaultResponse extends HttpResponse {
|
|
693
|
-
status: string;
|
|
694
|
-
body: ErrorResponse;
|
|
695
|
-
headers: RawHttpHeaders & GetClassificationPolicyDefaultHeaders;
|
|
696
|
-
}
|
|
697
|
-
|
|
698
|
-
export declare type GetClassificationPolicyParameters = RequestParameters;
|
|
699
|
-
|
|
700
|
-
export declare interface GetDistributionPolicy200Headers {
|
|
701
|
-
/** The entity tag for the response. */
|
|
702
|
-
etag?: string;
|
|
703
|
-
/** The last modified timestamp. */
|
|
704
|
-
"last-modified"?: string;
|
|
705
|
-
}
|
|
706
|
-
|
|
707
|
-
/** The request has succeeded. */
|
|
708
|
-
export declare interface GetDistributionPolicy200Response extends HttpResponse {
|
|
709
|
-
status: "200";
|
|
710
|
-
body: DistributionPolicyOutput;
|
|
711
|
-
headers: RawHttpHeaders & GetDistributionPolicy200Headers;
|
|
712
|
-
}
|
|
713
|
-
|
|
714
|
-
export declare interface GetDistributionPolicyDefaultHeaders {
|
|
715
|
-
/** String error code indicating what went wrong. */
|
|
716
|
-
"x-ms-error-code"?: string;
|
|
717
|
-
}
|
|
718
|
-
|
|
719
|
-
export declare interface GetDistributionPolicyDefaultResponse extends HttpResponse {
|
|
720
|
-
status: string;
|
|
721
|
-
body: ErrorResponse;
|
|
722
|
-
headers: RawHttpHeaders & GetDistributionPolicyDefaultHeaders;
|
|
723
|
-
}
|
|
724
|
-
|
|
725
|
-
export declare type GetDistributionPolicyParameters = RequestParameters;
|
|
726
|
-
|
|
727
|
-
export declare interface GetExceptionPolicy200Headers {
|
|
728
|
-
/** The entity tag for the response. */
|
|
729
|
-
etag?: string;
|
|
730
|
-
/** The last modified timestamp. */
|
|
731
|
-
"last-modified"?: string;
|
|
732
|
-
}
|
|
733
|
-
|
|
734
|
-
/** The request has succeeded. */
|
|
735
|
-
export declare interface GetExceptionPolicy200Response extends HttpResponse {
|
|
736
|
-
status: "200";
|
|
737
|
-
body: ExceptionPolicyOutput;
|
|
738
|
-
headers: RawHttpHeaders & GetExceptionPolicy200Headers;
|
|
739
|
-
}
|
|
740
|
-
|
|
741
|
-
export declare interface GetExceptionPolicyDefaultHeaders {
|
|
742
|
-
/** String error code indicating what went wrong. */
|
|
743
|
-
"x-ms-error-code"?: string;
|
|
744
|
-
}
|
|
745
|
-
|
|
746
|
-
export declare interface GetExceptionPolicyDefaultResponse extends HttpResponse {
|
|
747
|
-
status: string;
|
|
748
|
-
body: ErrorResponse;
|
|
749
|
-
headers: RawHttpHeaders & GetExceptionPolicyDefaultHeaders;
|
|
750
|
-
}
|
|
751
|
-
|
|
752
|
-
export declare type GetExceptionPolicyParameters = RequestParameters;
|
|
753
|
-
|
|
754
|
-
export declare interface GetInQueuePosition {
|
|
755
|
-
/** Gets a job's position details. */
|
|
756
|
-
get(options?: GetInQueuePositionParameters): StreamableMethod<GetInQueuePosition200Response | GetInQueuePositionDefaultResponse>;
|
|
757
|
-
}
|
|
758
|
-
|
|
759
|
-
/** The request has succeeded. */
|
|
760
|
-
export declare interface GetInQueuePosition200Response extends HttpResponse {
|
|
761
|
-
status: "200";
|
|
762
|
-
body: RouterJobPositionDetailsOutput;
|
|
763
|
-
}
|
|
764
|
-
|
|
765
|
-
export declare interface GetInQueuePositionDefaultHeaders {
|
|
766
|
-
/** String error code indicating what went wrong. */
|
|
767
|
-
"x-ms-error-code"?: string;
|
|
768
|
-
}
|
|
769
|
-
|
|
770
|
-
export declare interface GetInQueuePositionDefaultResponse extends HttpResponse {
|
|
771
|
-
status: string;
|
|
772
|
-
body: ErrorResponse;
|
|
773
|
-
headers: RawHttpHeaders & GetInQueuePositionDefaultHeaders;
|
|
774
|
-
}
|
|
775
|
-
|
|
776
|
-
export declare type GetInQueuePositionParameters = RequestParameters;
|
|
777
|
-
|
|
778
|
-
export declare interface GetJob200Headers {
|
|
779
|
-
/** The entity tag for the response. */
|
|
780
|
-
etag?: string;
|
|
781
|
-
/** The last modified timestamp. */
|
|
782
|
-
"last-modified"?: string;
|
|
783
|
-
}
|
|
784
|
-
|
|
785
|
-
/** The request has succeeded. */
|
|
786
|
-
export declare interface GetJob200Response extends HttpResponse {
|
|
787
|
-
status: "200";
|
|
788
|
-
body: RouterJobOutput;
|
|
789
|
-
headers: RawHttpHeaders & GetJob200Headers;
|
|
790
|
-
}
|
|
791
|
-
|
|
792
|
-
export declare interface GetJobDefaultHeaders {
|
|
793
|
-
/** String error code indicating what went wrong. */
|
|
794
|
-
"x-ms-error-code"?: string;
|
|
795
|
-
}
|
|
796
|
-
|
|
797
|
-
export declare interface GetJobDefaultResponse extends HttpResponse {
|
|
798
|
-
status: string;
|
|
799
|
-
body: ErrorResponse;
|
|
800
|
-
headers: RawHttpHeaders & GetJobDefaultHeaders;
|
|
801
|
-
}
|
|
802
|
-
|
|
803
|
-
export declare type GetJobParameters = RequestParameters;
|
|
804
|
-
|
|
805
|
-
/**
|
|
806
|
-
* The type of a custom function that defines how to get a page and a link to the next one if any.
|
|
807
|
-
*/
|
|
808
|
-
export declare type GetPage<TPage> = (pageLink: string, maxPageSize?: number) => Promise<{
|
|
809
|
-
page: TPage;
|
|
810
|
-
nextPageLink?: string;
|
|
811
|
-
}>;
|
|
812
|
-
|
|
813
|
-
export declare interface GetQueue200Headers {
|
|
814
|
-
/** The entity tag for the response. */
|
|
815
|
-
etag?: string;
|
|
816
|
-
/** The last modified timestamp. */
|
|
817
|
-
"last-modified"?: string;
|
|
818
|
-
}
|
|
819
|
-
|
|
820
|
-
/** The request has succeeded. */
|
|
821
|
-
export declare interface GetQueue200Response extends HttpResponse {
|
|
822
|
-
status: "200";
|
|
823
|
-
body: RouterQueueOutput;
|
|
824
|
-
headers: RawHttpHeaders & GetQueue200Headers;
|
|
825
|
-
}
|
|
826
|
-
|
|
827
|
-
export declare interface GetQueueDefaultHeaders {
|
|
828
|
-
/** String error code indicating what went wrong. */
|
|
829
|
-
"x-ms-error-code"?: string;
|
|
830
|
-
}
|
|
831
|
-
|
|
832
|
-
export declare interface GetQueueDefaultResponse extends HttpResponse {
|
|
833
|
-
status: string;
|
|
834
|
-
body: ErrorResponse;
|
|
835
|
-
headers: RawHttpHeaders & GetQueueDefaultHeaders;
|
|
836
|
-
}
|
|
837
|
-
|
|
838
|
-
export declare type GetQueueParameters = RequestParameters;
|
|
839
|
-
|
|
840
|
-
export declare interface GetQueueStatistics {
|
|
841
|
-
/** Retrieves a queue's statistics. */
|
|
842
|
-
get(options?: GetQueueStatisticsParameters): StreamableMethod<GetQueueStatistics200Response | GetQueueStatisticsDefaultResponse>;
|
|
843
|
-
}
|
|
844
|
-
|
|
845
|
-
/** The request has succeeded. */
|
|
846
|
-
export declare interface GetQueueStatistics200Response extends HttpResponse {
|
|
847
|
-
status: "200";
|
|
848
|
-
body: RouterQueueStatisticsOutput;
|
|
849
|
-
}
|
|
850
|
-
|
|
851
|
-
export declare interface GetQueueStatisticsDefaultHeaders {
|
|
852
|
-
/** String error code indicating what went wrong. */
|
|
853
|
-
"x-ms-error-code"?: string;
|
|
854
|
-
}
|
|
855
|
-
|
|
856
|
-
export declare interface GetQueueStatisticsDefaultResponse extends HttpResponse {
|
|
857
|
-
status: string;
|
|
858
|
-
body: ErrorResponse;
|
|
859
|
-
headers: RawHttpHeaders & GetQueueStatisticsDefaultHeaders;
|
|
860
|
-
}
|
|
861
|
-
|
|
862
|
-
export declare type GetQueueStatisticsParameters = RequestParameters;
|
|
863
|
-
|
|
864
|
-
export declare interface GetWorker200Headers {
|
|
865
|
-
/** The entity tag for the response. */
|
|
866
|
-
etag?: string;
|
|
867
|
-
/** The last modified timestamp. */
|
|
868
|
-
"last-modified"?: string;
|
|
869
|
-
}
|
|
870
|
-
|
|
871
|
-
/** The request has succeeded. */
|
|
872
|
-
export declare interface GetWorker200Response extends HttpResponse {
|
|
873
|
-
status: "200";
|
|
874
|
-
body: RouterWorkerOutput;
|
|
875
|
-
headers: RawHttpHeaders & GetWorker200Headers;
|
|
876
|
-
}
|
|
877
|
-
|
|
878
|
-
export declare interface GetWorkerDefaultHeaders {
|
|
879
|
-
/** String error code indicating what went wrong. */
|
|
880
|
-
"x-ms-error-code"?: string;
|
|
881
|
-
}
|
|
882
|
-
|
|
883
|
-
export declare interface GetWorkerDefaultResponse extends HttpResponse {
|
|
884
|
-
status: string;
|
|
885
|
-
body: ErrorResponse;
|
|
886
|
-
headers: RawHttpHeaders & GetWorkerDefaultHeaders;
|
|
887
|
-
}
|
|
888
|
-
|
|
889
|
-
export declare type GetWorkerParameters = RequestParameters;
|
|
890
|
-
|
|
891
|
-
export declare function isUnexpected(response: UpsertClassificationPolicy200Response | UpsertClassificationPolicy201Response | UpsertClassificationPolicyDefaultResponse): response is UpsertClassificationPolicyDefaultResponse;
|
|
892
|
-
|
|
893
|
-
export declare function isUnexpected(response: GetClassificationPolicy200Response | GetClassificationPolicyDefaultResponse): response is GetClassificationPolicyDefaultResponse;
|
|
894
|
-
|
|
895
|
-
export declare function isUnexpected(response: DeleteClassificationPolicy204Response | DeleteClassificationPolicyDefaultResponse): response is DeleteClassificationPolicyDefaultResponse;
|
|
896
|
-
|
|
897
|
-
export declare function isUnexpected(response: ListClassificationPolicies200Response | ListClassificationPoliciesDefaultResponse): response is ListClassificationPoliciesDefaultResponse;
|
|
898
|
-
|
|
899
|
-
export declare function isUnexpected(response: UpsertDistributionPolicy200Response | UpsertDistributionPolicy201Response | UpsertDistributionPolicyDefaultResponse): response is UpsertDistributionPolicyDefaultResponse;
|
|
900
|
-
|
|
901
|
-
export declare function isUnexpected(response: GetDistributionPolicy200Response | GetDistributionPolicyDefaultResponse): response is GetDistributionPolicyDefaultResponse;
|
|
902
|
-
|
|
903
|
-
export declare function isUnexpected(response: DeleteDistributionPolicy204Response | DeleteDistributionPolicyDefaultResponse): response is DeleteDistributionPolicyDefaultResponse;
|
|
904
|
-
|
|
905
|
-
export declare function isUnexpected(response: ListDistributionPolicies200Response | ListDistributionPoliciesDefaultResponse): response is ListDistributionPoliciesDefaultResponse;
|
|
906
|
-
|
|
907
|
-
export declare function isUnexpected(response: UpsertExceptionPolicy200Response | UpsertExceptionPolicy201Response | UpsertExceptionPolicyDefaultResponse): response is UpsertExceptionPolicyDefaultResponse;
|
|
908
|
-
|
|
909
|
-
export declare function isUnexpected(response: GetExceptionPolicy200Response | GetExceptionPolicyDefaultResponse): response is GetExceptionPolicyDefaultResponse;
|
|
910
|
-
|
|
911
|
-
export declare function isUnexpected(response: DeleteExceptionPolicy204Response | DeleteExceptionPolicyDefaultResponse): response is DeleteExceptionPolicyDefaultResponse;
|
|
912
|
-
|
|
913
|
-
export declare function isUnexpected(response: ListExceptionPolicies200Response | ListExceptionPoliciesDefaultResponse): response is ListExceptionPoliciesDefaultResponse;
|
|
914
|
-
|
|
915
|
-
export declare function isUnexpected(response: UpsertQueue200Response | UpsertQueue201Response | UpsertQueueDefaultResponse): response is UpsertQueueDefaultResponse;
|
|
916
|
-
|
|
917
|
-
export declare function isUnexpected(response: GetQueue200Response | GetQueueDefaultResponse): response is GetQueueDefaultResponse;
|
|
918
|
-
|
|
919
|
-
export declare function isUnexpected(response: DeleteQueue204Response | DeleteQueueDefaultResponse): response is DeleteQueueDefaultResponse;
|
|
920
|
-
|
|
921
|
-
export declare function isUnexpected(response: ListQueues200Response | ListQueuesDefaultResponse): response is ListQueuesDefaultResponse;
|
|
922
|
-
|
|
923
|
-
export declare function isUnexpected(response: UpsertJob200Response | UpsertJob201Response | UpsertJobDefaultResponse): response is UpsertJobDefaultResponse;
|
|
924
|
-
|
|
925
|
-
export declare function isUnexpected(response: GetJob200Response | GetJobDefaultResponse): response is GetJobDefaultResponse;
|
|
926
|
-
|
|
927
|
-
export declare function isUnexpected(response: DeleteJob204Response | DeleteJobDefaultResponse): response is DeleteJobDefaultResponse;
|
|
928
|
-
|
|
929
|
-
export declare function isUnexpected(response: Reclassify200Response | ReclassifyDefaultResponse): response is ReclassifyDefaultResponse;
|
|
930
|
-
|
|
931
|
-
export declare function isUnexpected(response: Cancel200Response | CancelDefaultResponse): response is CancelDefaultResponse;
|
|
932
|
-
|
|
933
|
-
export declare function isUnexpected(response: Complete200Response | CompleteDefaultResponse): response is CompleteDefaultResponse;
|
|
934
|
-
|
|
935
|
-
export declare function isUnexpected(response: Close200Response | CloseDefaultResponse): response is CloseDefaultResponse;
|
|
936
|
-
|
|
937
|
-
export declare function isUnexpected(response: ListJobs200Response | ListJobsDefaultResponse): response is ListJobsDefaultResponse;
|
|
938
|
-
|
|
939
|
-
export declare function isUnexpected(response: GetInQueuePosition200Response | GetInQueuePositionDefaultResponse): response is GetInQueuePositionDefaultResponse;
|
|
940
|
-
|
|
941
|
-
export declare function isUnexpected(response: Unassign200Response | UnassignDefaultResponse): response is UnassignDefaultResponse;
|
|
942
|
-
|
|
943
|
-
export declare function isUnexpected(response: Accept200Response | AcceptDefaultResponse): response is AcceptDefaultResponse;
|
|
944
|
-
|
|
945
|
-
export declare function isUnexpected(response: Decline200Response | DeclineDefaultResponse): response is DeclineDefaultResponse;
|
|
946
|
-
|
|
947
|
-
export declare function isUnexpected(response: GetQueueStatistics200Response | GetQueueStatisticsDefaultResponse): response is GetQueueStatisticsDefaultResponse;
|
|
948
|
-
|
|
949
|
-
export declare function isUnexpected(response: UpsertWorker200Response | UpsertWorker201Response | UpsertWorkerDefaultResponse): response is UpsertWorkerDefaultResponse;
|
|
950
|
-
|
|
951
|
-
export declare function isUnexpected(response: GetWorker200Response | GetWorkerDefaultResponse): response is GetWorkerDefaultResponse;
|
|
952
|
-
|
|
953
|
-
export declare function isUnexpected(response: DeleteWorker204Response | DeleteWorkerDefaultResponse): response is DeleteWorkerDefaultResponse;
|
|
954
|
-
|
|
955
|
-
export declare function isUnexpected(response: ListWorkers200Response | ListWorkersDefaultResponse): response is ListWorkersDefaultResponse;
|
|
956
|
-
|
|
957
|
-
/**
|
|
958
|
-
* A matching mode of one of the following types:
|
|
959
|
-
* QueueAndMatchMode: Used when matching worker to a job is required to be done right after job is queued.
|
|
960
|
-
* 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.
|
|
961
|
-
* SuspendMode: Used when matching workers to a job needs to be suspended.
|
|
962
|
-
*/
|
|
963
|
-
export declare type JobMatchingMode = JobMatchingModeParent | ScheduleAndSuspendMode | QueueAndMatchMode | SuspendMode;
|
|
964
|
-
|
|
965
|
-
/**
|
|
966
|
-
* A matching mode of one of the following types:
|
|
967
|
-
* QueueAndMatchMode: Used when matching worker to a job is required to be done right after job is queued.
|
|
968
|
-
* 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.
|
|
969
|
-
* SuspendMode: Used when matching workers to a job needs to be suspended.
|
|
970
|
-
*/
|
|
971
|
-
export declare type JobMatchingModeOutput = JobMatchingModeOutputParent | ScheduleAndSuspendModeOutput | QueueAndMatchModeOutput | SuspendModeOutput;
|
|
972
|
-
|
|
973
|
-
/**
|
|
974
|
-
* A matching mode of one of the following types:
|
|
975
|
-
* QueueAndMatchMode: Used when matching worker to a job is required to be done right after job is queued.
|
|
976
|
-
* 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.
|
|
977
|
-
* SuspendMode: Used when matching workers to a job needs to be suspended.
|
|
978
|
-
*/
|
|
979
|
-
export declare interface JobMatchingModeOutputParent {
|
|
980
|
-
kind: string;
|
|
981
|
-
}
|
|
982
|
-
|
|
983
|
-
/**
|
|
984
|
-
* A matching mode of one of the following types:
|
|
985
|
-
* QueueAndMatchMode: Used when matching worker to a job is required to be done right after job is queued.
|
|
986
|
-
* 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.
|
|
987
|
-
* SuspendMode: Used when matching workers to a job needs to be suspended.
|
|
988
|
-
*/
|
|
989
|
-
export declare interface JobMatchingModeParent {
|
|
990
|
-
kind: string;
|
|
991
|
-
}
|
|
992
|
-
|
|
993
|
-
export declare interface ListClassificationPolicies {
|
|
994
|
-
/** Retrieves existing classification policies. */
|
|
995
|
-
get(options?: ListClassificationPoliciesParameters): StreamableMethod<ListClassificationPolicies200Response | ListClassificationPoliciesDefaultResponse>;
|
|
996
|
-
}
|
|
997
|
-
|
|
998
|
-
/** The request has succeeded. */
|
|
999
|
-
export declare interface ListClassificationPolicies200Response extends HttpResponse {
|
|
1000
|
-
status: "200";
|
|
1001
|
-
body: PagedClassificationPolicyOutput;
|
|
1002
|
-
}
|
|
1003
|
-
|
|
1004
|
-
export declare interface ListClassificationPoliciesDefaultHeaders {
|
|
1005
|
-
/** String error code indicating what went wrong. */
|
|
1006
|
-
"x-ms-error-code"?: string;
|
|
1007
|
-
}
|
|
1008
|
-
|
|
1009
|
-
export declare interface ListClassificationPoliciesDefaultResponse extends HttpResponse {
|
|
1010
|
-
status: string;
|
|
1011
|
-
body: ErrorResponse;
|
|
1012
|
-
headers: RawHttpHeaders & ListClassificationPoliciesDefaultHeaders;
|
|
1013
|
-
}
|
|
1014
|
-
|
|
1015
|
-
export declare type ListClassificationPoliciesParameters = ListClassificationPoliciesQueryParam & RequestParameters;
|
|
1016
|
-
|
|
1017
|
-
export declare interface ListClassificationPoliciesQueryParam {
|
|
1018
|
-
queryParameters?: ListClassificationPoliciesQueryParamProperties;
|
|
1019
|
-
}
|
|
1020
|
-
|
|
1021
|
-
export declare interface ListClassificationPoliciesQueryParamProperties {
|
|
1022
|
-
/** Number of objects to return per page. */
|
|
1023
|
-
maxpagesize?: number;
|
|
1024
|
-
}
|
|
1025
|
-
|
|
1026
|
-
export declare interface ListDistributionPolicies {
|
|
1027
|
-
/** Retrieves existing distribution policies. */
|
|
1028
|
-
get(options?: ListDistributionPoliciesParameters): StreamableMethod<ListDistributionPolicies200Response | ListDistributionPoliciesDefaultResponse>;
|
|
1029
|
-
}
|
|
1030
|
-
|
|
1031
|
-
/** The request has succeeded. */
|
|
1032
|
-
export declare interface ListDistributionPolicies200Response extends HttpResponse {
|
|
1033
|
-
status: "200";
|
|
1034
|
-
body: PagedDistributionPolicyOutput;
|
|
1035
|
-
}
|
|
1036
|
-
|
|
1037
|
-
export declare interface ListDistributionPoliciesDefaultHeaders {
|
|
1038
|
-
/** String error code indicating what went wrong. */
|
|
1039
|
-
"x-ms-error-code"?: string;
|
|
1040
|
-
}
|
|
1041
|
-
|
|
1042
|
-
export declare interface ListDistributionPoliciesDefaultResponse extends HttpResponse {
|
|
1043
|
-
status: string;
|
|
1044
|
-
body: ErrorResponse;
|
|
1045
|
-
headers: RawHttpHeaders & ListDistributionPoliciesDefaultHeaders;
|
|
1046
|
-
}
|
|
1047
|
-
|
|
1048
|
-
export declare type ListDistributionPoliciesParameters = ListDistributionPoliciesQueryParam & RequestParameters;
|
|
1049
|
-
|
|
1050
|
-
export declare interface ListDistributionPoliciesQueryParam {
|
|
1051
|
-
queryParameters?: ListDistributionPoliciesQueryParamProperties;
|
|
1052
|
-
}
|
|
1053
|
-
|
|
1054
|
-
export declare interface ListDistributionPoliciesQueryParamProperties {
|
|
1055
|
-
/** Number of objects to return per page. */
|
|
1056
|
-
maxpagesize?: number;
|
|
1057
|
-
}
|
|
1058
|
-
|
|
1059
|
-
export declare interface ListExceptionPolicies {
|
|
1060
|
-
/** Retrieves existing exception policies. */
|
|
1061
|
-
get(options?: ListExceptionPoliciesParameters): StreamableMethod<ListExceptionPolicies200Response | ListExceptionPoliciesDefaultResponse>;
|
|
1062
|
-
}
|
|
1063
|
-
|
|
1064
|
-
/** The request has succeeded. */
|
|
1065
|
-
export declare interface ListExceptionPolicies200Response extends HttpResponse {
|
|
1066
|
-
status: "200";
|
|
1067
|
-
body: PagedExceptionPolicyOutput;
|
|
1068
|
-
}
|
|
1069
|
-
|
|
1070
|
-
export declare interface ListExceptionPoliciesDefaultHeaders {
|
|
1071
|
-
/** String error code indicating what went wrong. */
|
|
1072
|
-
"x-ms-error-code"?: string;
|
|
1073
|
-
}
|
|
1074
|
-
|
|
1075
|
-
export declare interface ListExceptionPoliciesDefaultResponse extends HttpResponse {
|
|
1076
|
-
status: string;
|
|
1077
|
-
body: ErrorResponse;
|
|
1078
|
-
headers: RawHttpHeaders & ListExceptionPoliciesDefaultHeaders;
|
|
1079
|
-
}
|
|
1080
|
-
|
|
1081
|
-
export declare type ListExceptionPoliciesParameters = ListExceptionPoliciesQueryParam & RequestParameters;
|
|
1082
|
-
|
|
1083
|
-
export declare interface ListExceptionPoliciesQueryParam {
|
|
1084
|
-
queryParameters?: ListExceptionPoliciesQueryParamProperties;
|
|
1085
|
-
}
|
|
1086
|
-
|
|
1087
|
-
export declare interface ListExceptionPoliciesQueryParamProperties {
|
|
1088
|
-
/** Number of objects to return per page. */
|
|
1089
|
-
maxpagesize?: number;
|
|
1090
|
-
}
|
|
1091
|
-
|
|
1092
|
-
export declare interface ListJobs {
|
|
1093
|
-
/** Retrieves list of jobs based on filter parameters. */
|
|
1094
|
-
get(options?: ListJobsParameters): StreamableMethod<ListJobs200Response | ListJobsDefaultResponse>;
|
|
1095
|
-
}
|
|
1096
|
-
|
|
1097
|
-
/** The request has succeeded. */
|
|
1098
|
-
export declare interface ListJobs200Response extends HttpResponse {
|
|
1099
|
-
status: "200";
|
|
1100
|
-
body: PagedRouterJobOutput;
|
|
1101
|
-
}
|
|
1102
|
-
|
|
1103
|
-
export declare interface ListJobsDefaultHeaders {
|
|
1104
|
-
/** String error code indicating what went wrong. */
|
|
1105
|
-
"x-ms-error-code"?: string;
|
|
1106
|
-
}
|
|
1107
|
-
|
|
1108
|
-
export declare interface ListJobsDefaultResponse extends HttpResponse {
|
|
1109
|
-
status: string;
|
|
1110
|
-
body: ErrorResponse;
|
|
1111
|
-
headers: RawHttpHeaders & ListJobsDefaultHeaders;
|
|
1112
|
-
}
|
|
1113
|
-
|
|
1114
|
-
export declare type ListJobsParameters = ListJobsQueryParam & RequestParameters;
|
|
1115
|
-
|
|
1116
|
-
export declare interface ListJobsQueryParam {
|
|
1117
|
-
queryParameters?: ListJobsQueryParamProperties;
|
|
1118
|
-
}
|
|
1119
|
-
|
|
1120
|
-
export declare interface ListJobsQueryParamProperties {
|
|
1121
|
-
/** Number of objects to return per page. */
|
|
1122
|
-
maxpagesize?: number;
|
|
1123
|
-
/**
|
|
1124
|
-
* If specified, filter jobs by status.
|
|
1125
|
-
*
|
|
1126
|
-
* Possible values: "all", "pendingClassification", "queued", "assigned", "completed", "closed", "cancelled", "classificationFailed", "created", "pendingSchedule", "scheduled", "scheduleFailed", "waitingForActivation", "active"
|
|
1127
|
-
*/
|
|
1128
|
-
status?: string;
|
|
1129
|
-
/** If specified, filter jobs by queue. */
|
|
1130
|
-
queueId?: string;
|
|
1131
|
-
/** If specified, filter jobs by channel. */
|
|
1132
|
-
channelId?: string;
|
|
1133
|
-
/** If specified, filter jobs by classificationPolicy. */
|
|
1134
|
-
classificationPolicyId?: string;
|
|
1135
|
-
/** If specified, filter on jobs that was scheduled before or at given timestamp. Range: (-Inf, scheduledBefore]. */
|
|
1136
|
-
scheduledBefore?: Date | string;
|
|
1137
|
-
/** If specified, filter on jobs that was scheduled at or after given value. Range: [scheduledAfter, +Inf). */
|
|
1138
|
-
scheduledAfter?: Date | string;
|
|
1139
|
-
}
|
|
1140
|
-
|
|
1141
|
-
export declare interface ListQueues {
|
|
1142
|
-
/** Retrieves existing queues. */
|
|
1143
|
-
get(options?: ListQueuesParameters): StreamableMethod<ListQueues200Response | ListQueuesDefaultResponse>;
|
|
1144
|
-
}
|
|
1145
|
-
|
|
1146
|
-
/** The request has succeeded. */
|
|
1147
|
-
export declare interface ListQueues200Response extends HttpResponse {
|
|
1148
|
-
status: "200";
|
|
1149
|
-
body: PagedRouterQueueOutput;
|
|
1150
|
-
}
|
|
1151
|
-
|
|
1152
|
-
export declare interface ListQueuesDefaultHeaders {
|
|
1153
|
-
/** String error code indicating what went wrong. */
|
|
1154
|
-
"x-ms-error-code"?: string;
|
|
1155
|
-
}
|
|
1156
|
-
|
|
1157
|
-
export declare interface ListQueuesDefaultResponse extends HttpResponse {
|
|
1158
|
-
status: string;
|
|
1159
|
-
body: ErrorResponse;
|
|
1160
|
-
headers: RawHttpHeaders & ListQueuesDefaultHeaders;
|
|
1161
|
-
}
|
|
1162
|
-
|
|
1163
|
-
export declare type ListQueuesParameters = ListQueuesQueryParam & RequestParameters;
|
|
1164
|
-
|
|
1165
|
-
export declare interface ListQueuesQueryParam {
|
|
1166
|
-
queryParameters?: ListQueuesQueryParamProperties;
|
|
1167
|
-
}
|
|
1168
|
-
|
|
1169
|
-
export declare interface ListQueuesQueryParamProperties {
|
|
1170
|
-
/** Number of objects to return per page. */
|
|
1171
|
-
maxpagesize?: number;
|
|
1172
|
-
}
|
|
1173
|
-
|
|
1174
|
-
export declare interface ListWorkers {
|
|
1175
|
-
/** Retrieves existing workers. */
|
|
1176
|
-
get(options?: ListWorkersParameters): StreamableMethod<ListWorkers200Response | ListWorkersDefaultResponse>;
|
|
1177
|
-
}
|
|
1178
|
-
|
|
1179
|
-
/** The request has succeeded. */
|
|
1180
|
-
export declare interface ListWorkers200Response extends HttpResponse {
|
|
1181
|
-
status: "200";
|
|
1182
|
-
body: PagedRouterWorkerOutput;
|
|
1183
|
-
}
|
|
1184
|
-
|
|
1185
|
-
export declare interface ListWorkersDefaultHeaders {
|
|
1186
|
-
/** String error code indicating what went wrong. */
|
|
1187
|
-
"x-ms-error-code"?: string;
|
|
1188
|
-
}
|
|
1189
|
-
|
|
1190
|
-
export declare interface ListWorkersDefaultResponse extends HttpResponse {
|
|
1191
|
-
status: string;
|
|
1192
|
-
body: ErrorResponse;
|
|
1193
|
-
headers: RawHttpHeaders & ListWorkersDefaultHeaders;
|
|
1194
|
-
}
|
|
1195
|
-
|
|
1196
|
-
export declare type ListWorkersParameters = ListWorkersQueryParam & RequestParameters;
|
|
1197
|
-
|
|
1198
|
-
export declare interface ListWorkersQueryParam {
|
|
1199
|
-
queryParameters?: ListWorkersQueryParamProperties;
|
|
1200
|
-
}
|
|
1201
|
-
|
|
1202
|
-
export declare interface ListWorkersQueryParamProperties {
|
|
1203
|
-
/** Number of objects to return per page. */
|
|
1204
|
-
maxpagesize?: number;
|
|
1205
|
-
/**
|
|
1206
|
-
* If specified, select workers by worker state.
|
|
1207
|
-
*
|
|
1208
|
-
* Possible values: "active", "draining", "inactive", "all"
|
|
1209
|
-
*/
|
|
1210
|
-
state?: string;
|
|
1211
|
-
/** If specified, select workers who have a channel configuration with this channel. */
|
|
1212
|
-
channelId?: string;
|
|
1213
|
-
/** If specified, select workers who are assigned to this queue. */
|
|
1214
|
-
queueId?: string;
|
|
1215
|
-
/** If set to true, select only workers who have capacity for the channel specified by `channelId` or for any channel if `channelId` not specified. If set to false, then will return all workers including workers without any capacity for jobs. Defaults to false. */
|
|
1216
|
-
hasCapacity?: boolean;
|
|
1217
|
-
}
|
|
1218
|
-
|
|
1219
|
-
/** Jobs are directed to the worker who has been idle longest. */
|
|
1220
|
-
export declare interface LongestIdleMode extends DistributionModeParent {
|
|
1221
|
-
/** The type discriminator describing a sub-type of Mode. */
|
|
1222
|
-
kind: "longestIdle";
|
|
1223
|
-
}
|
|
1224
|
-
|
|
1225
|
-
/** Jobs are directed to the worker who has been idle longest. */
|
|
1226
|
-
export declare interface LongestIdleModeOutput extends DistributionModeOutputParent {
|
|
1227
|
-
/** The type discriminator describing a sub-type of Mode. */
|
|
1228
|
-
kind: "longestIdle";
|
|
1229
|
-
}
|
|
1230
|
-
|
|
1231
|
-
/** An action that manually reclassifies a job by providing the queue, priority and worker selectors. */
|
|
1232
|
-
export declare interface ManualReclassifyExceptionAction extends ExceptionActionParent {
|
|
1233
|
-
/** Updated QueueId. */
|
|
1234
|
-
queueId?: string;
|
|
1235
|
-
/** Updated Priority. */
|
|
1236
|
-
priority?: number;
|
|
1237
|
-
/** Updated WorkerSelectors. */
|
|
1238
|
-
workerSelectors?: Array<RouterWorkerSelector>;
|
|
1239
|
-
/** The type discriminator describing a sub-type of ExceptionAction. */
|
|
1240
|
-
kind: "manualReclassify";
|
|
1241
|
-
}
|
|
1242
|
-
|
|
1243
|
-
/** An action that manually reclassifies a job by providing the queue, priority and worker selectors. */
|
|
1244
|
-
export declare interface ManualReclassifyExceptionActionOutput extends ExceptionActionOutputParent {
|
|
1245
|
-
/** Updated QueueId. */
|
|
1246
|
-
queueId?: string;
|
|
1247
|
-
/** Updated Priority. */
|
|
1248
|
-
priority?: number;
|
|
1249
|
-
/** Updated WorkerSelectors. */
|
|
1250
|
-
workerSelectors?: Array<RouterWorkerSelectorOutput>;
|
|
1251
|
-
/** The type discriminator describing a sub-type of ExceptionAction. */
|
|
1252
|
-
kind: "manualReclassify";
|
|
1253
|
-
}
|
|
1254
|
-
|
|
1255
|
-
/** OAuth2.0 Credentials used to Contoso's Authorization server. Reference: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/ */
|
|
1256
|
-
export declare interface OAuth2WebhookClientCredential {
|
|
1257
|
-
/** ClientId for Contoso Authorization server. */
|
|
1258
|
-
clientId?: string;
|
|
1259
|
-
/** Client secret for Contoso Authorization server. */
|
|
1260
|
-
clientSecret?: string;
|
|
1261
|
-
}
|
|
1262
|
-
|
|
1263
|
-
/** OAuth2.0 Credentials used to Contoso's Authorization server. Reference: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/ */
|
|
1264
|
-
export declare interface OAuth2WebhookClientCredentialOutput {
|
|
1265
|
-
/** ClientId for Contoso Authorization server. */
|
|
1266
|
-
clientId?: string;
|
|
1267
|
-
/** Client secret for Contoso Authorization server. */
|
|
1268
|
-
clientSecret?: string;
|
|
1269
|
-
}
|
|
1270
|
-
|
|
1271
|
-
/** Paged collection of ClassificationPolicy items */
|
|
1272
|
-
export declare type PagedClassificationPolicyOutput = Paged<ClassificationPolicyOutput>;
|
|
1273
|
-
|
|
1274
|
-
/** Paged collection of DistributionPolicy items */
|
|
1275
|
-
export declare type PagedDistributionPolicyOutput = Paged<DistributionPolicyOutput>;
|
|
1276
|
-
|
|
1277
|
-
/** Paged collection of ExceptionPolicy items */
|
|
1278
|
-
export declare type PagedExceptionPolicyOutput = Paged<ExceptionPolicyOutput>;
|
|
1279
|
-
|
|
1280
|
-
/** Paged collection of RouterJob items */
|
|
1281
|
-
export declare type PagedRouterJobOutput = Paged<RouterJobOutput>;
|
|
1282
|
-
|
|
1283
|
-
/** Paged collection of RouterQueue items */
|
|
1284
|
-
export declare type PagedRouterQueueOutput = Paged<RouterQueueOutput>;
|
|
1285
|
-
|
|
1286
|
-
/** Paged collection of RouterWorker items */
|
|
1287
|
-
export declare type PagedRouterWorkerOutput = Paged<RouterWorkerOutput>;
|
|
1288
|
-
|
|
1289
|
-
/**
|
|
1290
|
-
* Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension
|
|
1291
|
-
* @param client - Client to use for sending the next page requests
|
|
1292
|
-
* @param initialResponse - Initial response containing the nextLink and current page of elements
|
|
1293
|
-
* @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results
|
|
1294
|
-
* @returns - PagedAsyncIterableIterator to iterate the elements
|
|
1295
|
-
*/
|
|
1296
|
-
export declare function paginate<TResponse extends PathUncheckedResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>;
|
|
1297
|
-
|
|
1298
|
-
/**
|
|
1299
|
-
* Helper type to infer the Type of the paged elements from the response type
|
|
1300
|
-
* This type is generated based on the swagger information for x-ms-pageable
|
|
1301
|
-
* specifically on the itemName property which indicates the property of the response
|
|
1302
|
-
* where the page items are found. The default value is `value`.
|
|
1303
|
-
* This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
|
|
1304
|
-
*/
|
|
1305
|
-
export declare type PaginateReturn<TResult> = TResult extends {
|
|
1306
|
-
body: {
|
|
1307
|
-
value?: infer TPage;
|
|
1308
|
-
};
|
|
1309
|
-
} ? GetArrayType<TPage> : Array<unknown>;
|
|
1310
|
-
|
|
1311
|
-
/**
|
|
1312
|
-
* Options for the paging helper
|
|
1313
|
-
*/
|
|
1314
|
-
export declare interface PagingOptions<TResponse> {
|
|
1315
|
-
/**
|
|
1316
|
-
* Custom function to extract pagination details for crating the PagedAsyncIterableIterator
|
|
1317
|
-
*/
|
|
1318
|
-
customGetPage?: GetPage<PaginateReturn<TResponse>[]>;
|
|
1319
|
-
}
|
|
1320
|
-
|
|
1321
|
-
/** Attaches a queue selector where the value is passed through from a job's label with the same key. */
|
|
1322
|
-
export declare interface PassThroughQueueSelectorAttachment extends QueueSelectorAttachmentParent {
|
|
1323
|
-
/** The label key to query against. */
|
|
1324
|
-
key: string;
|
|
1325
|
-
/**
|
|
1326
|
-
* Describes how the value of the label is compared to the value pass through.
|
|
1327
|
-
*
|
|
1328
|
-
* Possible values: "equal", "notEqual", "lessThan", "lessThanOrEqual", "greaterThan", "greaterThanOrEqual"
|
|
1329
|
-
*/
|
|
1330
|
-
labelOperator: string;
|
|
1331
|
-
/** The type discriminator describing the type of queue selector attachment. */
|
|
1332
|
-
kind: "passThrough";
|
|
1333
|
-
}
|
|
1334
|
-
|
|
1335
|
-
/** Attaches a queue selector where the value is passed through from a job's label with the same key. */
|
|
1336
|
-
export declare interface PassThroughQueueSelectorAttachmentOutput extends QueueSelectorAttachmentOutputParent {
|
|
1337
|
-
/** The label key to query against. */
|
|
1338
|
-
key: string;
|
|
1339
|
-
/**
|
|
1340
|
-
* Describes how the value of the label is compared to the value pass through.
|
|
1341
|
-
*
|
|
1342
|
-
* Possible values: "equal", "notEqual", "lessThan", "lessThanOrEqual", "greaterThan", "greaterThanOrEqual"
|
|
1343
|
-
*/
|
|
1344
|
-
labelOperator: string;
|
|
1345
|
-
/** The type discriminator describing the type of queue selector attachment. */
|
|
1346
|
-
kind: "passThrough";
|
|
1347
|
-
}
|
|
1348
|
-
|
|
1349
|
-
/** Attaches a worker selector where the value is passed through from a job's label with the same key. */
|
|
1350
|
-
export declare interface PassThroughWorkerSelectorAttachment extends WorkerSelectorAttachmentParent {
|
|
1351
|
-
/** The label key to query against. */
|
|
1352
|
-
key: string;
|
|
1353
|
-
/**
|
|
1354
|
-
* Describes how the value of the label is compared to the value pass through.
|
|
1355
|
-
*
|
|
1356
|
-
* Possible values: "equal", "notEqual", "lessThan", "lessThanOrEqual", "greaterThan", "greaterThanOrEqual"
|
|
1357
|
-
*/
|
|
1358
|
-
labelOperator: string;
|
|
1359
|
-
/** Describes how long the attached label selector is valid in seconds. */
|
|
1360
|
-
expiresAfterSeconds?: number;
|
|
1361
|
-
/** The type discriminator describing the type of worker selector attachment. */
|
|
1362
|
-
kind: "passThrough";
|
|
1363
|
-
}
|
|
1364
|
-
|
|
1365
|
-
/** Attaches a worker selector where the value is passed through from a job's label with the same key. */
|
|
1366
|
-
export declare interface PassThroughWorkerSelectorAttachmentOutput extends WorkerSelectorAttachmentOutputParent {
|
|
1367
|
-
/** The label key to query against. */
|
|
1368
|
-
key: string;
|
|
1369
|
-
/**
|
|
1370
|
-
* Describes how the value of the label is compared to the value pass through.
|
|
1371
|
-
*
|
|
1372
|
-
* Possible values: "equal", "notEqual", "lessThan", "lessThanOrEqual", "greaterThan", "greaterThanOrEqual"
|
|
1373
|
-
*/
|
|
1374
|
-
labelOperator: string;
|
|
1375
|
-
/** Describes how long the attached label selector is valid in seconds. */
|
|
1376
|
-
expiresAfterSeconds?: number;
|
|
1377
|
-
/** The type discriminator describing the type of worker selector attachment. */
|
|
1378
|
-
kind: "passThrough";
|
|
1379
|
-
}
|
|
1380
|
-
|
|
1381
|
-
/** Describes a matching mode where matching worker to a job is automatically started after job is queued successfully. */
|
|
1382
|
-
export declare interface QueueAndMatchMode extends JobMatchingModeParent {
|
|
1383
|
-
/** The type discriminator describing QueueAndMatchMode */
|
|
1384
|
-
kind: "queueAndMatch";
|
|
1385
|
-
}
|
|
1386
|
-
|
|
1387
|
-
/** Describes a matching mode where matching worker to a job is automatically started after job is queued successfully. */
|
|
1388
|
-
export declare interface QueueAndMatchModeOutput extends JobMatchingModeOutputParent {
|
|
1389
|
-
/** The type discriminator describing QueueAndMatchMode */
|
|
1390
|
-
kind: "queueAndMatch";
|
|
1391
|
-
}
|
|
1392
|
-
|
|
1393
|
-
/** Trigger for an exception action on exceeding queue length. */
|
|
1394
|
-
export declare interface QueueLengthExceptionTrigger extends ExceptionTriggerParent {
|
|
1395
|
-
/** Threshold of number of jobs ahead in the queue to for this trigger to fire. */
|
|
1396
|
-
threshold: number;
|
|
1397
|
-
/** The type discriminator describing a sub-type of ExceptionTrigger. */
|
|
1398
|
-
kind: "queueLength";
|
|
1399
|
-
}
|
|
1400
|
-
|
|
1401
|
-
/** Trigger for an exception action on exceeding queue length. */
|
|
1402
|
-
export declare interface QueueLengthExceptionTriggerOutput extends ExceptionTriggerOutputParent {
|
|
1403
|
-
/** Threshold of number of jobs ahead in the queue to for this trigger to fire. */
|
|
1404
|
-
threshold: number;
|
|
1405
|
-
/** The type discriminator describing a sub-type of ExceptionTrigger. */
|
|
1406
|
-
kind: "queueLength";
|
|
1407
|
-
}
|
|
1408
|
-
|
|
1409
|
-
/** An attachment of queue selectors to resolve a queue to a job from a classification policy. */
|
|
1410
|
-
export declare type QueueSelectorAttachment = QueueSelectorAttachmentParent | ConditionalQueueSelectorAttachment | PassThroughQueueSelectorAttachment | RuleEngineQueueSelectorAttachment | StaticQueueSelectorAttachment | WeightedAllocationQueueSelectorAttachment;
|
|
1411
|
-
|
|
1412
|
-
/** An attachment of queue selectors to resolve a queue to a job from a classification policy. */
|
|
1413
|
-
export declare type QueueSelectorAttachmentOutput = QueueSelectorAttachmentOutputParent | ConditionalQueueSelectorAttachmentOutput | PassThroughQueueSelectorAttachmentOutput | RuleEngineQueueSelectorAttachmentOutput | StaticQueueSelectorAttachmentOutput | WeightedAllocationQueueSelectorAttachmentOutput;
|
|
1414
|
-
|
|
1415
|
-
/** An attachment of queue selectors to resolve a queue to a job from a classification policy. */
|
|
1416
|
-
export declare interface QueueSelectorAttachmentOutputParent {
|
|
1417
|
-
kind: string;
|
|
1418
|
-
}
|
|
1419
|
-
|
|
1420
|
-
/** An attachment of queue selectors to resolve a queue to a job from a classification policy. */
|
|
1421
|
-
export declare interface QueueSelectorAttachmentParent {
|
|
1422
|
-
kind: string;
|
|
1423
|
-
}
|
|
1424
|
-
|
|
1425
|
-
/** Contains the weight percentage and queue selectors to be applied if selected for weighted distributions. */
|
|
1426
|
-
export declare interface QueueWeightedAllocation {
|
|
1427
|
-
/** The percentage of this weight, expressed as a fraction of 1. */
|
|
1428
|
-
weight: number;
|
|
1429
|
-
/** A collection of queue selectors that will be applied if this allocation is selected. */
|
|
1430
|
-
queueSelectors: Array<RouterQueueSelector>;
|
|
1431
|
-
}
|
|
1432
|
-
|
|
1433
|
-
/** Contains the weight percentage and queue selectors to be applied if selected for weighted distributions. */
|
|
1434
|
-
export declare interface QueueWeightedAllocationOutput {
|
|
1435
|
-
/** The percentage of this weight, expressed as a fraction of 1. */
|
|
1436
|
-
weight: number;
|
|
1437
|
-
/** A collection of queue selectors that will be applied if this allocation is selected. */
|
|
1438
|
-
queueSelectors: Array<RouterQueueSelectorOutput>;
|
|
1439
|
-
}
|
|
1440
|
-
|
|
1441
|
-
export declare interface Reclassify {
|
|
1442
|
-
/** Reclassify a job. */
|
|
1443
|
-
post(options?: ReclassifyParameters): StreamableMethod<Reclassify200Response | ReclassifyDefaultResponse>;
|
|
1444
|
-
}
|
|
1445
|
-
|
|
1446
|
-
/** The request has succeeded. */
|
|
1447
|
-
export declare interface Reclassify200Response extends HttpResponse {
|
|
1448
|
-
status: "200";
|
|
1449
|
-
body: ReclassifyJobResultOutput;
|
|
1450
|
-
}
|
|
1451
|
-
|
|
1452
|
-
export declare interface ReclassifyBodyParam {
|
|
1453
|
-
/** Request object for reclassifying a job. */
|
|
1454
|
-
body?: ReclassifyJobOptions;
|
|
1455
|
-
}
|
|
1456
|
-
|
|
1457
|
-
export declare interface ReclassifyDefaultHeaders {
|
|
1458
|
-
/** String error code indicating what went wrong. */
|
|
1459
|
-
"x-ms-error-code"?: string;
|
|
1460
|
-
}
|
|
1461
|
-
|
|
1462
|
-
export declare interface ReclassifyDefaultResponse extends HttpResponse {
|
|
1463
|
-
status: string;
|
|
1464
|
-
body: ErrorResponse;
|
|
1465
|
-
headers: RawHttpHeaders & ReclassifyDefaultHeaders;
|
|
1466
|
-
}
|
|
1467
|
-
|
|
1468
|
-
/** An action that modifies labels on a job and then reclassifies it. */
|
|
1469
|
-
export declare interface ReclassifyExceptionAction extends ExceptionActionParent {
|
|
1470
|
-
/** The new classification policy that will determine queue, priority and worker selectors. */
|
|
1471
|
-
classificationPolicyId?: string;
|
|
1472
|
-
/** Dictionary containing the labels to update (or add if not existing) in key-value pairs. Values must be primitive values - number, string, boolean. */
|
|
1473
|
-
labelsToUpsert?: Record<string, unknown>;
|
|
1474
|
-
/** The type discriminator describing a sub-type of ExceptionAction. */
|
|
1475
|
-
kind: "reclassify";
|
|
1476
|
-
}
|
|
1477
|
-
|
|
1478
|
-
/** An action that modifies labels on a job and then reclassifies it. */
|
|
1479
|
-
export declare interface ReclassifyExceptionActionOutput extends ExceptionActionOutputParent {
|
|
1480
|
-
/** The new classification policy that will determine queue, priority and worker selectors. */
|
|
1481
|
-
classificationPolicyId?: string;
|
|
1482
|
-
/** Dictionary containing the labels to update (or add if not existing) in key-value pairs. Values must be primitive values - number, string, boolean. */
|
|
1483
|
-
labelsToUpsert?: Record<string, any>;
|
|
1484
|
-
/** The type discriminator describing a sub-type of ExceptionAction. */
|
|
1485
|
-
kind: "reclassify";
|
|
1486
|
-
}
|
|
1487
|
-
|
|
1488
|
-
/** Request payload for reclassifying jobs. */
|
|
1489
|
-
export declare interface ReclassifyJobOptions {
|
|
1490
|
-
}
|
|
1491
|
-
|
|
1492
|
-
/** Response payload from reclassifying a job. */
|
|
1493
|
-
export declare interface ReclassifyJobResultOutput {
|
|
1494
|
-
}
|
|
1495
|
-
|
|
1496
|
-
export declare type ReclassifyParameters = ReclassifyBodyParam & RequestParameters;
|
|
1497
|
-
|
|
1498
|
-
/** Jobs are distributed in order to workers, starting with the worker that is after the last worker to receive a job. */
|
|
1499
|
-
export declare interface RoundRobinMode extends DistributionModeParent {
|
|
1500
|
-
/** The type discriminator describing a sub-type of Mode. */
|
|
1501
|
-
kind: "roundRobin";
|
|
1502
|
-
}
|
|
1503
|
-
|
|
1504
|
-
/** Jobs are distributed in order to workers, starting with the worker that is after the last worker to receive a job. */
|
|
1505
|
-
export declare interface RoundRobinModeOutput extends DistributionModeOutputParent {
|
|
1506
|
-
/** The type discriminator describing a sub-type of Mode. */
|
|
1507
|
-
kind: "roundRobin";
|
|
1508
|
-
}
|
|
1509
|
-
|
|
1510
|
-
/** Represents the capacity a job in this channel will consume from a worker. */
|
|
1511
|
-
export declare interface RouterChannel {
|
|
1512
|
-
/** Id of a channel. */
|
|
1513
|
-
channelId: string;
|
|
1514
|
-
/** The amount of capacity that an instance of a job of this channel will consume of the total worker capacity. */
|
|
1515
|
-
capacityCostPerJob: number;
|
|
1516
|
-
/** The maximum number of jobs that can be supported concurrently for this channel. */
|
|
1517
|
-
maxNumberOfJobs?: number;
|
|
1518
|
-
}
|
|
1519
|
-
|
|
1520
|
-
/** Represents the capacity a job in this channel will consume from a worker. */
|
|
1521
|
-
export declare interface RouterChannelOutput {
|
|
1522
|
-
/** Id of a channel. */
|
|
1523
|
-
channelId: string;
|
|
1524
|
-
/** The amount of capacity that an instance of a job of this channel will consume of the total worker capacity. */
|
|
1525
|
-
capacityCostPerJob: number;
|
|
1526
|
-
/** The maximum number of jobs that can be supported concurrently for this channel. */
|
|
1527
|
-
maxNumberOfJobs?: number;
|
|
1528
|
-
}
|
|
1529
|
-
|
|
1530
|
-
/** Provides the 'If-*' headers to enable conditional (cached) responses for JobRouter. */
|
|
1531
|
-
export declare interface RouterConditionalRequestHeadersOutput {
|
|
1532
|
-
}
|
|
1533
|
-
|
|
1534
|
-
/** A unit of work to be routed */
|
|
1535
|
-
export declare interface RouterJob {
|
|
1536
|
-
/** Reference to an external parent context, eg. call ID. */
|
|
1537
|
-
channelReference?: string;
|
|
1538
|
-
/** The channel identifier. eg. voice, chat, etc. */
|
|
1539
|
-
channelId?: string;
|
|
1540
|
-
/** Id of a classification policy used for classifying this job. */
|
|
1541
|
-
classificationPolicyId?: string;
|
|
1542
|
-
/** Id of a queue that this job is queued to. */
|
|
1543
|
-
queueId?: string;
|
|
1544
|
-
/** Priority of this job. */
|
|
1545
|
-
priority?: number;
|
|
1546
|
-
/** Reason code for cancelled or closed jobs. */
|
|
1547
|
-
dispositionCode?: string;
|
|
1548
|
-
/** A collection of manually specified worker selectors, which a worker must satisfy in order to process this job. */
|
|
1549
|
-
requestedWorkerSelectors?: Array<RouterWorkerSelector>;
|
|
1550
|
-
/** A set of key/value pairs that are identifying attributes used by the rules engines to make decisions. Values must be primitive values - number, string, boolean. */
|
|
1551
|
-
labels?: Record<string, unknown>;
|
|
1552
|
-
/** A set of non-identifying attributes attached to this job. Values must be primitive values - number, string, boolean. */
|
|
1553
|
-
tags?: Record<string, unknown>;
|
|
1554
|
-
/** Notes attached to a job, sorted by timestamp. */
|
|
1555
|
-
notes?: Array<RouterJobNote>;
|
|
1556
|
-
/** If provided, will determine how job matching will be carried out. Default mode: QueueAndMatchMode. */
|
|
1557
|
-
matchingMode?: JobMatchingMode;
|
|
1558
|
-
}
|
|
1559
|
-
|
|
1560
|
-
/** Assignment details of a job to a worker. */
|
|
1561
|
-
export declare interface RouterJobAssignment {
|
|
1562
|
-
/** Id of the Worker assigned to the job. */
|
|
1563
|
-
workerId?: string;
|
|
1564
|
-
/** Timestamp when the job was assigned to a worker in UTC. */
|
|
1565
|
-
assignedAt: Date | string;
|
|
1566
|
-
/** Timestamp when the job was marked as completed after being assigned in UTC. */
|
|
1567
|
-
completedAt?: Date | string;
|
|
1568
|
-
/** Timestamp when the job was marked as closed after being completed in UTC. */
|
|
1569
|
-
closedAt?: Date | string;
|
|
1570
|
-
}
|
|
1571
|
-
|
|
1572
|
-
/** Assignment details of a job to a worker. */
|
|
1573
|
-
export declare interface RouterJobAssignmentOutput {
|
|
1574
|
-
/** Id of a job assignment. */
|
|
1575
|
-
readonly assignmentId: string;
|
|
1576
|
-
/** Id of the Worker assigned to the job. */
|
|
1577
|
-
workerId?: string;
|
|
1578
|
-
/** Timestamp when the job was assigned to a worker in UTC. */
|
|
1579
|
-
assignedAt: string;
|
|
1580
|
-
/** Timestamp when the job was marked as completed after being assigned in UTC. */
|
|
1581
|
-
completedAt?: string;
|
|
1582
|
-
/** Timestamp when the job was marked as closed after being completed in UTC. */
|
|
1583
|
-
closedAt?: string;
|
|
1584
|
-
}
|
|
1585
|
-
|
|
1586
|
-
/** A note attached to a job. */
|
|
1587
|
-
export declare interface RouterJobNote {
|
|
1588
|
-
/** The message contained in the note. */
|
|
1589
|
-
message: string;
|
|
1590
|
-
/** The time at which the note was added in UTC. If not provided, will default to the current time. */
|
|
1591
|
-
addedAt?: Date | string;
|
|
1592
|
-
}
|
|
1593
|
-
|
|
1594
|
-
/** A note attached to a job. */
|
|
1595
|
-
export declare interface RouterJobNoteOutput {
|
|
1596
|
-
/** The message contained in the note. */
|
|
1597
|
-
message: string;
|
|
1598
|
-
/** The time at which the note was added in UTC. If not provided, will default to the current time. */
|
|
1599
|
-
addedAt?: string;
|
|
1600
|
-
}
|
|
1601
|
-
|
|
1602
|
-
/** An offer of a job to a worker. */
|
|
1603
|
-
export declare interface RouterJobOffer {
|
|
1604
|
-
/** Id of the job. */
|
|
1605
|
-
jobId: string;
|
|
1606
|
-
/** The capacity cost consumed by the job offer. */
|
|
1607
|
-
capacityCost: number;
|
|
1608
|
-
/** Timestamp when the offer was created in UTC. */
|
|
1609
|
-
offeredAt?: Date | string;
|
|
1610
|
-
/** Timestamp when the offer will expire in UTC. */
|
|
1611
|
-
expiresAt?: Date | string;
|
|
1612
|
-
}
|
|
1613
|
-
|
|
1614
|
-
/** An offer of a job to a worker. */
|
|
1615
|
-
export declare interface RouterJobOfferOutput {
|
|
1616
|
-
/** Id of an offer. */
|
|
1617
|
-
readonly offerId: string;
|
|
1618
|
-
/** Id of the job. */
|
|
1619
|
-
jobId: string;
|
|
1620
|
-
/** The capacity cost consumed by the job offer. */
|
|
1621
|
-
capacityCost: number;
|
|
1622
|
-
/** Timestamp when the offer was created in UTC. */
|
|
1623
|
-
offeredAt?: string;
|
|
1624
|
-
/** Timestamp when the offer will expire in UTC. */
|
|
1625
|
-
expiresAt?: string;
|
|
1626
|
-
}
|
|
1627
|
-
|
|
1628
|
-
/** A unit of work to be routed */
|
|
1629
|
-
export declare interface RouterJobOutput {
|
|
1630
|
-
/** The entity tag for this resource. */
|
|
1631
|
-
readonly etag: string;
|
|
1632
|
-
/** Id of a job. */
|
|
1633
|
-
readonly id: string;
|
|
1634
|
-
/** Reference to an external parent context, eg. call ID. */
|
|
1635
|
-
channelReference?: string;
|
|
1636
|
-
/**
|
|
1637
|
-
* The status of the job.
|
|
1638
|
-
*
|
|
1639
|
-
* Possible values: "pendingClassification", "queued", "assigned", "completed", "closed", "cancelled", "classificationFailed", "created", "pendingSchedule", "scheduled", "scheduleFailed", "waitingForActivation"
|
|
1640
|
-
*/
|
|
1641
|
-
readonly status?: string;
|
|
1642
|
-
/** Timestamp a job was queued in UTC. */
|
|
1643
|
-
readonly enqueuedAt?: string;
|
|
1644
|
-
/** The channel identifier. eg. voice, chat, etc. */
|
|
1645
|
-
channelId?: string;
|
|
1646
|
-
/** Id of a classification policy used for classifying this job. */
|
|
1647
|
-
classificationPolicyId?: string;
|
|
1648
|
-
/** Id of a queue that this job is queued to. */
|
|
1649
|
-
queueId?: string;
|
|
1650
|
-
/** Priority of this job. */
|
|
1651
|
-
priority?: number;
|
|
1652
|
-
/** Reason code for cancelled or closed jobs. */
|
|
1653
|
-
dispositionCode?: string;
|
|
1654
|
-
/** A collection of manually specified worker selectors, which a worker must satisfy in order to process this job. */
|
|
1655
|
-
requestedWorkerSelectors?: Array<RouterWorkerSelectorOutput>;
|
|
1656
|
-
/** A collection of worker selectors attached by a classification policy, which a worker must satisfy in order to process this job. */
|
|
1657
|
-
readonly attachedWorkerSelectors?: Array<RouterWorkerSelectorOutput>;
|
|
1658
|
-
/** A set of key/value pairs that are identifying attributes used by the rules engines to make decisions. Values must be primitive values - number, string, boolean. */
|
|
1659
|
-
labels?: Record<string, any>;
|
|
1660
|
-
/** A collection of the assignments of the job. Key is AssignmentId. */
|
|
1661
|
-
readonly assignments?: Record<string, RouterJobAssignmentOutput>;
|
|
1662
|
-
/** A set of non-identifying attributes attached to this job. Values must be primitive values - number, string, boolean. */
|
|
1663
|
-
tags?: Record<string, any>;
|
|
1664
|
-
/** Notes attached to a job, sorted by timestamp. */
|
|
1665
|
-
notes?: Array<RouterJobNoteOutput>;
|
|
1666
|
-
/** If set, job will be scheduled to be enqueued at a given time. */
|
|
1667
|
-
readonly scheduledAt?: string;
|
|
1668
|
-
/** If provided, will determine how job matching will be carried out. Default mode: QueueAndMatchMode. */
|
|
1669
|
-
matchingMode?: JobMatchingModeOutput;
|
|
1670
|
-
}
|
|
1671
|
-
|
|
1672
|
-
/** Position and estimated wait time for a job. */
|
|
1673
|
-
export declare interface RouterJobPositionDetailsOutput {
|
|
1674
|
-
/** Id of the job these details are about. */
|
|
1675
|
-
jobId: string;
|
|
1676
|
-
/** Position of the job in question within that queue. */
|
|
1677
|
-
position: number;
|
|
1678
|
-
/** Id of the queue this job is enqueued in. */
|
|
1679
|
-
queueId: string;
|
|
1680
|
-
/** Length of the queue: total number of enqueued jobs. */
|
|
1681
|
-
queueLength: number;
|
|
1682
|
-
/** Estimated wait time of the job rounded up to the nearest minute. */
|
|
1683
|
-
estimatedWaitTimeMinutes: number;
|
|
1684
|
-
}
|
|
1685
|
-
|
|
1686
|
-
/** The resource instance. */
|
|
1687
|
-
export declare type RouterJobResourceMergeAndPatch = Partial<RouterJob>;
|
|
1688
|
-
|
|
1689
|
-
/** A queue that can contain jobs to be routed. */
|
|
1690
|
-
export declare interface RouterQueue {
|
|
1691
|
-
/** Friendly name of this queue. */
|
|
1692
|
-
name?: string;
|
|
1693
|
-
/** Id of a distribution policy that will determine how a job is distributed to workers. */
|
|
1694
|
-
distributionPolicyId?: string;
|
|
1695
|
-
/** A set of key/value pairs that are identifying attributes used by the rules engines to make decisions. Values must be primitive values - number, string, boolean. */
|
|
1696
|
-
labels?: Record<string, unknown>;
|
|
1697
|
-
/** Id of an exception policy that determines various job escalation rules. */
|
|
1698
|
-
exceptionPolicyId?: string;
|
|
1699
|
-
}
|
|
1700
|
-
|
|
1701
|
-
/** A queue that can contain jobs to be routed. */
|
|
1702
|
-
export declare interface RouterQueueOutput {
|
|
1703
|
-
/** The entity tag for this resource. */
|
|
1704
|
-
readonly etag: string;
|
|
1705
|
-
/** Id of a queue. */
|
|
1706
|
-
readonly id: string;
|
|
1707
|
-
/** Friendly name of this queue. */
|
|
1708
|
-
name?: string;
|
|
1709
|
-
/** Id of a distribution policy that will determine how a job is distributed to workers. */
|
|
1710
|
-
distributionPolicyId?: string;
|
|
1711
|
-
/** A set of key/value pairs that are identifying attributes used by the rules engines to make decisions. Values must be primitive values - number, string, boolean. */
|
|
1712
|
-
labels?: Record<string, any>;
|
|
1713
|
-
/** Id of an exception policy that determines various job escalation rules. */
|
|
1714
|
-
exceptionPolicyId?: string;
|
|
1715
|
-
}
|
|
1716
|
-
|
|
1717
|
-
/** The resource instance. */
|
|
1718
|
-
export declare type RouterQueueResourceMergeAndPatch = Partial<RouterQueue>;
|
|
1719
|
-
|
|
1720
|
-
/** Describes a condition that must be met against a set of labels for queue selection. */
|
|
1721
|
-
export declare interface RouterQueueSelector {
|
|
1722
|
-
/** The label key to query against. */
|
|
1723
|
-
key: string;
|
|
1724
|
-
/**
|
|
1725
|
-
* Describes how the value of the label is compared to the value defined on the label selector.
|
|
1726
|
-
*
|
|
1727
|
-
* Possible values: "equal", "notEqual", "lessThan", "lessThanOrEqual", "greaterThan", "greaterThanOrEqual"
|
|
1728
|
-
*/
|
|
1729
|
-
labelOperator: string;
|
|
1730
|
-
/** The value to compare against the actual label value with the given operator. Values must be primitive values - number, string, boolean. */
|
|
1731
|
-
value?: unknown;
|
|
1732
|
-
}
|
|
1733
|
-
|
|
1734
|
-
/** Describes a condition that must be met against a set of labels for queue selection. */
|
|
1735
|
-
export declare interface RouterQueueSelectorOutput {
|
|
1736
|
-
/** The label key to query against. */
|
|
1737
|
-
key: string;
|
|
1738
|
-
/**
|
|
1739
|
-
* Describes how the value of the label is compared to the value defined on the label selector.
|
|
1740
|
-
*
|
|
1741
|
-
* Possible values: "equal", "notEqual", "lessThan", "lessThanOrEqual", "greaterThan", "greaterThanOrEqual"
|
|
1742
|
-
*/
|
|
1743
|
-
labelOperator: string;
|
|
1744
|
-
/** The value to compare against the actual label value with the given operator. Values must be primitive values - number, string, boolean. */
|
|
1745
|
-
value?: any;
|
|
1746
|
-
}
|
|
1747
|
-
|
|
1748
|
-
/** Statistics for the queue. */
|
|
1749
|
-
export declare interface RouterQueueStatisticsOutput {
|
|
1750
|
-
/** Id of the queue these details are about. */
|
|
1751
|
-
queueId: string;
|
|
1752
|
-
/** Length of the queue: total number of enqueued jobs. */
|
|
1753
|
-
length: number;
|
|
1754
|
-
/** The estimated wait time of this queue rounded up to the nearest minute, grouped by job priority. */
|
|
1755
|
-
estimatedWaitTimeMinutes?: Record<string, number>;
|
|
1756
|
-
/** The wait time of the job that has been enqueued in this queue for the longest. */
|
|
1757
|
-
longestJobWaitTimeMinutes?: number;
|
|
1758
|
-
}
|
|
1759
|
-
|
|
1760
|
-
/**
|
|
1761
|
-
* A rule of one of the following types:
|
|
1762
|
-
* StaticRule: A rule providing static rules that always return the same result, regardless of input.
|
|
1763
|
-
* DirectMapRule: A rule that return the same labels as the input labels.
|
|
1764
|
-
* ExpressionRule: A rule providing inline expression rules.
|
|
1765
|
-
* FunctionRule: A rule providing a binding to an HTTP Triggered Azure Function.
|
|
1766
|
-
* WebhookRule: A rule providing a binding to a webserver following OAuth2.0 authentication protocol.
|
|
1767
|
-
*/
|
|
1768
|
-
export declare type RouterRule = RouterRuleParent | DirectMapRouterRule | ExpressionRouterRule | FunctionRouterRule | StaticRouterRule | WebhookRouterRule;
|
|
1769
|
-
|
|
1770
|
-
/**
|
|
1771
|
-
* A rule of one of the following types:
|
|
1772
|
-
* StaticRule: A rule providing static rules that always return the same result, regardless of input.
|
|
1773
|
-
* DirectMapRule: A rule that return the same labels as the input labels.
|
|
1774
|
-
* ExpressionRule: A rule providing inline expression rules.
|
|
1775
|
-
* FunctionRule: A rule providing a binding to an HTTP Triggered Azure Function.
|
|
1776
|
-
* WebhookRule: A rule providing a binding to a webserver following OAuth2.0 authentication protocol.
|
|
1777
|
-
*/
|
|
1778
|
-
export declare type RouterRuleOutput = RouterRuleOutputParent | DirectMapRouterRuleOutput | ExpressionRouterRuleOutput | FunctionRouterRuleOutput | StaticRouterRuleOutput | WebhookRouterRuleOutput;
|
|
1779
|
-
|
|
1780
|
-
/**
|
|
1781
|
-
* A rule of one of the following types:
|
|
1782
|
-
* StaticRule: A rule providing static rules that always return the same result, regardless of input.
|
|
1783
|
-
* DirectMapRule: A rule that return the same labels as the input labels.
|
|
1784
|
-
* ExpressionRule: A rule providing inline expression rules.
|
|
1785
|
-
* FunctionRule: A rule providing a binding to an HTTP Triggered Azure Function.
|
|
1786
|
-
* WebhookRule: A rule providing a binding to a webserver following OAuth2.0 authentication protocol.
|
|
1787
|
-
*/
|
|
1788
|
-
export declare interface RouterRuleOutputParent {
|
|
1789
|
-
kind: string;
|
|
1790
|
-
}
|
|
1791
|
-
|
|
1792
|
-
/**
|
|
1793
|
-
* A rule of one of the following types:
|
|
1794
|
-
* StaticRule: A rule providing static rules that always return the same result, regardless of input.
|
|
1795
|
-
* DirectMapRule: A rule that return the same labels as the input labels.
|
|
1796
|
-
* ExpressionRule: A rule providing inline expression rules.
|
|
1797
|
-
* FunctionRule: A rule providing a binding to an HTTP Triggered Azure Function.
|
|
1798
|
-
* WebhookRule: A rule providing a binding to a webserver following OAuth2.0 authentication protocol.
|
|
1799
|
-
*/
|
|
1800
|
-
export declare interface RouterRuleParent {
|
|
1801
|
-
kind: string;
|
|
1802
|
-
}
|
|
1803
|
-
|
|
1804
|
-
/** An entity for jobs to be routed to. */
|
|
1805
|
-
export declare interface RouterWorker {
|
|
1806
|
-
/** Collection of queue(s) that this worker can receive work from. */
|
|
1807
|
-
queues?: string[];
|
|
1808
|
-
/** The total capacity score this worker has to manage multiple concurrent jobs. */
|
|
1809
|
-
capacity?: number;
|
|
1810
|
-
/** A set of key/value pairs that are identifying attributes used by the rules engines to make decisions. Values must be primitive values - number, string, boolean. */
|
|
1811
|
-
labels?: Record<string, unknown>;
|
|
1812
|
-
/** A set of non-identifying attributes attached to this worker. Values must be primitive values - number, string, boolean. */
|
|
1813
|
-
tags?: Record<string, unknown>;
|
|
1814
|
-
/** Collection of channel(s) this worker can handle and their impact on the workers capacity. */
|
|
1815
|
-
channels?: Array<RouterChannel>;
|
|
1816
|
-
/** A flag indicating this worker is open to receive offers or not. */
|
|
1817
|
-
availableForOffers?: boolean;
|
|
1818
|
-
/** If this is set, the worker will only receive up to this many new offers at a time. */
|
|
1819
|
-
maxConcurrentOffers?: number;
|
|
1820
|
-
}
|
|
1821
|
-
|
|
1822
|
-
/** The assignment for a worker to a job. */
|
|
1823
|
-
export declare interface RouterWorkerAssignment {
|
|
1824
|
-
/** Id of the assignment. */
|
|
1825
|
-
assignmentId: string;
|
|
1826
|
-
/** Id of the job assigned. */
|
|
1827
|
-
jobId: string;
|
|
1828
|
-
/** The amount of capacity this assignment has consumed on the worker. */
|
|
1829
|
-
capacityCost: number;
|
|
1830
|
-
/** The assignment time of the job in UTC. */
|
|
1831
|
-
assignedAt: Date | string;
|
|
1832
|
-
}
|
|
1833
|
-
|
|
1834
|
-
/** The assignment for a worker to a job. */
|
|
1835
|
-
export declare interface RouterWorkerAssignmentOutput {
|
|
1836
|
-
/** Id of the assignment. */
|
|
1837
|
-
assignmentId: string;
|
|
1838
|
-
/** Id of the job assigned. */
|
|
1839
|
-
jobId: string;
|
|
1840
|
-
/** The amount of capacity this assignment has consumed on the worker. */
|
|
1841
|
-
capacityCost: number;
|
|
1842
|
-
/** The assignment time of the job in UTC. */
|
|
1843
|
-
assignedAt: string;
|
|
1844
|
-
}
|
|
1845
|
-
|
|
1846
|
-
/** An entity for jobs to be routed to. */
|
|
1847
|
-
export declare interface RouterWorkerOutput {
|
|
1848
|
-
/** The entity tag for this resource. */
|
|
1849
|
-
readonly etag: string;
|
|
1850
|
-
/** Id of a worker. */
|
|
1851
|
-
readonly id: string;
|
|
1852
|
-
/**
|
|
1853
|
-
* Current state of a worker.
|
|
1854
|
-
*
|
|
1855
|
-
* Possible values: "active", "draining", "inactive"
|
|
1856
|
-
*/
|
|
1857
|
-
readonly state?: string;
|
|
1858
|
-
/** Collection of queue(s) that this worker can receive work from. */
|
|
1859
|
-
queues?: string[];
|
|
1860
|
-
/** The total capacity score this worker has to manage multiple concurrent jobs. */
|
|
1861
|
-
capacity?: number;
|
|
1862
|
-
/** A set of key/value pairs that are identifying attributes used by the rules engines to make decisions. Values must be primitive values - number, string, boolean. */
|
|
1863
|
-
labels?: Record<string, any>;
|
|
1864
|
-
/** A set of non-identifying attributes attached to this worker. Values must be primitive values - number, string, boolean. */
|
|
1865
|
-
tags?: Record<string, any>;
|
|
1866
|
-
/** Collection of channel(s) this worker can handle and their impact on the workers capacity. */
|
|
1867
|
-
channels?: Array<RouterChannelOutput>;
|
|
1868
|
-
/** A list of active offers issued to this worker. */
|
|
1869
|
-
readonly offers?: Array<RouterJobOfferOutput>;
|
|
1870
|
-
/** A list of assigned jobs attached to this worker. */
|
|
1871
|
-
readonly assignedJobs?: Array<RouterWorkerAssignmentOutput>;
|
|
1872
|
-
/** A value indicating the workers capacity. A value of '1' means all capacity is consumed. A value of '0' means no capacity is currently consumed. */
|
|
1873
|
-
readonly loadRatio?: number;
|
|
1874
|
-
/** A flag indicating this worker is open to receive offers or not. */
|
|
1875
|
-
availableForOffers?: boolean;
|
|
1876
|
-
/** If this is set, the worker will only receive up to this many new offers at a time. */
|
|
1877
|
-
maxConcurrentOffers?: number;
|
|
1878
|
-
}
|
|
1879
|
-
|
|
1880
|
-
/** The resource instance. */
|
|
1881
|
-
export declare type RouterWorkerResourceMergeAndPatch = Partial<RouterWorker>;
|
|
1882
|
-
|
|
1883
|
-
/** Describes a condition that must be met against a set of labels for worker selection. */
|
|
1884
|
-
export declare interface RouterWorkerSelector {
|
|
1885
|
-
/** The label key to query against. */
|
|
1886
|
-
key: string;
|
|
1887
|
-
/**
|
|
1888
|
-
* Describes how the value of the label is compared to the value defined on the worker selector.
|
|
1889
|
-
*
|
|
1890
|
-
* Possible values: "equal", "notEqual", "lessThan", "lessThanOrEqual", "greaterThan", "greaterThanOrEqual"
|
|
1891
|
-
*/
|
|
1892
|
-
labelOperator: string;
|
|
1893
|
-
/** The value to compare against the actual label value with the given operator. Values must be primitive values - number, string, boolean. */
|
|
1894
|
-
value?: unknown;
|
|
1895
|
-
/** Describes how long this label selector is valid in seconds. */
|
|
1896
|
-
expiresAfterSeconds?: number;
|
|
1897
|
-
/** Pushes a job to the front of the queue as long as this selector is active. */
|
|
1898
|
-
expedite?: boolean;
|
|
1899
|
-
}
|
|
1900
|
-
|
|
1901
|
-
/** Describes a condition that must be met against a set of labels for worker selection. */
|
|
1902
|
-
export declare interface RouterWorkerSelectorOutput {
|
|
1903
|
-
/** The label key to query against. */
|
|
1904
|
-
key: string;
|
|
1905
|
-
/**
|
|
1906
|
-
* Describes how the value of the label is compared to the value defined on the worker selector.
|
|
1907
|
-
*
|
|
1908
|
-
* Possible values: "equal", "notEqual", "lessThan", "lessThanOrEqual", "greaterThan", "greaterThanOrEqual"
|
|
1909
|
-
*/
|
|
1910
|
-
labelOperator: string;
|
|
1911
|
-
/** The value to compare against the actual label value with the given operator. Values must be primitive values - number, string, boolean. */
|
|
1912
|
-
value?: any;
|
|
1913
|
-
/** Describes how long this label selector is valid in seconds. */
|
|
1914
|
-
expiresAfterSeconds?: number;
|
|
1915
|
-
/** Pushes a job to the front of the queue as long as this selector is active. */
|
|
1916
|
-
expedite?: boolean;
|
|
1917
|
-
/**
|
|
1918
|
-
* Status of the worker selector.
|
|
1919
|
-
*
|
|
1920
|
-
* Possible values: "active", "expired"
|
|
1921
|
-
*/
|
|
1922
|
-
readonly status?: string;
|
|
1923
|
-
/** The time at which this worker selector expires in UTC. */
|
|
1924
|
-
readonly expiresAt?: string;
|
|
1925
|
-
}
|
|
1926
|
-
|
|
1927
|
-
export declare interface Routes {
|
|
1928
|
-
/** Resource for '/routing/classificationPolicies/\{classificationPolicyId\}' has methods for the following verbs: patch, get, delete */
|
|
1929
|
-
(path: "/routing/classificationPolicies/{classificationPolicyId}", classificationPolicyId: string): UpsertClassificationPolicy;
|
|
1930
|
-
/** Resource for '/routing/classificationPolicies' has methods for the following verbs: get */
|
|
1931
|
-
(path: "/routing/classificationPolicies"): ListClassificationPolicies;
|
|
1932
|
-
/** Resource for '/routing/distributionPolicies/\{distributionPolicyId\}' has methods for the following verbs: patch, get, delete */
|
|
1933
|
-
(path: "/routing/distributionPolicies/{distributionPolicyId}", distributionPolicyId: string): UpsertDistributionPolicy;
|
|
1934
|
-
/** Resource for '/routing/distributionPolicies' has methods for the following verbs: get */
|
|
1935
|
-
(path: "/routing/distributionPolicies"): ListDistributionPolicies;
|
|
1936
|
-
/** Resource for '/routing/exceptionPolicies/\{exceptionPolicyId\}' has methods for the following verbs: patch, get, delete */
|
|
1937
|
-
(path: "/routing/exceptionPolicies/{exceptionPolicyId}", exceptionPolicyId: string): UpsertExceptionPolicy;
|
|
1938
|
-
/** Resource for '/routing/exceptionPolicies' has methods for the following verbs: get */
|
|
1939
|
-
(path: "/routing/exceptionPolicies"): ListExceptionPolicies;
|
|
1940
|
-
/** Resource for '/routing/queues/\{queueId\}' has methods for the following verbs: patch, get, delete */
|
|
1941
|
-
(path: "/routing/queues/{queueId}", queueId: string): UpsertQueue;
|
|
1942
|
-
/** Resource for '/routing/queues' has methods for the following verbs: get */
|
|
1943
|
-
(path: "/routing/queues"): ListQueues;
|
|
1944
|
-
/** Resource for '/routing/jobs/\{jobId\}' has methods for the following verbs: patch, get, delete */
|
|
1945
|
-
(path: "/routing/jobs/{jobId}", jobId: string): UpsertJob;
|
|
1946
|
-
/** Resource for '/routing/jobs/\{jobId\}:reclassify' has methods for the following verbs: post */
|
|
1947
|
-
(path: "/routing/jobs/{jobId}:reclassify", jobId: string): Reclassify;
|
|
1948
|
-
/** Resource for '/routing/jobs/\{jobId\}:cancel' has methods for the following verbs: post */
|
|
1949
|
-
(path: "/routing/jobs/{jobId}:cancel", jobId: string): Cancel;
|
|
1950
|
-
/** Resource for '/routing/jobs/\{jobId\}/assignments/\{assignmentId\}:complete' has methods for the following verbs: post */
|
|
1951
|
-
(path: "/routing/jobs/{jobId}/assignments/{assignmentId}:complete", jobId: string, assignmentId: string): Complete;
|
|
1952
|
-
/** Resource for '/routing/jobs/\{jobId\}/assignments/\{assignmentId\}:close' has methods for the following verbs: post */
|
|
1953
|
-
(path: "/routing/jobs/{jobId}/assignments/{assignmentId}:close", jobId: string, assignmentId: string): Close;
|
|
1954
|
-
/** Resource for '/routing/jobs' has methods for the following verbs: get */
|
|
1955
|
-
(path: "/routing/jobs"): ListJobs;
|
|
1956
|
-
/** Resource for '/routing/jobs/\{jobId\}/position' has methods for the following verbs: get */
|
|
1957
|
-
(path: "/routing/jobs/{jobId}/position", jobId: string): GetInQueuePosition;
|
|
1958
|
-
/** Resource for '/routing/jobs/\{jobId\}/assignments/\{assignmentId\}:unassign' has methods for the following verbs: post */
|
|
1959
|
-
(path: "/routing/jobs/{jobId}/assignments/{assignmentId}:unassign", jobId: string, assignmentId: string): Unassign;
|
|
1960
|
-
/** Resource for '/routing/workers/\{workerId\}/offers/\{offerId\}:accept' has methods for the following verbs: post */
|
|
1961
|
-
(path: "/routing/workers/{workerId}/offers/{offerId}:accept", workerId: string, offerId: string): Accept;
|
|
1962
|
-
/** Resource for '/routing/workers/\{workerId\}/offers/\{offerId\}:decline' has methods for the following verbs: post */
|
|
1963
|
-
(path: "/routing/workers/{workerId}/offers/{offerId}:decline", workerId: string, offerId: string): Decline;
|
|
1964
|
-
/** Resource for '/routing/queues/\{queueId\}/statistics' has methods for the following verbs: get */
|
|
1965
|
-
(path: "/routing/queues/{queueId}/statistics", queueId: string): GetQueueStatistics;
|
|
1966
|
-
/** Resource for '/routing/workers/\{workerId\}' has methods for the following verbs: patch, get, delete */
|
|
1967
|
-
(path: "/routing/workers/{workerId}", workerId: string): UpsertWorker;
|
|
1968
|
-
/** Resource for '/routing/workers' has methods for the following verbs: get */
|
|
1969
|
-
(path: "/routing/workers"): ListWorkers;
|
|
1970
|
-
}
|
|
1971
|
-
|
|
1972
|
-
/** Attaches queue selectors to a job when the RouterRule is resolved. */
|
|
1973
|
-
export declare interface RuleEngineQueueSelectorAttachment extends QueueSelectorAttachmentParent {
|
|
1974
|
-
/** A RouterRule that resolves a collection of queue selectors to attach. */
|
|
1975
|
-
rule: RouterRule;
|
|
1976
|
-
/** The type discriminator describing the type of queue selector attachment. */
|
|
1977
|
-
kind: "ruleEngine";
|
|
1978
|
-
}
|
|
1979
|
-
|
|
1980
|
-
/** Attaches queue selectors to a job when the RouterRule is resolved. */
|
|
1981
|
-
export declare interface RuleEngineQueueSelectorAttachmentOutput extends QueueSelectorAttachmentOutputParent {
|
|
1982
|
-
/** A RouterRule that resolves a collection of queue selectors to attach. */
|
|
1983
|
-
rule: RouterRuleOutput;
|
|
1984
|
-
/** The type discriminator describing the type of queue selector attachment. */
|
|
1985
|
-
kind: "ruleEngine";
|
|
1986
|
-
}
|
|
1987
|
-
|
|
1988
|
-
/** Attaches worker selectors to a job when a RouterRule is resolved. */
|
|
1989
|
-
export declare interface RuleEngineWorkerSelectorAttachment extends WorkerSelectorAttachmentParent {
|
|
1990
|
-
/** A RouterRule that resolves a collection of worker selectors to attach. */
|
|
1991
|
-
rule: RouterRule;
|
|
1992
|
-
/** The type discriminator describing the type of worker selector attachment. */
|
|
1993
|
-
kind: "ruleEngine";
|
|
1994
|
-
}
|
|
1995
|
-
|
|
1996
|
-
/** Attaches worker selectors to a job when a RouterRule is resolved. */
|
|
1997
|
-
export declare interface RuleEngineWorkerSelectorAttachmentOutput extends WorkerSelectorAttachmentOutputParent {
|
|
1998
|
-
/** A RouterRule that resolves a collection of worker selectors to attach. */
|
|
1999
|
-
rule: RouterRuleOutput;
|
|
2000
|
-
/** The type discriminator describing the type of worker selector attachment. */
|
|
2001
|
-
kind: "ruleEngine";
|
|
2002
|
-
}
|
|
2003
|
-
|
|
2004
|
-
/** 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. */
|
|
2005
|
-
export declare interface ScheduleAndSuspendMode extends JobMatchingModeParent {
|
|
2006
|
-
/** Requested schedule time. */
|
|
2007
|
-
scheduleAt: Date | string;
|
|
2008
|
-
/** The type discriminator describing ScheduleAndSuspendMode */
|
|
2009
|
-
kind: "scheduleAndSuspend";
|
|
2010
|
-
}
|
|
2011
|
-
|
|
2012
|
-
/** 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. */
|
|
2013
|
-
export declare interface ScheduleAndSuspendModeOutput extends JobMatchingModeOutputParent {
|
|
2014
|
-
/** Requested schedule time. */
|
|
2015
|
-
scheduleAt: string;
|
|
2016
|
-
/** The type discriminator describing ScheduleAndSuspendMode */
|
|
2017
|
-
kind: "scheduleAndSuspend";
|
|
2018
|
-
}
|
|
2019
|
-
|
|
2020
|
-
/** Encapsulates all options that can be passed as parameters for scoring rule with BestWorkerMode. */
|
|
2021
|
-
export declare interface ScoringRuleOptions {
|
|
2022
|
-
/** Set batch size when 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. */
|
|
2023
|
-
batchSize?: number;
|
|
2024
|
-
/** List of extra parameters from a job that will be sent as part of the payload to scoring rule. If not set, a job's labels (sent in the payload as `job`) and a job's worker selectors (sent in the payload as `selectors`) are added to the payload of the scoring rule by default. Note: Worker labels are always sent with scoring payload. */
|
|
2025
|
-
scoringParameters?: string[];
|
|
2026
|
-
/** If set to true, will score workers in batches, and the parameter name of the worker labels will be sent as `workers`. By default, set to false and the parameter name for the worker labels will be sent as `worker`. Note: If enabled, use 'batchSize' to set batch size. */
|
|
2027
|
-
isBatchScoringEnabled?: boolean;
|
|
2028
|
-
/** If false, will sort scores by ascending order. By default, set to true. */
|
|
2029
|
-
descendingOrder?: boolean;
|
|
2030
|
-
}
|
|
2031
|
-
|
|
2032
|
-
/** Encapsulates all options that can be passed as parameters for scoring rule with BestWorkerMode. */
|
|
2033
|
-
export declare interface ScoringRuleOptionsOutput {
|
|
2034
|
-
/** Set batch size when 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. */
|
|
2035
|
-
batchSize?: number;
|
|
2036
|
-
/** List of extra parameters from a job that will be sent as part of the payload to scoring rule. If not set, a job's labels (sent in the payload as `job`) and a job's worker selectors (sent in the payload as `selectors`) are added to the payload of the scoring rule by default. Note: Worker labels are always sent with scoring payload. */
|
|
2037
|
-
scoringParameters?: string[];
|
|
2038
|
-
/** If set to true, will score workers in batches, and the parameter name of the worker labels will be sent as `workers`. By default, set to false and the parameter name for the worker labels will be sent as `worker`. Note: If enabled, use 'batchSize' to set batch size. */
|
|
2039
|
-
isBatchScoringEnabled?: boolean;
|
|
2040
|
-
/** If false, will sort scores by ascending order. By default, set to true. */
|
|
2041
|
-
descendingOrder?: boolean;
|
|
2042
|
-
}
|
|
2043
|
-
|
|
2044
|
-
/** Describes a queue selector that will be attached to a job. */
|
|
2045
|
-
export declare interface StaticQueueSelectorAttachment extends QueueSelectorAttachmentParent {
|
|
2046
|
-
/** The queue selector to attach. */
|
|
2047
|
-
queueSelector: RouterQueueSelector;
|
|
2048
|
-
/** The type discriminator describing the type of queue selector attachment. */
|
|
2049
|
-
kind: "static";
|
|
2050
|
-
}
|
|
2051
|
-
|
|
2052
|
-
/** Describes a queue selector that will be attached to a job. */
|
|
2053
|
-
export declare interface StaticQueueSelectorAttachmentOutput extends QueueSelectorAttachmentOutputParent {
|
|
2054
|
-
/** The queue selector to attach. */
|
|
2055
|
-
queueSelector: RouterQueueSelectorOutput;
|
|
2056
|
-
/** The type discriminator describing the type of queue selector attachment. */
|
|
2057
|
-
kind: "static";
|
|
2058
|
-
}
|
|
2059
|
-
|
|
2060
|
-
/** A rule providing static rules that always return the same result, regardless of input. */
|
|
2061
|
-
export declare interface StaticRouterRule extends RouterRuleParent {
|
|
2062
|
-
/** The static value this rule always returns. Values must be primitive values - number, string, boolean. */
|
|
2063
|
-
value?: unknown;
|
|
2064
|
-
/** The type discriminator describing a sub-type of Rule. */
|
|
2065
|
-
kind: "static";
|
|
2066
|
-
}
|
|
2067
|
-
|
|
2068
|
-
/** A rule providing static rules that always return the same result, regardless of input. */
|
|
2069
|
-
export declare interface StaticRouterRuleOutput extends RouterRuleOutputParent {
|
|
2070
|
-
/** The static value this rule always returns. Values must be primitive values - number, string, boolean. */
|
|
2071
|
-
value?: any;
|
|
2072
|
-
/** The type discriminator describing a sub-type of Rule. */
|
|
2073
|
-
kind: "static";
|
|
2074
|
-
}
|
|
2075
|
-
|
|
2076
|
-
/** Describes a worker selector that will be attached to a job. */
|
|
2077
|
-
export declare interface StaticWorkerSelectorAttachment extends WorkerSelectorAttachmentParent {
|
|
2078
|
-
/** The worker selector to attach. */
|
|
2079
|
-
workerSelector: RouterWorkerSelector;
|
|
2080
|
-
/** The type discriminator describing the type of worker selector attachment. */
|
|
2081
|
-
kind: "static";
|
|
2082
|
-
}
|
|
2083
|
-
|
|
2084
|
-
/** Describes a worker selector that will be attached to a job. */
|
|
2085
|
-
export declare interface StaticWorkerSelectorAttachmentOutput extends WorkerSelectorAttachmentOutputParent {
|
|
2086
|
-
/** The worker selector to attach. */
|
|
2087
|
-
workerSelector: RouterWorkerSelectorOutput;
|
|
2088
|
-
/** The type discriminator describing the type of worker selector attachment. */
|
|
2089
|
-
kind: "static";
|
|
2090
|
-
}
|
|
2091
|
-
|
|
2092
|
-
/** Describes a matching mode where matching worker to a job is suspended. */
|
|
2093
|
-
export declare interface SuspendMode extends JobMatchingModeParent {
|
|
2094
|
-
/** The type discriminator describing SuspendMode */
|
|
2095
|
-
kind: "suspend";
|
|
2096
|
-
}
|
|
2097
|
-
|
|
2098
|
-
/** Describes a matching mode where matching worker to a job is suspended. */
|
|
2099
|
-
export declare interface SuspendModeOutput extends JobMatchingModeOutputParent {
|
|
2100
|
-
/** The type discriminator describing SuspendMode */
|
|
2101
|
-
kind: "suspend";
|
|
2102
|
-
}
|
|
2103
|
-
|
|
2104
|
-
export declare interface Unassign {
|
|
2105
|
-
/** Unassign a job. */
|
|
2106
|
-
post(options?: UnassignParameters): StreamableMethod<Unassign200Response | UnassignDefaultResponse>;
|
|
2107
|
-
}
|
|
2108
|
-
|
|
2109
|
-
/** The request has succeeded. */
|
|
2110
|
-
export declare interface Unassign200Response extends HttpResponse {
|
|
2111
|
-
status: "200";
|
|
2112
|
-
body: UnassignJobResultOutput;
|
|
2113
|
-
}
|
|
2114
|
-
|
|
2115
|
-
export declare interface UnassignBodyParam {
|
|
2116
|
-
/** Request body for unassign route. */
|
|
2117
|
-
body?: UnassignJobOptions;
|
|
2118
|
-
}
|
|
2119
|
-
|
|
2120
|
-
export declare interface UnassignDefaultHeaders {
|
|
2121
|
-
/** String error code indicating what went wrong. */
|
|
2122
|
-
"x-ms-error-code"?: string;
|
|
2123
|
-
}
|
|
2124
|
-
|
|
2125
|
-
export declare interface UnassignDefaultResponse extends HttpResponse {
|
|
2126
|
-
status: string;
|
|
2127
|
-
body: ErrorResponse;
|
|
2128
|
-
headers: RawHttpHeaders & UnassignDefaultHeaders;
|
|
2129
|
-
}
|
|
2130
|
-
|
|
2131
|
-
/** Request payload for unassigning a job. */
|
|
2132
|
-
export declare interface UnassignJobOptions {
|
|
2133
|
-
/** If SuspendMatching is true, then a job is not queued for re-matching with a worker. */
|
|
2134
|
-
suspendMatching?: boolean;
|
|
2135
|
-
}
|
|
2136
|
-
|
|
2137
|
-
/** Response payload after a job has been successfully unassigned. */
|
|
2138
|
-
export declare interface UnassignJobResultOutput {
|
|
2139
|
-
/** Id of an unassigned job. */
|
|
2140
|
-
jobId: string;
|
|
2141
|
-
/** The number of times a job is unassigned. At a maximum 3. */
|
|
2142
|
-
unassignmentCount: number;
|
|
2143
|
-
}
|
|
2144
|
-
|
|
2145
|
-
export declare type UnassignParameters = UnassignBodyParam & RequestParameters;
|
|
2146
|
-
|
|
2147
|
-
export declare interface UpsertClassificationPolicy {
|
|
2148
|
-
/** Creates or updates a classification policy. */
|
|
2149
|
-
patch(options: UpsertClassificationPolicyParameters): StreamableMethod<UpsertClassificationPolicy200Response | UpsertClassificationPolicy201Response | UpsertClassificationPolicyDefaultResponse>;
|
|
2150
|
-
/** Retrieves an existing classification policy by Id. */
|
|
2151
|
-
get(options?: GetClassificationPolicyParameters): StreamableMethod<GetClassificationPolicy200Response | GetClassificationPolicyDefaultResponse>;
|
|
2152
|
-
/** Delete a classification policy by Id. */
|
|
2153
|
-
delete(options?: DeleteClassificationPolicyParameters): StreamableMethod<DeleteClassificationPolicy204Response | DeleteClassificationPolicyDefaultResponse>;
|
|
2154
|
-
}
|
|
2155
|
-
|
|
2156
|
-
export declare interface UpsertClassificationPolicy200Headers {
|
|
2157
|
-
/** The entity tag for the response. */
|
|
2158
|
-
etag?: string;
|
|
2159
|
-
/** The last modified timestamp. */
|
|
2160
|
-
"last-modified"?: string;
|
|
2161
|
-
}
|
|
2162
|
-
|
|
2163
|
-
/** The request has succeeded. */
|
|
2164
|
-
export declare interface UpsertClassificationPolicy200Response extends HttpResponse {
|
|
2165
|
-
status: "200";
|
|
2166
|
-
body: ClassificationPolicyOutput;
|
|
2167
|
-
headers: RawHttpHeaders & UpsertClassificationPolicy200Headers;
|
|
2168
|
-
}
|
|
2169
|
-
|
|
2170
|
-
export declare interface UpsertClassificationPolicy201Headers {
|
|
2171
|
-
/** The entity tag for the response. */
|
|
2172
|
-
etag?: string;
|
|
2173
|
-
/** The last modified timestamp. */
|
|
2174
|
-
"last-modified"?: string;
|
|
2175
|
-
}
|
|
2176
|
-
|
|
2177
|
-
/** The request has succeeded and a new resource has been created as a result. */
|
|
2178
|
-
export declare interface UpsertClassificationPolicy201Response extends HttpResponse {
|
|
2179
|
-
status: "201";
|
|
2180
|
-
body: ClassificationPolicyOutput;
|
|
2181
|
-
headers: RawHttpHeaders & UpsertClassificationPolicy201Headers;
|
|
2182
|
-
}
|
|
2183
|
-
|
|
2184
|
-
export declare interface UpsertClassificationPolicyBodyParam {
|
|
2185
|
-
/** The resource instance. */
|
|
2186
|
-
body: ClassificationPolicyResourceMergeAndPatch;
|
|
2187
|
-
}
|
|
2188
|
-
|
|
2189
|
-
export declare interface UpsertClassificationPolicyDefaultHeaders {
|
|
2190
|
-
/** String error code indicating what went wrong. */
|
|
2191
|
-
"x-ms-error-code"?: string;
|
|
2192
|
-
}
|
|
2193
|
-
|
|
2194
|
-
export declare interface UpsertClassificationPolicyDefaultResponse extends HttpResponse {
|
|
2195
|
-
status: string;
|
|
2196
|
-
body: ErrorResponse;
|
|
2197
|
-
headers: RawHttpHeaders & UpsertClassificationPolicyDefaultHeaders;
|
|
2198
|
-
}
|
|
2199
|
-
|
|
2200
|
-
export declare interface UpsertClassificationPolicyHeaderParam {
|
|
2201
|
-
headers?: RawHttpHeadersInput & UpsertClassificationPolicyHeaders;
|
|
2202
|
-
}
|
|
2203
|
-
|
|
2204
|
-
export declare interface UpsertClassificationPolicyHeaders {
|
|
2205
|
-
/** The request should only proceed if an entity matches this string. */
|
|
2206
|
-
"If-Match"?: string;
|
|
2207
|
-
/** The request should only proceed if the entity was not modified after this time. */
|
|
2208
|
-
"If-Unmodified-Since"?: string;
|
|
2209
|
-
}
|
|
2210
|
-
|
|
2211
|
-
export declare interface UpsertClassificationPolicyMediaTypesParam {
|
|
2212
|
-
/** This request has a JSON Merge Patch body. */
|
|
2213
|
-
contentType: "application/merge-patch+json";
|
|
2214
|
-
}
|
|
2215
|
-
|
|
2216
|
-
export declare type UpsertClassificationPolicyParameters = UpsertClassificationPolicyHeaderParam & UpsertClassificationPolicyMediaTypesParam & UpsertClassificationPolicyBodyParam & RequestParameters;
|
|
2217
|
-
|
|
2218
|
-
export declare interface UpsertDistributionPolicy {
|
|
2219
|
-
/** Creates or updates a distribution policy. */
|
|
2220
|
-
patch(options: UpsertDistributionPolicyParameters): StreamableMethod<UpsertDistributionPolicy200Response | UpsertDistributionPolicy201Response | UpsertDistributionPolicyDefaultResponse>;
|
|
2221
|
-
/** Retrieves an existing distribution policy by Id. */
|
|
2222
|
-
get(options?: GetDistributionPolicyParameters): StreamableMethod<GetDistributionPolicy200Response | GetDistributionPolicyDefaultResponse>;
|
|
2223
|
-
/** Delete a distribution policy by Id. */
|
|
2224
|
-
delete(options?: DeleteDistributionPolicyParameters): StreamableMethod<DeleteDistributionPolicy204Response | DeleteDistributionPolicyDefaultResponse>;
|
|
2225
|
-
}
|
|
2226
|
-
|
|
2227
|
-
export declare interface UpsertDistributionPolicy200Headers {
|
|
2228
|
-
/** The entity tag for the response. */
|
|
2229
|
-
etag?: string;
|
|
2230
|
-
/** The last modified timestamp. */
|
|
2231
|
-
"last-modified"?: string;
|
|
2232
|
-
}
|
|
2233
|
-
|
|
2234
|
-
/** The request has succeeded. */
|
|
2235
|
-
export declare interface UpsertDistributionPolicy200Response extends HttpResponse {
|
|
2236
|
-
status: "200";
|
|
2237
|
-
body: DistributionPolicyOutput;
|
|
2238
|
-
headers: RawHttpHeaders & UpsertDistributionPolicy200Headers;
|
|
2239
|
-
}
|
|
2240
|
-
|
|
2241
|
-
export declare interface UpsertDistributionPolicy201Headers {
|
|
2242
|
-
/** The entity tag for the response. */
|
|
2243
|
-
etag?: string;
|
|
2244
|
-
/** The last modified timestamp. */
|
|
2245
|
-
"last-modified"?: string;
|
|
2246
|
-
}
|
|
2247
|
-
|
|
2248
|
-
/** The request has succeeded and a new resource has been created as a result. */
|
|
2249
|
-
export declare interface UpsertDistributionPolicy201Response extends HttpResponse {
|
|
2250
|
-
status: "201";
|
|
2251
|
-
body: DistributionPolicyOutput;
|
|
2252
|
-
headers: RawHttpHeaders & UpsertDistributionPolicy201Headers;
|
|
2253
|
-
}
|
|
2254
|
-
|
|
2255
|
-
export declare interface UpsertDistributionPolicyBodyParam {
|
|
2256
|
-
/** The resource instance. */
|
|
2257
|
-
body: DistributionPolicyResourceMergeAndPatch;
|
|
2258
|
-
}
|
|
2259
|
-
|
|
2260
|
-
export declare interface UpsertDistributionPolicyDefaultHeaders {
|
|
2261
|
-
/** String error code indicating what went wrong. */
|
|
2262
|
-
"x-ms-error-code"?: string;
|
|
2263
|
-
}
|
|
2264
|
-
|
|
2265
|
-
export declare interface UpsertDistributionPolicyDefaultResponse extends HttpResponse {
|
|
2266
|
-
status: string;
|
|
2267
|
-
body: ErrorResponse;
|
|
2268
|
-
headers: RawHttpHeaders & UpsertDistributionPolicyDefaultHeaders;
|
|
2269
|
-
}
|
|
2270
|
-
|
|
2271
|
-
export declare interface UpsertDistributionPolicyHeaderParam {
|
|
2272
|
-
headers?: RawHttpHeadersInput & UpsertDistributionPolicyHeaders;
|
|
2273
|
-
}
|
|
2274
|
-
|
|
2275
|
-
export declare interface UpsertDistributionPolicyHeaders {
|
|
2276
|
-
/** The request should only proceed if an entity matches this string. */
|
|
2277
|
-
"If-Match"?: string;
|
|
2278
|
-
/** The request should only proceed if the entity was not modified after this time. */
|
|
2279
|
-
"If-Unmodified-Since"?: string;
|
|
2280
|
-
}
|
|
2281
|
-
|
|
2282
|
-
export declare interface UpsertDistributionPolicyMediaTypesParam {
|
|
2283
|
-
/** This request has a JSON Merge Patch body. */
|
|
2284
|
-
contentType: "application/merge-patch+json";
|
|
2285
|
-
}
|
|
2286
|
-
|
|
2287
|
-
export declare type UpsertDistributionPolicyParameters = UpsertDistributionPolicyHeaderParam & UpsertDistributionPolicyMediaTypesParam & UpsertDistributionPolicyBodyParam & RequestParameters;
|
|
2288
|
-
|
|
2289
|
-
export declare interface UpsertExceptionPolicy {
|
|
2290
|
-
/** Creates or updates a exception policy. */
|
|
2291
|
-
patch(options: UpsertExceptionPolicyParameters): StreamableMethod<UpsertExceptionPolicy200Response | UpsertExceptionPolicy201Response | UpsertExceptionPolicyDefaultResponse>;
|
|
2292
|
-
/** Retrieves an existing exception policy by Id. */
|
|
2293
|
-
get(options?: GetExceptionPolicyParameters): StreamableMethod<GetExceptionPolicy200Response | GetExceptionPolicyDefaultResponse>;
|
|
2294
|
-
/** Deletes a exception policy by Id. */
|
|
2295
|
-
delete(options?: DeleteExceptionPolicyParameters): StreamableMethod<DeleteExceptionPolicy204Response | DeleteExceptionPolicyDefaultResponse>;
|
|
2296
|
-
}
|
|
2297
|
-
|
|
2298
|
-
export declare interface UpsertExceptionPolicy200Headers {
|
|
2299
|
-
/** The entity tag for the response. */
|
|
2300
|
-
etag?: string;
|
|
2301
|
-
/** The last modified timestamp. */
|
|
2302
|
-
"last-modified"?: string;
|
|
2303
|
-
}
|
|
2304
|
-
|
|
2305
|
-
/** The request has succeeded. */
|
|
2306
|
-
export declare interface UpsertExceptionPolicy200Response extends HttpResponse {
|
|
2307
|
-
status: "200";
|
|
2308
|
-
body: ExceptionPolicyOutput;
|
|
2309
|
-
headers: RawHttpHeaders & UpsertExceptionPolicy200Headers;
|
|
2310
|
-
}
|
|
2311
|
-
|
|
2312
|
-
export declare interface UpsertExceptionPolicy201Headers {
|
|
2313
|
-
/** The entity tag for the response. */
|
|
2314
|
-
etag?: string;
|
|
2315
|
-
/** The last modified timestamp. */
|
|
2316
|
-
"last-modified"?: string;
|
|
2317
|
-
}
|
|
2318
|
-
|
|
2319
|
-
/** The request has succeeded and a new resource has been created as a result. */
|
|
2320
|
-
export declare interface UpsertExceptionPolicy201Response extends HttpResponse {
|
|
2321
|
-
status: "201";
|
|
2322
|
-
body: ExceptionPolicyOutput;
|
|
2323
|
-
headers: RawHttpHeaders & UpsertExceptionPolicy201Headers;
|
|
2324
|
-
}
|
|
2325
|
-
|
|
2326
|
-
export declare interface UpsertExceptionPolicyBodyParam {
|
|
2327
|
-
/** The resource instance. */
|
|
2328
|
-
body: ExceptionPolicyResourceMergeAndPatch;
|
|
2329
|
-
}
|
|
2330
|
-
|
|
2331
|
-
export declare interface UpsertExceptionPolicyDefaultHeaders {
|
|
2332
|
-
/** String error code indicating what went wrong. */
|
|
2333
|
-
"x-ms-error-code"?: string;
|
|
2334
|
-
}
|
|
2335
|
-
|
|
2336
|
-
export declare interface UpsertExceptionPolicyDefaultResponse extends HttpResponse {
|
|
2337
|
-
status: string;
|
|
2338
|
-
body: ErrorResponse;
|
|
2339
|
-
headers: RawHttpHeaders & UpsertExceptionPolicyDefaultHeaders;
|
|
2340
|
-
}
|
|
2341
|
-
|
|
2342
|
-
export declare interface UpsertExceptionPolicyHeaderParam {
|
|
2343
|
-
headers?: RawHttpHeadersInput & UpsertExceptionPolicyHeaders;
|
|
2344
|
-
}
|
|
2345
|
-
|
|
2346
|
-
export declare interface UpsertExceptionPolicyHeaders {
|
|
2347
|
-
/** The request should only proceed if an entity matches this string. */
|
|
2348
|
-
"If-Match"?: string;
|
|
2349
|
-
/** The request should only proceed if the entity was not modified after this time. */
|
|
2350
|
-
"If-Unmodified-Since"?: string;
|
|
2351
|
-
}
|
|
2352
|
-
|
|
2353
|
-
export declare interface UpsertExceptionPolicyMediaTypesParam {
|
|
2354
|
-
/** This request has a JSON Merge Patch body. */
|
|
2355
|
-
contentType: "application/merge-patch+json";
|
|
2356
|
-
}
|
|
2357
|
-
|
|
2358
|
-
export declare type UpsertExceptionPolicyParameters = UpsertExceptionPolicyHeaderParam & UpsertExceptionPolicyMediaTypesParam & UpsertExceptionPolicyBodyParam & RequestParameters;
|
|
2359
|
-
|
|
2360
|
-
export declare interface UpsertJob {
|
|
2361
|
-
/** Creates or updates a router job. */
|
|
2362
|
-
patch(options: UpsertJobParameters): StreamableMethod<UpsertJob200Response | UpsertJob201Response | UpsertJobDefaultResponse>;
|
|
2363
|
-
/** Retrieves an existing job by Id. */
|
|
2364
|
-
get(options?: GetJobParameters): StreamableMethod<GetJob200Response | GetJobDefaultResponse>;
|
|
2365
|
-
/** Deletes a job and all of its traces. */
|
|
2366
|
-
delete(options?: DeleteJobParameters): StreamableMethod<DeleteJob204Response | DeleteJobDefaultResponse>;
|
|
2367
|
-
}
|
|
2368
|
-
|
|
2369
|
-
export declare interface UpsertJob200Headers {
|
|
2370
|
-
/** The entity tag for the response. */
|
|
2371
|
-
etag?: string;
|
|
2372
|
-
/** The last modified timestamp. */
|
|
2373
|
-
"last-modified"?: string;
|
|
2374
|
-
}
|
|
2375
|
-
|
|
2376
|
-
/** The request has succeeded. */
|
|
2377
|
-
export declare interface UpsertJob200Response extends HttpResponse {
|
|
2378
|
-
status: "200";
|
|
2379
|
-
body: RouterJobOutput;
|
|
2380
|
-
headers: RawHttpHeaders & UpsertJob200Headers;
|
|
2381
|
-
}
|
|
2382
|
-
|
|
2383
|
-
export declare interface UpsertJob201Headers {
|
|
2384
|
-
/** The entity tag for the response. */
|
|
2385
|
-
etag?: string;
|
|
2386
|
-
/** The last modified timestamp. */
|
|
2387
|
-
"last-modified"?: string;
|
|
2388
|
-
}
|
|
2389
|
-
|
|
2390
|
-
/** The request has succeeded and a new resource has been created as a result. */
|
|
2391
|
-
export declare interface UpsertJob201Response extends HttpResponse {
|
|
2392
|
-
status: "201";
|
|
2393
|
-
body: RouterJobOutput;
|
|
2394
|
-
headers: RawHttpHeaders & UpsertJob201Headers;
|
|
2395
|
-
}
|
|
2396
|
-
|
|
2397
|
-
export declare interface UpsertJobBodyParam {
|
|
2398
|
-
/** The resource instance. */
|
|
2399
|
-
body: RouterJobResourceMergeAndPatch;
|
|
2400
|
-
}
|
|
2401
|
-
|
|
2402
|
-
export declare interface UpsertJobDefaultHeaders {
|
|
2403
|
-
/** String error code indicating what went wrong. */
|
|
2404
|
-
"x-ms-error-code"?: string;
|
|
2405
|
-
}
|
|
2406
|
-
|
|
2407
|
-
export declare interface UpsertJobDefaultResponse extends HttpResponse {
|
|
2408
|
-
status: string;
|
|
2409
|
-
body: ErrorResponse;
|
|
2410
|
-
headers: RawHttpHeaders & UpsertJobDefaultHeaders;
|
|
2411
|
-
}
|
|
2412
|
-
|
|
2413
|
-
export declare interface UpsertJobHeaderParam {
|
|
2414
|
-
headers?: RawHttpHeadersInput & UpsertJobHeaders;
|
|
2415
|
-
}
|
|
2416
|
-
|
|
2417
|
-
export declare interface UpsertJobHeaders {
|
|
2418
|
-
/** The request should only proceed if an entity matches this string. */
|
|
2419
|
-
"If-Match"?: string;
|
|
2420
|
-
/** The request should only proceed if the entity was not modified after this time. */
|
|
2421
|
-
"If-Unmodified-Since"?: string;
|
|
2422
|
-
}
|
|
2423
|
-
|
|
2424
|
-
export declare interface UpsertJobMediaTypesParam {
|
|
2425
|
-
/** This request has a JSON Merge Patch body. */
|
|
2426
|
-
contentType: "application/merge-patch+json";
|
|
2427
|
-
}
|
|
2428
|
-
|
|
2429
|
-
export declare type UpsertJobParameters = UpsertJobHeaderParam & UpsertJobMediaTypesParam & UpsertJobBodyParam & RequestParameters;
|
|
2430
|
-
|
|
2431
|
-
export declare interface UpsertQueue {
|
|
2432
|
-
/** Creates or updates a queue. */
|
|
2433
|
-
patch(options: UpsertQueueParameters): StreamableMethod<UpsertQueue200Response | UpsertQueue201Response | UpsertQueueDefaultResponse>;
|
|
2434
|
-
/** Retrieves an existing queue by Id. */
|
|
2435
|
-
get(options?: GetQueueParameters): StreamableMethod<GetQueue200Response | GetQueueDefaultResponse>;
|
|
2436
|
-
/** Deletes a queue by Id. */
|
|
2437
|
-
delete(options?: DeleteQueueParameters): StreamableMethod<DeleteQueue204Response | DeleteQueueDefaultResponse>;
|
|
2438
|
-
}
|
|
2439
|
-
|
|
2440
|
-
export declare interface UpsertQueue200Headers {
|
|
2441
|
-
/** The entity tag for the response. */
|
|
2442
|
-
etag?: string;
|
|
2443
|
-
/** The last modified timestamp. */
|
|
2444
|
-
"last-modified"?: string;
|
|
2445
|
-
}
|
|
2446
|
-
|
|
2447
|
-
/** The request has succeeded. */
|
|
2448
|
-
export declare interface UpsertQueue200Response extends HttpResponse {
|
|
2449
|
-
status: "200";
|
|
2450
|
-
body: RouterQueueOutput;
|
|
2451
|
-
headers: RawHttpHeaders & UpsertQueue200Headers;
|
|
2452
|
-
}
|
|
2453
|
-
|
|
2454
|
-
export declare interface UpsertQueue201Headers {
|
|
2455
|
-
/** The entity tag for the response. */
|
|
2456
|
-
etag?: string;
|
|
2457
|
-
/** The last modified timestamp. */
|
|
2458
|
-
"last-modified"?: string;
|
|
2459
|
-
}
|
|
2460
|
-
|
|
2461
|
-
/** The request has succeeded and a new resource has been created as a result. */
|
|
2462
|
-
export declare interface UpsertQueue201Response extends HttpResponse {
|
|
2463
|
-
status: "201";
|
|
2464
|
-
body: RouterQueueOutput;
|
|
2465
|
-
headers: RawHttpHeaders & UpsertQueue201Headers;
|
|
2466
|
-
}
|
|
2467
|
-
|
|
2468
|
-
export declare interface UpsertQueueBodyParam {
|
|
2469
|
-
/** The resource instance. */
|
|
2470
|
-
body: RouterQueueResourceMergeAndPatch;
|
|
2471
|
-
}
|
|
2472
|
-
|
|
2473
|
-
export declare interface UpsertQueueDefaultHeaders {
|
|
2474
|
-
/** String error code indicating what went wrong. */
|
|
2475
|
-
"x-ms-error-code"?: string;
|
|
2476
|
-
}
|
|
2477
|
-
|
|
2478
|
-
export declare interface UpsertQueueDefaultResponse extends HttpResponse {
|
|
2479
|
-
status: string;
|
|
2480
|
-
body: ErrorResponse;
|
|
2481
|
-
headers: RawHttpHeaders & UpsertQueueDefaultHeaders;
|
|
2482
|
-
}
|
|
2483
|
-
|
|
2484
|
-
export declare interface UpsertQueueHeaderParam {
|
|
2485
|
-
headers?: RawHttpHeadersInput & UpsertQueueHeaders;
|
|
2486
|
-
}
|
|
2487
|
-
|
|
2488
|
-
export declare interface UpsertQueueHeaders {
|
|
2489
|
-
/** The request should only proceed if an entity matches this string. */
|
|
2490
|
-
"If-Match"?: string;
|
|
2491
|
-
/** The request should only proceed if the entity was not modified after this time. */
|
|
2492
|
-
"If-Unmodified-Since"?: string;
|
|
2493
|
-
}
|
|
2494
|
-
|
|
2495
|
-
export declare interface UpsertQueueMediaTypesParam {
|
|
2496
|
-
/** This request has a JSON Merge Patch body. */
|
|
2497
|
-
contentType: "application/merge-patch+json";
|
|
2498
|
-
}
|
|
2499
|
-
|
|
2500
|
-
export declare type UpsertQueueParameters = UpsertQueueHeaderParam & UpsertQueueMediaTypesParam & UpsertQueueBodyParam & RequestParameters;
|
|
2501
|
-
|
|
2502
|
-
export declare interface UpsertWorker {
|
|
2503
|
-
/** Creates or updates a worker. */
|
|
2504
|
-
patch(options: UpsertWorkerParameters): StreamableMethod<UpsertWorker200Response | UpsertWorker201Response | UpsertWorkerDefaultResponse>;
|
|
2505
|
-
/** Retrieves an existing worker by Id. */
|
|
2506
|
-
get(options?: GetWorkerParameters): StreamableMethod<GetWorker200Response | GetWorkerDefaultResponse>;
|
|
2507
|
-
/** Deletes a worker and all of its traces. */
|
|
2508
|
-
delete(options?: DeleteWorkerParameters): StreamableMethod<DeleteWorker204Response | DeleteWorkerDefaultResponse>;
|
|
2509
|
-
}
|
|
2510
|
-
|
|
2511
|
-
export declare interface UpsertWorker200Headers {
|
|
2512
|
-
/** The entity tag for the response. */
|
|
2513
|
-
etag?: string;
|
|
2514
|
-
/** The last modified timestamp. */
|
|
2515
|
-
"last-modified"?: string;
|
|
2516
|
-
}
|
|
2517
|
-
|
|
2518
|
-
/** The request has succeeded. */
|
|
2519
|
-
export declare interface UpsertWorker200Response extends HttpResponse {
|
|
2520
|
-
status: "200";
|
|
2521
|
-
body: RouterWorkerOutput;
|
|
2522
|
-
headers: RawHttpHeaders & UpsertWorker200Headers;
|
|
2523
|
-
}
|
|
2524
|
-
|
|
2525
|
-
export declare interface UpsertWorker201Headers {
|
|
2526
|
-
/** The entity tag for the response. */
|
|
2527
|
-
etag?: string;
|
|
2528
|
-
/** The last modified timestamp. */
|
|
2529
|
-
"last-modified"?: string;
|
|
2530
|
-
}
|
|
2531
|
-
|
|
2532
|
-
/** The request has succeeded and a new resource has been created as a result. */
|
|
2533
|
-
export declare interface UpsertWorker201Response extends HttpResponse {
|
|
2534
|
-
status: "201";
|
|
2535
|
-
body: RouterWorkerOutput;
|
|
2536
|
-
headers: RawHttpHeaders & UpsertWorker201Headers;
|
|
2537
|
-
}
|
|
2538
|
-
|
|
2539
|
-
export declare interface UpsertWorkerBodyParam {
|
|
2540
|
-
/** The resource instance. */
|
|
2541
|
-
body: RouterWorkerResourceMergeAndPatch;
|
|
2542
|
-
}
|
|
2543
|
-
|
|
2544
|
-
export declare interface UpsertWorkerDefaultHeaders {
|
|
2545
|
-
/** String error code indicating what went wrong. */
|
|
2546
|
-
"x-ms-error-code"?: string;
|
|
2547
|
-
}
|
|
2548
|
-
|
|
2549
|
-
export declare interface UpsertWorkerDefaultResponse extends HttpResponse {
|
|
2550
|
-
status: string;
|
|
2551
|
-
body: ErrorResponse;
|
|
2552
|
-
headers: RawHttpHeaders & UpsertWorkerDefaultHeaders;
|
|
2553
|
-
}
|
|
2554
|
-
|
|
2555
|
-
export declare interface UpsertWorkerHeaderParam {
|
|
2556
|
-
headers?: RawHttpHeadersInput & UpsertWorkerHeaders;
|
|
2557
|
-
}
|
|
2558
|
-
|
|
2559
|
-
export declare interface UpsertWorkerHeaders {
|
|
2560
|
-
/** The request should only proceed if an entity matches this string. */
|
|
2561
|
-
"If-Match"?: string;
|
|
2562
|
-
/** The request should only proceed if the entity was not modified after this time. */
|
|
2563
|
-
"If-Unmodified-Since"?: string;
|
|
2564
|
-
}
|
|
2565
|
-
|
|
2566
|
-
export declare interface UpsertWorkerMediaTypesParam {
|
|
2567
|
-
/** This request has a JSON Merge Patch body. */
|
|
2568
|
-
contentType: "application/merge-patch+json";
|
|
2569
|
-
}
|
|
2570
|
-
|
|
2571
|
-
export declare type UpsertWorkerParameters = UpsertWorkerHeaderParam & UpsertWorkerMediaTypesParam & UpsertWorkerBodyParam & RequestParameters;
|
|
2572
|
-
|
|
2573
|
-
/** Trigger for an exception action on exceeding wait time. */
|
|
2574
|
-
export declare interface WaitTimeExceptionTrigger extends ExceptionTriggerParent {
|
|
2575
|
-
/** Threshold for wait time for this trigger. */
|
|
2576
|
-
thresholdSeconds: number;
|
|
2577
|
-
/** The type discriminator describing a sub-type of ExceptionTrigger. */
|
|
2578
|
-
kind: "waitTime";
|
|
2579
|
-
}
|
|
2580
|
-
|
|
2581
|
-
/** Trigger for an exception action on exceeding wait time. */
|
|
2582
|
-
export declare interface WaitTimeExceptionTriggerOutput extends ExceptionTriggerOutputParent {
|
|
2583
|
-
/** Threshold for wait time for this trigger. */
|
|
2584
|
-
thresholdSeconds: number;
|
|
2585
|
-
/** The type discriminator describing a sub-type of ExceptionTrigger. */
|
|
2586
|
-
kind: "waitTime";
|
|
2587
|
-
}
|
|
2588
|
-
|
|
2589
|
-
/** A rule providing a binding to an external web server. */
|
|
2590
|
-
export declare interface WebhookRouterRule extends RouterRuleParent {
|
|
2591
|
-
/** Uri for Authorization Server. */
|
|
2592
|
-
authorizationServerUri?: string;
|
|
2593
|
-
/** OAuth2.0 Credentials used to Contoso's Authorization server. Reference: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/ */
|
|
2594
|
-
clientCredential?: OAuth2WebhookClientCredential;
|
|
2595
|
-
/** Uri for Contoso's Web Server. */
|
|
2596
|
-
webhookUri?: string;
|
|
2597
|
-
/** The type discriminator describing a sub-type of Rule. */
|
|
2598
|
-
kind: "webhook";
|
|
2599
|
-
}
|
|
2600
|
-
|
|
2601
|
-
/** A rule providing a binding to an external web server. */
|
|
2602
|
-
export declare interface WebhookRouterRuleOutput extends RouterRuleOutputParent {
|
|
2603
|
-
/** Uri for Authorization Server. */
|
|
2604
|
-
authorizationServerUri?: string;
|
|
2605
|
-
/** OAuth2.0 Credentials used to Contoso's Authorization server. Reference: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/ */
|
|
2606
|
-
clientCredential?: OAuth2WebhookClientCredentialOutput;
|
|
2607
|
-
/** Uri for Contoso's Web Server. */
|
|
2608
|
-
webhookUri?: string;
|
|
2609
|
-
/** The type discriminator describing a sub-type of Rule. */
|
|
2610
|
-
kind: "webhook";
|
|
2611
|
-
}
|
|
2612
|
-
|
|
2613
|
-
/** Describes multiple sets of queue selectors, of which one will be selected and attached according to a weighting. */
|
|
2614
|
-
export declare interface WeightedAllocationQueueSelectorAttachment extends QueueSelectorAttachmentParent {
|
|
2615
|
-
/** A collection of percentage based weighted allocations. */
|
|
2616
|
-
allocations: Array<QueueWeightedAllocation>;
|
|
2617
|
-
/** The type discriminator describing the type of queue selector attachment. */
|
|
2618
|
-
kind: "weightedAllocation";
|
|
2619
|
-
}
|
|
2620
|
-
|
|
2621
|
-
/** Describes multiple sets of queue selectors, of which one will be selected and attached according to a weighting. */
|
|
2622
|
-
export declare interface WeightedAllocationQueueSelectorAttachmentOutput extends QueueSelectorAttachmentOutputParent {
|
|
2623
|
-
/** A collection of percentage based weighted allocations. */
|
|
2624
|
-
allocations: Array<QueueWeightedAllocationOutput>;
|
|
2625
|
-
/** The type discriminator describing the type of queue selector attachment. */
|
|
2626
|
-
kind: "weightedAllocation";
|
|
2627
|
-
}
|
|
2628
|
-
|
|
2629
|
-
/** Describes multiple sets of worker selectors, of which one will be selected and attached according to a weighting. */
|
|
2630
|
-
export declare interface WeightedAllocationWorkerSelectorAttachment extends WorkerSelectorAttachmentParent {
|
|
2631
|
-
/** A collection of percentage based weighted allocations. */
|
|
2632
|
-
allocations: Array<WorkerWeightedAllocation>;
|
|
2633
|
-
/** The type discriminator describing the type of worker selector attachment. */
|
|
2634
|
-
kind: "weightedAllocation";
|
|
2635
|
-
}
|
|
2636
|
-
|
|
2637
|
-
/** Describes multiple sets of worker selectors, of which one will be selected and attached according to a weighting. */
|
|
2638
|
-
export declare interface WeightedAllocationWorkerSelectorAttachmentOutput extends WorkerSelectorAttachmentOutputParent {
|
|
2639
|
-
/** A collection of percentage based weighted allocations. */
|
|
2640
|
-
allocations: Array<WorkerWeightedAllocationOutput>;
|
|
2641
|
-
/** The type discriminator describing the type of worker selector attachment. */
|
|
2642
|
-
kind: "weightedAllocation";
|
|
2643
|
-
}
|
|
2644
|
-
|
|
2645
|
-
/** An attachment which attaches worker selectors to a job. */
|
|
2646
|
-
export declare type WorkerSelectorAttachment = WorkerSelectorAttachmentParent | ConditionalWorkerSelectorAttachment | PassThroughWorkerSelectorAttachment | RuleEngineWorkerSelectorAttachment | StaticWorkerSelectorAttachment | WeightedAllocationWorkerSelectorAttachment;
|
|
2647
|
-
|
|
2648
|
-
/** An attachment which attaches worker selectors to a job. */
|
|
2649
|
-
export declare type WorkerSelectorAttachmentOutput = WorkerSelectorAttachmentOutputParent | ConditionalWorkerSelectorAttachmentOutput | PassThroughWorkerSelectorAttachmentOutput | RuleEngineWorkerSelectorAttachmentOutput | StaticWorkerSelectorAttachmentOutput | WeightedAllocationWorkerSelectorAttachmentOutput;
|
|
2650
|
-
|
|
2651
|
-
/** An attachment which attaches worker selectors to a job. */
|
|
2652
|
-
export declare interface WorkerSelectorAttachmentOutputParent {
|
|
2653
|
-
kind: string;
|
|
2654
|
-
}
|
|
2655
|
-
|
|
2656
|
-
/** An attachment which attaches worker selectors to a job. */
|
|
2657
|
-
export declare interface WorkerSelectorAttachmentParent {
|
|
2658
|
-
kind: string;
|
|
2659
|
-
}
|
|
2660
|
-
|
|
2661
|
-
/** Contains the weight percentage and worker selectors to be applied if selected for weighted distributions. */
|
|
2662
|
-
export declare interface WorkerWeightedAllocation {
|
|
2663
|
-
/** The percentage of this weight, expressed as a fraction of 1. */
|
|
2664
|
-
weight: number;
|
|
2665
|
-
/** A collection of worker selectors that will be applied if this allocation is selected. */
|
|
2666
|
-
workerSelectors: Array<RouterWorkerSelector>;
|
|
2667
|
-
}
|
|
2668
|
-
|
|
2669
|
-
/** Contains the weight percentage and worker selectors to be applied if selected for weighted distributions. */
|
|
2670
|
-
export declare interface WorkerWeightedAllocationOutput {
|
|
2671
|
-
/** The percentage of this weight, expressed as a fraction of 1. */
|
|
2672
|
-
weight: number;
|
|
2673
|
-
/** A collection of worker selectors that will be applied if this allocation is selected. */
|
|
2674
|
-
workerSelectors: Array<RouterWorkerSelectorOutput>;
|
|
2675
|
-
}
|
|
2676
|
-
|
|
2677
|
-
export { }
|