SynapseClient class

Extends

コンストラクター

SynapseClient(ServiceClientCredentials, SynapseClientOptions)

SynapseClient クラスの新しいインスタンスを初期化します。

プロパティ

monitoring
sparkBatch
sparkSession
workspaceAcl

継承されたプロパティ

acceptLanguage
apiVersion
credentials
livyApiVersion
longRunningOperationRetryTimeout

実行時間の長い操作の再試行タイムアウト (秒単位)。 既定値は 30 です。

synapseDnsSuffix

継承されたメソッド

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

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

restoreLROPoller(LROPollState)

指定された LROPollState から LROPoller を復元します。 このメソッドを使用して、別のプロセスまたはマシンで LROPoller を再作成できます。

sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

ポーリングして最終的な結果を提供する要求を行うメカニズムを提供します。

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

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

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

指定された OperationSpec を使用して設定された HTTP 要求を送信します。

sendRequest(RequestPrepareOptions | WebResourceLike)

指定された httpRequest を送信します。

コンストラクターの詳細

SynapseClient(ServiceClientCredentials, SynapseClientOptions)

SynapseClient クラスの新しいインスタンスを初期化します。

new SynapseClient(credentials: ServiceClientCredentials, options?: SynapseClientOptions)

パラメーター

credentials
ServiceClientCredentials

クライアントが Azure に接続するために必要な資格情報。

options
SynapseClientOptions

パラメーター のオプション

プロパティの詳細

monitoring

monitoring: Monitoring

プロパティ値

sparkBatch

sparkBatch: SparkBatch

プロパティ値

sparkSession

sparkSession: SparkSession

プロパティ値

workspaceAcl

workspaceAcl: WorkspaceAcl

プロパティ値

継承されたプロパティの詳細

acceptLanguage

acceptLanguage: string

プロパティ値

string

承元SynapseClientContext.acceptLanguage

apiVersion

apiVersion?: string

プロパティ値

string

承元SynapseClientContext.apiVersion

credentials

credentials: ServiceClientCredentials

プロパティ値

SynapseClientContext.credentialsから継承

livyApiVersion

livyApiVersion?: string

プロパティ値

string

承元SynapseClientContext.livyApiVersion

longRunningOperationRetryTimeout

実行時間の長い操作の再試行タイムアウト (秒単位)。 既定値は 30 です。

longRunningOperationRetryTimeout?: number

プロパティ値

number

承元SynapseClientContext.longRunningOperationRetryTimeout

synapseDnsSuffix

synapseDnsSuffix?: string

プロパティ値

string

承元SynapseClientContext.synapseDnsSuffix

継承済みメソッドの詳細

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

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

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

パラメーター

request

RequestPrepareOptions | WebResource

要求オブジェクト

options
RequestOptionsBase

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

戻り値

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

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

承元SynapseClientContext.beginLongRunningRequest

restoreLROPoller(LROPollState)

指定された LROPollState から LROPoller を復元します。 このメソッドを使用して、別のプロセスまたはマシンで LROPoller を再作成できます。

function restoreLROPoller(lroPollState: LROPollState): LROPoller

パラメーター

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

戻り値

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

承元SynapseClientContext.restoreLROPoller

sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

ポーリングして最終的な結果を提供する要求を行うメカニズムを提供します。

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

パラメーター

request

RequestPrepareOptions | WebResource

要求オブジェクト

options
RequestOptionsBase

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

戻り値

最終的なポーリング要求、応答、および responseBody を含む HttpOperationResponse。

承元SynapseClientContext.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 オブジェクト。

承元SynapseClientContext.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>

承元SynapseClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

指定された httpRequest を送信します。

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

パラメーター

戻り値

承元SynapseClientContext.sendRequest