BatchServiceClient class
- Extends
建構函式
| Batch |
初始化 BatchServiceClient 類別的新實例。 |
繼承的屬性
| accept |
|
| api |
|
| batch |
|
| credentials | |
| long |
長時間執行作業的重試逾時以秒為單位。 預設值為 30。 |
繼承的方法
| begin |
傳送 LRO 的初始要求（長時間執行作業），並取得 HttpLongRunningOperationResponse，提供輪詢 LRO 的方法，並檢查 LRO 是否已完成。 |
| restore |
從提供的 LROPollState 還原 LROPoller。 這個方法可用來在不同的進程或計算機上重新建立 LROPoller。 |
| send |
提供機制來提出要求，以輪詢並提供最終結果。 |
| send |
傳送 LRO 的初始要求（長時間執行作業），並取得 LROPoller，該 LROPoller 提供輪詢 LRO 的方法，並檢查 LRO 是否已完成。 |
| send |
傳送使用提供的 OperationSpec 填入的 HTTP 要求。 |
| send |
傳送提供的 HTTPRequest。 |
建構函式詳細資料
BatchServiceClient(ServiceClientCredentials, string, AzureServiceClientOptions)
初始化 BatchServiceClient 類別的新實例。
new BatchServiceClient(credentials: ServiceClientCredentials, batchUrl: string, options?: AzureServiceClientOptions)參數
- credentials
- ServiceClientCredentials
用戶端連線至 Azure 所需的認證。
- batchUrl
-
string
所有 Azure Batch 服務要求的基底 URL。
- options
- @azure/ms-rest-azure-js.AzureServiceClientOptions
參數選項
屬性詳細資料
account
application
certificate
computeNode
file
job
jobSchedule
pool
task
繼承的屬性詳細資料
acceptLanguage
apiVersion
batchUrl
credentials
credentials: ServiceClientCredentials屬性值
longRunningOperationRetryTimeout
長時間執行作業的重試逾時以秒為單位。 預設值為 30。
longRunningOperationRetryTimeout?: number屬性值
number
繼承自BatchServiceClientContext.longRunningOperationRetryTimeout
繼承的方法的詳細資料
beginLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)
傳送 LRO 的初始要求（長時間執行作業），並取得 HttpLongRunningOperationResponse，提供輪詢 LRO 的方法，並檢查 LRO 是否已完成。
function beginLongRunningRequest(request: WebResource | RequestPrepareOptions, options?: RequestOptionsBase): Promise<LROPoller>參數
- request
要求物件
- options
- RequestOptionsBase
提出要求時要傳送的其他選項
傳回
Promise<@azure/ms-rest-azure-js.LROPoller>
HttpLongRunningOperationResponse，提供與 LRO 互動的方法。
restoreLROPoller(LROPollState)
從提供的 LROPollState 還原 LROPoller。 這個方法可用來在不同的進程或計算機上重新建立 LROPoller。
function restoreLROPoller(lroPollState: LROPollState): LROPoller參數
- lroPollState
- @azure/ms-rest-azure-js.LROPollState
傳回
sendLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)
提供機制來提出要求，以輪詢並提供最終結果。
function sendLongRunningRequest(request: WebResource | RequestPrepareOptions, options?: RequestOptionsBase): Promise<HttpOperationResponse>參數
- request
要求物件
- options
- RequestOptionsBase
提出要求時要傳送的其他選項
傳回
Promise<HttpOperationResponse>
包含最終輪詢要求、回應和 responseBody 的 HttpOperationResponse。
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)
傳送 LRO 的初始要求（長時間執行作業），並取得 LROPoller，該 LROPoller 提供輪詢 LRO 的方法，並檢查 LRO 是否已完成。
function sendLRORequest(operationArguments: OperationArguments, operationSpec: OperationSpec, options?: RequestOptionsBase): Promise<LROPoller>參數
- operationArguments
- OperationArguments
作業的自變數。
- operationSpec
- OperationSpec
作業的規格。
- options
- RequestOptionsBase
提出要求時要傳送的其他選項。
傳回
Promise<@azure/ms-rest-azure-js.LROPoller>
提供與 LRO 互動之方法的 LROPoller 物件。
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)
傳送使用提供的 OperationSpec 填入的 HTTP 要求。
function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>參數
- operationArguments
- OperationArguments
HTTP 要求樣板化值的自變數將會從 中填入。
- operationSpec
- OperationSpec
要用來填入 HTTPRequest 的 OperationSpec。
- callback
-
ServiceCallback<any>
收到回應時要呼叫的回呼。
傳回
Promise<RestResponse>
sendRequest(RequestPrepareOptions | WebResourceLike)
傳送提供的 HTTPRequest。
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>參數
- options
傳回
Promise<HttpOperationResponse>