Freigeben über


SynapseClient class

Extends

Konstruktoren

SynapseClient(ServiceClientCredentials, SynapseClientOptions)

Initialisiert eine neue Instanz der SynapseClient-Klasse.

Eigenschaften

monitoring
sparkBatch
sparkSession
workspaceAcl

Geerbte Eigenschaften

acceptLanguage
apiVersion
credentials
livyApiVersion
longRunningOperationRetryTimeout

Das Wiederholungstimeout in Sekunden für Vorgänge mit langer Ausführung. Der Standardwert ist 30.

synapseDnsSuffix

Geerbte Methoden

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Senden Sie die anfängliche Anforderung eines LRO (long running operation) und rufen Sie einen HttpLongRunningOperationResponse zurück, der Methoden zum Abrufen der LRO bereitstellt und überprüft, ob die LRO abgeschlossen ist.

restoreLROPoller(LROPollState)

Stellen Sie einen LROPoller aus dem bereitgestellten LROPollState wieder her. Diese Methode kann verwendet werden, um einen LROPoller auf einem anderen Prozess oder computer neu zu erstellen.

sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Stellt einen Mechanismus bereit, um eine Anforderung zu stellen, die das endgültige Ergebnis abruft und bereitstellt.

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Senden Sie die anfängliche Anforderung eines LRO (long running operation) und rufen Sie einen LROPoller zurück, der Methoden zum Abrufen der LRO bereitstellt und überprüft, ob die LRO abgeschlossen ist.

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Senden Sie eine HTTP-Anforderung, die mit der bereitgestellten OperationSpec aufgefüllt wird.

sendRequest(RequestPrepareOptions | WebResourceLike)

Senden Sie die bereitgestellte httpRequest.

Details zum Konstruktor

SynapseClient(ServiceClientCredentials, SynapseClientOptions)

Initialisiert eine neue Instanz der SynapseClient-Klasse.

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

Parameter

credentials
ServiceClientCredentials

Anmeldeinformationen, die für den Client erforderlich sind, um eine Verbindung mit Azure herzustellen.

options
SynapseClientOptions

Die Parameteroptionen

Details zur Eigenschaft

monitoring

monitoring: Monitoring

Eigenschaftswert

sparkBatch

sparkBatch: SparkBatch

Eigenschaftswert

sparkSession

sparkSession: SparkSession

Eigenschaftswert

workspaceAcl

workspaceAcl: WorkspaceAcl

Eigenschaftswert

Geerbte Eigenschaftsdetails

acceptLanguage

acceptLanguage: string

Eigenschaftswert

string

geerbt vonSynapseClientContext.acceptLanguage

apiVersion

apiVersion?: string

Eigenschaftswert

string

geerbt vonSynapseClientContext.apiVersion

credentials

credentials: ServiceClientCredentials

Eigenschaftswert

VonSynapseClientContext.credentials geerbt

livyApiVersion

livyApiVersion?: string

Eigenschaftswert

string

geerbt vonSynapseClientContext.livyApiVersion

longRunningOperationRetryTimeout

Das Wiederholungstimeout in Sekunden für Vorgänge mit langer Ausführung. Der Standardwert ist 30.

longRunningOperationRetryTimeout?: number

Eigenschaftswert

number

vonSynapseClientContext.longRunningOperationRetryTimeout geerbt

synapseDnsSuffix

synapseDnsSuffix?: string

Eigenschaftswert

string

vonSynapseClientContext.synapseDnsSuffix geerbt

Details zur geerbten Methode

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Senden Sie die anfängliche Anforderung eines LRO (long running operation) und rufen Sie einen HttpLongRunningOperationResponse zurück, der Methoden zum Abrufen der LRO bereitstellt und überprüft, ob die LRO abgeschlossen ist.

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

Parameter

request

RequestPrepareOptions | WebResource

Das Anforderungsobjekt

options
RequestOptionsBase

Weitere Optionen, die beim Senden der Anforderung gesendet werden sollen

Gibt zurück

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

HttpLongRunningOperationResponse, das Methoden für die Interaktion mit dem LRO bereitstellt.

geerbt vonSynapseClientContext.beginLongRunningRequest

restoreLROPoller(LROPollState)

Stellen Sie einen LROPoller aus dem bereitgestellten LROPollState wieder her. Diese Methode kann verwendet werden, um einen LROPoller auf einem anderen Prozess oder computer neu zu erstellen.

function restoreLROPoller(lroPollState: LROPollState): LROPoller

Parameter

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

Gibt zurück

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

vonSynapseClientContext.restoreLROPoller

sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Stellt einen Mechanismus bereit, um eine Anforderung zu stellen, die das endgültige Ergebnis abruft und bereitstellt.

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

Parameter

request

RequestPrepareOptions | WebResource

Das Anforderungsobjekt

options
RequestOptionsBase

Weitere Optionen, die beim Senden der Anforderung gesendet werden sollen

Gibt zurück

Die HttpOperationResponse, die die endgültige Abfrageanforderung, Antwort und den responseBody enthält.

geerbt vonSynapseClientContext.sendLongRunningRequest

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Senden Sie die anfängliche Anforderung eines LRO (long running operation) und rufen Sie einen LROPoller zurück, der Methoden zum Abrufen der LRO bereitstellt und überprüft, ob die LRO abgeschlossen ist.

function sendLRORequest(operationArguments: OperationArguments, operationSpec: OperationSpec, options?: RequestOptionsBase): Promise<LROPoller>

Parameter

operationArguments
OperationArguments

Die Argumente für den Vorgang.

operationSpec
OperationSpec

Die Spezifikation für den Vorgang.

options
RequestOptionsBase

Weitere Optionen, die beim Senden der Anforderung gesendet werden sollen.

Gibt zurück

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

Das LROPoller-Objekt, das Methoden für die Interaktion mit dem LRO bereitstellt.

vonSynapseClientContext.sendLRORequest

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Senden Sie eine HTTP-Anforderung, die mit der bereitgestellten OperationSpec aufgefüllt wird.

function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>

Parameter

operationArguments
OperationArguments

Die Argumente, aus denen die vorlagenbasierten Werte der HTTP-Anforderung ausgefüllt werden.

operationSpec
OperationSpec

Die OperationSpec, die zum Auffüllen der httpRequest verwendet werden soll.

callback

ServiceCallback<any>

Der Rückruf, der aufgerufen werden soll, wenn die Antwort empfangen wird.

Gibt zurück

Promise<RestResponse>

geerbt vonSynapseClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Senden Sie die bereitgestellte httpRequest.

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

Parameter

Gibt zurück

vonSynapseClientContext.sendRequest