@azure-rest/communication-job-router package
インターフェイス
型エイリアス
| AcceptParameters | |
| AzureCommunicationRoutingServiceClient | |
| CancelParameters | |
| ClassificationPolicyResourceMergeAndPatch |
リソース インスタンス。 |
| CloseParameters | |
| CompleteParameters | |
| DeclineParameters | |
| DeleteClassificationPolicyParameters | |
| DeleteDistributionPolicyParameters | |
| DeleteExceptionPolicyParameters | |
| DeleteJobParameters | |
| DeleteQueueParameters | |
| DeleteWorkerParameters | |
| DistributionMode |
分散モードを定義するための抽象基本クラス。 |
| DistributionModeOutput |
分散モードを定義するための抽象基本クラス。 |
| DistributionPolicyResourceMergeAndPatch |
リソース インスタンス。 |
| ExceptionAction |
例外がトリガーされたときに実行するアクション。 |
| ExceptionActionOutput |
例外がトリガーされたときに実行するアクション。 |
| ExceptionPolicyResourceMergeAndPatch |
リソース インスタンス。 |
| ExceptionTrigger |
例外ルールのトリガーを定義するための抽象基本クラス。 |
| ExceptionTriggerOutput |
例外ルールのトリガーを定義するための抽象基本クラス。 |
| GetArrayType |
配列の型を抽出するヘルパー型 |
| GetClassificationPolicyParameters | |
| GetDistributionPolicyParameters | |
| GetExceptionPolicyParameters | |
| GetInQueuePositionParameters | |
| GetJobParameters | |
| GetPage |
ページの取得方法と、次のページへのリンク (ある場合) を定義するカスタム関数の型。 |
| GetQueueParameters | |
| GetQueueStatisticsParameters | |
| GetWorkerParameters | |
| JobMatchingMode |
次のいずれかの種類の一致モード: QueueAndMatchMode: ジョブがキューに登録された直後にワーカーとジョブを照合する必要がある場合に使用されます。 ScheduleAndSuspendMode: 将来キューに登録されるジョブをスケジュールするために使用されます。 指定した時刻に、ワーカーとジョブの照合が自動的に開始されることはありません。 SuspendMode: ワーカーをジョブに一致させる必要がある場合に使用されます。 |
| JobMatchingModeOutput |
次のいずれかの種類の一致モード: QueueAndMatchMode: ジョブがキューに登録された直後にワーカーとジョブを照合する必要がある場合に使用されます。 ScheduleAndSuspendMode: 将来キューに登録されるジョブをスケジュールするために使用されます。 指定した時刻に、ワーカーとジョブの照合が自動的に開始されることはありません。 SuspendMode: ワーカーをジョブに一致させる必要がある場合に使用されます。 |
| ListClassificationPoliciesParameters | |
| ListDistributionPoliciesParameters | |
| ListExceptionPoliciesParameters | |
| ListJobsParameters | |
| ListQueuesParameters | |
| ListWorkersParameters | |
| PagedClassificationPolicyOutput |
ClassificationPolicy 項目のページ コレクション |
| PagedDistributionPolicyOutput |
DistributionPolicy 項目のページ コレクション |
| PagedExceptionPolicyOutput |
ExceptionPolicy 項目のページ コレクション |
| PagedRouterJobOutput |
RouterJob 項目のページング コレクション |
| PagedRouterQueueOutput |
RouterQueue 項目のページ コレクション |
| PagedRouterWorkerOutput |
RouterWorker アイテムのページング コレクション |
| PaginateReturn |
応答型からページングされた要素の型を推測するヘルパー型。この型は、ページアイテムが見つかった応答のプロパティを示す itemName プロパティに対する x-ms-pageable の swagger 情報に基づいて生成されます。 既定値は |
| QueueSelectorAttachment |
分類ポリシーからキューをジョブに解決するためのキュー セレクターの添付ファイル。 |
| QueueSelectorAttachmentOutput |
分類ポリシーからキューをジョブに解決するためのキュー セレクターの添付ファイル。 |
| ReclassifyParameters | |
| RouterJobResourceMergeAndPatch |
リソース インスタンス。 |
| RouterQueueResourceMergeAndPatch |
リソース インスタンス。 |
| RouterRule |
次のいずれかの種類のルール: StaticRule: 入力に関係なく常に同じ結果を返す静的ルールを提供するルール。 DirectMapRule: 入力ラベルと同じラベルを返すルール。 ExpressionRule: インライン式ルールを提供するルール。 FunctionRule: HTTP によってトリガーされる Azure 関数へのバインドを提供するルール。 WebhookRule: OAuth2.0 認証プロトコルに従って Web サーバーへのバインドを提供する規則。 |
| RouterRuleOutput |
次のいずれかの種類のルール: StaticRule: 入力に関係なく常に同じ結果を返す静的ルールを提供するルール。 DirectMapRule: 入力ラベルと同じラベルを返すルール。 ExpressionRule: インライン式ルールを提供するルール。 FunctionRule: HTTP によってトリガーされる Azure 関数へのバインドを提供するルール。 WebhookRule: OAuth2.0 認証プロトコルに従って Web サーバーへのバインドを提供する規則。 |
| RouterWorkerResourceMergeAndPatch |
リソース インスタンス。 |
| UnassignParameters | |
| UpsertClassificationPolicyParameters | |
| UpsertDistributionPolicyParameters | |
| UpsertExceptionPolicyParameters | |
| UpsertJobParameters | |
| UpsertQueueParameters | |
| UpsertWorkerParameters | |
| WorkerSelectorAttachment |
ワーカー セレクターをジョブにアタッチする添付ファイル。 |
| WorkerSelectorAttachmentOutput |
ワーカー セレクターをジョブにアタッチする添付ファイル。 |
関数
関数の詳細
default(string, ClientOptions)
AzureCommunicationRoutingServiceClient の新しいインスタンスを初期化する
function default(connectionString: string, options: ClientOptions): AzureCommunicationRoutingServiceClient
パラメーター
- connectionString
-
string
Communication Services リソースの connectionString または URL。
- options
- ClientOptions
すべての省略可能なパラメーターのパラメーター
戻り値
default(string, KeyCredential | TokenCredential, ClientOptions)
AzureCommunicationRoutingServiceClient の新しいインスタンスを初期化する
function default(endpoint: string, credentialOrOptions?: KeyCredential | TokenCredential, options?: ClientOptions): AzureCommunicationRoutingServiceClient
パラメーター
- endpoint
-
string
Communication Services リソースのエンドポイント。
- credentialOrOptions
キーまたはトークンの資格情報。
- options
- ClientOptions
すべての省略可能なパラメーターのパラメーター
戻り値
isUnexpected(UpsertClassificationPolicy200Response | UpsertClassificationPolicy201Response | UpsertClassificationPolicyDefaultResponse)
function isUnexpected(response: UpsertClassificationPolicy200Response | UpsertClassificationPolicy201Response | UpsertClassificationPolicyDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(GetClassificationPolicy200Response | GetClassificationPolicyDefaultResponse)
function isUnexpected(response: GetClassificationPolicy200Response | GetClassificationPolicyDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(DeleteClassificationPolicy204Response | DeleteClassificationPolicyDefaultResponse)
function isUnexpected(response: DeleteClassificationPolicy204Response | DeleteClassificationPolicyDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(ListClassificationPolicies200Response | ListClassificationPoliciesDefaultResponse)
function isUnexpected(response: ListClassificationPolicies200Response | ListClassificationPoliciesDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(UpsertDistributionPolicy200Response | UpsertDistributionPolicy201Response | UpsertDistributionPolicyDefaultResponse)
function isUnexpected(response: UpsertDistributionPolicy200Response | UpsertDistributionPolicy201Response | UpsertDistributionPolicyDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(GetDistributionPolicy200Response | GetDistributionPolicyDefaultResponse)
function isUnexpected(response: GetDistributionPolicy200Response | GetDistributionPolicyDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(DeleteDistributionPolicy204Response | DeleteDistributionPolicyDefaultResponse)
function isUnexpected(response: DeleteDistributionPolicy204Response | DeleteDistributionPolicyDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(ListDistributionPolicies200Response | ListDistributionPoliciesDefaultResponse)
function isUnexpected(response: ListDistributionPolicies200Response | ListDistributionPoliciesDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(UpsertExceptionPolicy200Response | UpsertExceptionPolicy201Response | UpsertExceptionPolicyDefaultResponse)
function isUnexpected(response: UpsertExceptionPolicy200Response | UpsertExceptionPolicy201Response | UpsertExceptionPolicyDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(GetExceptionPolicy200Response | GetExceptionPolicyDefaultResponse)
function isUnexpected(response: GetExceptionPolicy200Response | GetExceptionPolicyDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(DeleteExceptionPolicy204Response | DeleteExceptionPolicyDefaultResponse)
function isUnexpected(response: DeleteExceptionPolicy204Response | DeleteExceptionPolicyDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(ListExceptionPolicies200Response | ListExceptionPoliciesDefaultResponse)
function isUnexpected(response: ListExceptionPolicies200Response | ListExceptionPoliciesDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(UpsertQueue200Response | UpsertQueue201Response | UpsertQueueDefaultResponse)
function isUnexpected(response: UpsertQueue200Response | UpsertQueue201Response | UpsertQueueDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(GetQueue200Response | GetQueueDefaultResponse)
function isUnexpected(response: GetQueue200Response | GetQueueDefaultResponse): response
パラメーター
- response
戻り値
response
isUnexpected(DeleteQueue204Response | DeleteQueueDefaultResponse)
function isUnexpected(response: DeleteQueue204Response | DeleteQueueDefaultResponse): response
パラメーター
- response
戻り値
response
isUnexpected(ListQueues200Response | ListQueuesDefaultResponse)
function isUnexpected(response: ListQueues200Response | ListQueuesDefaultResponse): response
パラメーター
- response
戻り値
response
isUnexpected(UpsertJob200Response | UpsertJob201Response | UpsertJobDefaultResponse)
function isUnexpected(response: UpsertJob200Response | UpsertJob201Response | UpsertJobDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(GetJob200Response | GetJobDefaultResponse)
function isUnexpected(response: GetJob200Response | GetJobDefaultResponse): response
パラメーター
- response
戻り値
response
isUnexpected(DeleteJob204Response | DeleteJobDefaultResponse)
function isUnexpected(response: DeleteJob204Response | DeleteJobDefaultResponse): response
パラメーター
- response
戻り値
response
isUnexpected(Reclassify200Response | ReclassifyDefaultResponse)
function isUnexpected(response: Reclassify200Response | ReclassifyDefaultResponse): response
パラメーター
- response
戻り値
response
isUnexpected(Cancel200Response | CancelDefaultResponse)
function isUnexpected(response: Cancel200Response | CancelDefaultResponse): response
パラメーター
- response
戻り値
response
isUnexpected(Complete200Response | CompleteDefaultResponse)
function isUnexpected(response: Complete200Response | CompleteDefaultResponse): response
パラメーター
- response
戻り値
response
isUnexpected(Close200Response | CloseDefaultResponse)
function isUnexpected(response: Close200Response | CloseDefaultResponse): response
パラメーター
- response
戻り値
response
isUnexpected(ListJobs200Response | ListJobsDefaultResponse)
function isUnexpected(response: ListJobs200Response | ListJobsDefaultResponse): response
パラメーター
- response
戻り値
response
isUnexpected(GetInQueuePosition200Response | GetInQueuePositionDefaultResponse)
function isUnexpected(response: GetInQueuePosition200Response | GetInQueuePositionDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(Unassign200Response | UnassignDefaultResponse)
function isUnexpected(response: Unassign200Response | UnassignDefaultResponse): response
パラメーター
- response
戻り値
response
isUnexpected(Accept200Response | AcceptDefaultResponse)
function isUnexpected(response: Accept200Response | AcceptDefaultResponse): response
パラメーター
- response
戻り値
response
isUnexpected(Decline200Response | DeclineDefaultResponse)
function isUnexpected(response: Decline200Response | DeclineDefaultResponse): response
パラメーター
- response
戻り値
response
isUnexpected(GetQueueStatistics200Response | GetQueueStatisticsDefaultResponse)
function isUnexpected(response: GetQueueStatistics200Response | GetQueueStatisticsDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(UpsertWorker200Response | UpsertWorker201Response | UpsertWorkerDefaultResponse)
function isUnexpected(response: UpsertWorker200Response | UpsertWorker201Response | UpsertWorkerDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(GetWorker200Response | GetWorkerDefaultResponse)
function isUnexpected(response: GetWorker200Response | GetWorkerDefaultResponse): response
パラメーター
- response
戻り値
response
isUnexpected(DeleteWorker204Response | DeleteWorkerDefaultResponse)
function isUnexpected(response: DeleteWorker204Response | DeleteWorkerDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(ListWorkers200Response | ListWorkersDefaultResponse)
function isUnexpected(response: ListWorkers200Response | ListWorkersDefaultResponse): response
パラメーター
- response
戻り値
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Autorest x-ms-pageable 拡張機能の仕様に従った最初の応答からの結果を改ページするヘルパー
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>
パラメーター
- client
- Client
次のページ要求の送信に使用するクライアント
- initialResponse
-
TResponse
nextLink と要素の現在のページを含む初期応答
- options
-
PagingOptions<TResponse>
戻り値
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator を使用して要素を反復処理する