你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

BatchServiceClientContext class

包:

@azure/batch

Extends

@azure/ms-rest-azure-js.AzureServiceClient

构造函数

BatchServiceClientContext(ServiceClientCredentials, string, AzureServiceClientOptions)

初始化 BatchServiceClient 类的新实例。

属性

apiVersion
batchUrl
credentials

继承属性

acceptLanguage
longRunningOperationRetryTimeout	长时间运行的操作的重试超时（以秒为单位）。 默认值为 30。

继承的方法

beginLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)	) 发送 LRO (长时间运行的操作的初始请求，并取回 HttpLongRunningOperationResponse，该请求提供轮询 LRO 和检查 LRO 是否已完成的方法。
restoreLROPoller(LROPollState)	从提供的 LROPollState 还原 LROPoller。 此方法可用于在不同的进程或计算机上重新创建 LROPoller。
sendLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)	提供一种机制，用于发出将轮询并提供最终结果的请求。
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)	发送 LRO 的初始请求 (长时间运行的操作) 并取回 LROPoller，该 LROPoller 提供轮询 LRO 和检查 LRO 是否已完成的方法。
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	发送使用提供的 OperationSpec 填充的 HTTP 请求。
sendRequest(RequestPrepareOptions | WebResourceLike)	发送提供的 httpRequest。

构造函数详细信息

BatchServiceClientContext(ServiceClientCredentials, string, AzureServiceClientOptions)

初始化 BatchServiceClient 类的新实例。

new BatchServiceClientContext(credentials: ServiceClientCredentials, batchUrl: string, options?: AzureServiceClientOptions)

参数

credentials

ServiceClientCredentials

客户端连接到 Azure 所需的凭据。

batchUrl

string

所有Azure Batch服务请求的基 URL。

options

@azure/ms-rest-azure-js.AzureServiceClientOptions

参数选项

属性详细信息

apiVersion

apiVersion?: string

属性值

string

batchUrl

batchUrl: string

属性值

string

credentials

credentials: ServiceClientCredentials

属性值

ServiceClientCredentials

继承属性详细信息

acceptLanguage

acceptLanguage: string

属性值

string

继承自 msRestAzure.AzureServiceClient.acceptLanguage

longRunningOperationRetryTimeout

长时间运行的操作的重试超时（以秒为单位）。 默认值为 30。

longRunningOperationRetryTimeout?: number

属性值

number

继承自 msRestAzure.AzureServiceClient.longRunningOperationRetryTimeout

继承的方法详细信息

beginLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)

) 发送 LRO (长时间运行的操作的初始请求，并取回 HttpLongRunningOperationResponse，该请求提供轮询 LRO 和检查 LRO 是否已完成的方法。

function beginLongRunningRequest(request: WebResource | RequestPrepareOptions, options?: RequestOptionsBase): Promise<LROPoller>

参数

request

WebResource | RequestPrepareOptions

请求对象

options

RequestOptionsBase

发出请求时要发送的其他选项

返回

Promise<@azure/ms-rest-azure-js.LROPoller>

HttpLongRunningOperationResponse，提供与 LRO 交互的方法。

继承自 msRestAzure.AzureServiceClient.beginLongRunningRequest

restoreLROPoller(LROPollState)

从提供的 LROPollState 还原 LROPoller。 此方法可用于在不同的进程或计算机上重新创建 LROPoller。

function restoreLROPoller(lroPollState: LROPollState): LROPoller

参数

lroPollState

@azure/ms-rest-azure-js.LROPollState

返回

@azure/ms-rest-azure-js.LROPoller

继承自 msRestAzure.AzureServiceClient.restoreLROPoller

sendLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)

提供一种机制，用于发出将轮询并提供最终结果的请求。

function sendLongRunningRequest(request: WebResource | RequestPrepareOptions, options?: RequestOptionsBase): Promise<HttpOperationResponse>

参数

request

WebResource | RequestPrepareOptions

请求对象

options

RequestOptionsBase

发出请求时要发送的其他选项

返回

Promise<HttpOperationResponse>

包含最终轮询请求、响应和 responseBody 的 HttpOperationResponse。

继承自 msRestAzure.AzureServiceClient.sendLongRunningRequest

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 对象。

继承自 msRestAzure.AzureServiceClient.sendLRORequest

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>

继承自 msRestAzure.AzureServiceClient.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

发送提供的 httpRequest。

function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>

参数

options

RequestPrepareOptions | WebResourceLike

返回

Promise<HttpOperationResponse>

继承自 msRestAzure.AzureServiceClient.sendRequest