SynapseClient class

Pacchetto:

@azure/synapse

Extends

SynapseClientContext

Costruttori

SynapseClient(ServiceClientCredentials, SynapseClientOptions)

Inizializza una nuova istanza della classe SynapseClient.

Proprietà

monitoring
sparkBatch
sparkSession
workspaceAcl

Proprietà ereditate

acceptLanguage
apiVersion
credentials
livyApiVersion
longRunningOperationRetryTimeout	Timeout di ripetizione dei tentativi in secondi per le operazioni a esecuzione prolungata. Il valore predefinito è 30.
synapseDnsSuffix

Metodi ereditati

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)	Inviare la richiesta iniziale di un'operazione LRO (operazione a esecuzione prolungata) e ottenere un httpLongRunningOperationResponse che fornisce metodi per eseguire il polling dell'LRO e verificare se l'LRO è terminato.
restoreLROPoller(LROPollState)	Ripristinare un LROPoller dall'oggetto LROPollState specificato. Questo metodo può essere usato per ricreare un LROPoller in un processo o un computer diverso.
sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)	Fornisce un meccanismo per effettuare una richiesta che eseguirà il polling e fornirà il risultato finale.
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)	Inviare la richiesta iniziale di un'operazione LRO (operazione a esecuzione prolungata) e ottenere un LROPoller che fornisce metodi per eseguire il polling dell'LRO e verificare se l'LRO è terminato.
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Inviare una richiesta HTTP popolata usando operationSpec fornito.
sendRequest(RequestPrepareOptions | WebResourceLike)	Inviare l'oggetto httpRequest fornito.

Dettagli costruttore

SynapseClient(ServiceClientCredentials, SynapseClientOptions)

Inizializza una nuova istanza della classe SynapseClient.

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

Parametri

credentials

ServiceClientCredentials

Credenziali necessarie per la connessione del client ad Azure.

options

SynapseClientOptions

Opzioni dei parametri

Dettagli proprietà

monitoring

monitoring: Monitoring

Valore della proprietà

Monitoring

sparkBatch

sparkBatch: SparkBatch

Valore della proprietà

SparkBatch

sparkSession

sparkSession: SparkSession

Valore della proprietà

SparkSession

workspaceAcl

workspaceAcl: WorkspaceAcl

Valore della proprietà

WorkspaceAcl

Dettagli proprietà ereditate

acceptLanguage

acceptLanguage: string

Valore della proprietà

string

Ereditato daSynapseClientContext.acceptLanguage

apiVersion

apiVersion?: string

Valore della proprietà

string

Ereditato daSynapseClientContext.apiVersion

credentials

credentials: ServiceClientCredentials

Valore della proprietà

ServiceClientCredentials

ereditato daSynapseClientContext.credentials

livyApiVersion

livyApiVersion?: string

Valore della proprietà

string

Ereditato daSynapseClientContext.livyApiVersion

longRunningOperationRetryTimeout

Timeout di ripetizione dei tentativi in secondi per le operazioni a esecuzione prolungata. Il valore predefinito è 30.

longRunningOperationRetryTimeout?: number

Valore della proprietà

number

ereditato daSynapseClientContext.longRunningOperationRetryTimeout

synapseDnsSuffix

synapseDnsSuffix?: string

Valore della proprietà

string

ereditato daSynapseClientContext.synapseDnsSuffix

Dettagli dei metodi ereditati

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Inviare la richiesta iniziale di un'operazione LRO (operazione a esecuzione prolungata) e ottenere un httpLongRunningOperationResponse che fornisce metodi per eseguire il polling dell'LRO e verificare se l'LRO è terminato.

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

Parametri

request

RequestPrepareOptions | WebResource

Oggetto richiesta

options

RequestOptionsBase

Opzioni aggiuntive da inviare durante l'invio della richiesta

Restituisce

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

HttpLongRunningOperationResponse che fornisce metodi per interagire con LRO.

Ereditato daSynapseClientContext.beginLongRunningRequest

restoreLROPoller(LROPollState)

Ripristinare un LROPoller dall'oggetto LROPollState specificato. Questo metodo può essere usato per ricreare un LROPoller in un processo o un computer diverso.

function restoreLROPoller(lroPollState: LROPollState): LROPoller

Parametri

lroPollState

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

Restituisce

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

Ereditato daSynapseClientContext.restoreLROPoller

sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Fornisce un meccanismo per effettuare una richiesta che eseguirà il polling e fornirà il risultato finale.

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

Parametri

request

RequestPrepareOptions | WebResource

Oggetto richiesta

options

RequestOptionsBase

Opzioni aggiuntive da inviare durante l'invio della richiesta

Restituisce

Promise<HttpOperationResponse>

HttpOperationResponse contenente la richiesta di polling finale, la risposta e la rispostaBody.

Ereditato daSynapseClientContext.sendLongRunningRequest

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Inviare la richiesta iniziale di un'operazione LRO (operazione a esecuzione prolungata) e ottenere un LROPoller che fornisce metodi per eseguire il polling dell'LRO e verificare se l'LRO è terminato.

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

Parametri

operationArguments

OperationArguments

Argomenti dell'operazione.

operationSpec

OperationSpec

Specifica per l'operazione.

options

RequestOptionsBase

Opzioni aggiuntive da inviare durante l'invio della richiesta.

Restituisce

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

Oggetto LROPoller che fornisce metodi per interagire con LRO.

ereditato daSynapseClientContext.sendLRORequest

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Inviare una richiesta HTTP popolata usando operationSpec fornito.

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

Parametri

operationArguments

OperationArguments

Gli argomenti da cui verranno popolati i valori basato su modelli della richiesta HTTP.

operationSpec

OperationSpec

OperationSpec da usare per popolare httpRequest.

callback

ServiceCallback<any>

Callback da chiamare quando viene ricevuta la risposta.

Restituisce

Promise<RestResponse>

Ereditato daSynapseClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Inviare l'oggetto httpRequest fornito.

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

Parametri

options

RequestPrepareOptions | WebResourceLike

Restituisce

Promise<HttpOperationResponse>

ereditato daSynapseClientContext.sendRequest