SynapseClient class

Extends

Construtores

SynapseClient(ServiceClientCredentials, SynapseClientOptions)

Inicializa uma nova instância da classe SynapseClient.

Propriedades

monitoring
sparkBatch
sparkSession
workspaceAcl

Propriedades herdadas

acceptLanguage
apiVersion
credentials
livyApiVersion
longRunningOperationRetryTimeout

O tempo limite de repetição em segundos para operações de execução longa. O valor padrão é 30.

synapseDnsSuffix

Métodos herdados

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Envie a solicitação inicial de um LRO (operação de execução prolongada) e obtenha de volta um HttpLongRunningOperationResponse que fornece métodos para sondar o LRO e verificar se o LRO foi concluído.

restoreLROPoller(LROPollState)

Restaure um LROPoller do LROPollState fornecido. Esse método pode ser usado para recriar um LROPoller em um processo ou computador diferente.

sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Fornece um mecanismo para fazer uma solicitação que sondará e fornecerá o resultado final.

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Envie a solicitação inicial de um LRO (operação de execução prolongada) e retorne um LROPoller que fornece métodos para sondar o LRO e verificar se o LRO foi concluído.

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Envie uma solicitação HTTP preenchida usando o OperationSpec fornecido.

sendRequest(RequestPrepareOptions | WebResourceLike)

Envie o httpRequest fornecido.

Detalhes do construtor

SynapseClient(ServiceClientCredentials, SynapseClientOptions)

Inicializa uma nova instância da classe SynapseClient.

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

Parâmetros

credentials
ServiceClientCredentials

Credenciais necessárias para que o cliente se conecte ao Azure.

options
SynapseClientOptions

As opções de parâmetro

Detalhes da propriedade

monitoring

monitoring: Monitoring

Valor da propriedade

sparkBatch

sparkBatch: SparkBatch

Valor da propriedade

sparkSession

sparkSession: SparkSession

Valor da propriedade

workspaceAcl

workspaceAcl: WorkspaceAcl

Valor da propriedade

Detalhes das propriedades herdadas

acceptLanguage

acceptLanguage: string

Valor da propriedade

string

Herdado deSynapseClientContext.acceptLanguage

apiVersion

apiVersion?: string

Valor da propriedade

string

Herdado deSynapseClientContext.apiVersion

credentials

credentials: ServiceClientCredentials

Valor da propriedade

herdado deSynapseClientContext.credentials

livyApiVersion

livyApiVersion?: string

Valor da propriedade

string

Herdado deSynapseClientContext.livyApiVersion

longRunningOperationRetryTimeout

O tempo limite de repetição em segundos para operações de execução longa. O valor padrão é 30.

longRunningOperationRetryTimeout?: number

Valor da propriedade

number

herdado deSynapseClientContext.longRunningOperationRetryTimeout

synapseDnsSuffix

synapseDnsSuffix?: string

Valor da propriedade

string

Herdado deSynapseClientContext.synapseDnsSuffix

Detalhes do método herdado

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Envie a solicitação inicial de um LRO (operação de execução prolongada) e obtenha de volta um HttpLongRunningOperationResponse que fornece métodos para sondar o LRO e verificar se o LRO foi concluído.

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

Parâmetros

request

RequestPrepareOptions | WebResource

O objeto de solicitação

options
RequestOptionsBase

Opções adicionais a serem enviadas ao fazer a solicitação

Retornos

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

O HttpLongRunningOperationResponse que fornece métodos para interagir com o LRO.

herdado de SynapseClientContext.beginLongRunningRequest

restoreLROPoller(LROPollState)

Restaure um LROPoller do LROPollState fornecido. Esse método pode ser usado para recriar um LROPoller em um processo ou computador diferente.

function restoreLROPoller(lroPollState: LROPollState): LROPoller

Parâmetros

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

Retornos

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

Herdado de SynapseClientContext.restoreLROPoller

sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Fornece um mecanismo para fazer uma solicitação que sondará e fornecerá o resultado final.

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

Parâmetros

request

RequestPrepareOptions | WebResource

O objeto de solicitação

options
RequestOptionsBase

Opções adicionais a serem enviadas ao fazer a solicitação

Retornos

O HttpOperationResponse que contém a solicitação de sondagem final, a resposta e o responseBody.

Herdado de SynapseClientContext.sendLongRunningRequest

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Envie a solicitação inicial de um LRO (operação de execução prolongada) e retorne um LROPoller que fornece métodos para sondar o LRO e verificar se o LRO foi concluído.

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

Parâmetros

operationArguments
OperationArguments

Os argumentos para a operação.

operationSpec
OperationSpec

A especificação da operação.

options
RequestOptionsBase

Opções adicionais a serem enviadas ao fazer a solicitação.

Retornos

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

O objeto LROPoller que fornece métodos para interagir com o LRO.

herdado de SynapseClientContext.sendLRORequest

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Envie uma solicitação HTTP preenchida usando o OperationSpec fornecido.

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

Parâmetros

operationArguments
OperationArguments

Os argumentos dos quais os valores de modelo da solicitação HTTP serão preenchidos.

operationSpec
OperationSpec

O OperationSpec a ser usado para preencher o httpRequest.

callback

ServiceCallback<any>

O retorno de chamada a ser chamado quando a resposta é recebida.

Retornos

Promise<RestResponse>

herdado de SynapseClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Envie o httpRequest fornecido.

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

Parâmetros

Retornos

herdado de SynapseClientContext.sendRequest