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 の初期要求 (実行時間の長い操作) を送信し、LRO をポーリングし、LRO が完了したかどうかを確認するためのメソッドを提供する HttpLongRunningOperationResponse を取得します。
restoreLROPoller(LROPollState)	指定された LROPollState から LROPoller を復元します。 このメソッドを使用して、別のプロセスまたはマシンで LROPoller を再作成できます。
sendLongRunningRequest(WebResource | RequestPrepareOptions, RequestOptionsBase)	ポーリングして最終的な結果を提供する要求を行うメカニズムを提供します。
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)	LRO の初期要求 (実行時間の長い操作) を送信し、LRO をポーリングし、LRO が完了したかどうかを確認するためのメソッドを提供する LROPoller を取得します。
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 の初期要求 (実行時間の長い操作) を送信し、LRO をポーリングし、LRO が完了したかどうかを確認するためのメソッドを提供する HttpLongRunningOperationResponse を取得します。

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

パラメーター

request

WebResource | RequestPrepareOptions

要求オブジェクト

options

RequestOptionsBase

要求の実行中に送信される追加のオプション

戻り値

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

LRO と対話するためのメソッドを提供する HttpLongRunningOperationResponse。

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 の初期要求 (実行時間の長い操作) を送信し、LRO をポーリングし、LRO が完了したかどうかを確認するためのメソッドを提供する LROPoller を取得します。

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 から継承された