SynapseClient class

Pacote:: @azure/synapse

Extends: SynapseClientContext

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 longa duração. O valor padrão é 30.
synapseDnsSuffix

Métodos Herdados

beginLongRunningRequest(RequestPrepareOptions \| WebResource, RequestOptionsBase)	Envie a solicitação inicial de um LRO (operação de longa duração) 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 a partir do LROPollState fornecido. Este método pode ser usado para recriar um LROPoller em um processo ou máquina diferente.
sendLongRunningRequest(RequestPrepareOptions \| WebResource, RequestOptionsBase)	Fornece um mecanismo para fazer uma solicitação que irá sondar e fornecer o resultado final.
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)	Envie o pedido inicial de um LRO (operação de longa duração) e obtenha de volta um LROPoller que fornece métodos para sondar o LRO e verificar se o LRO está concluído.
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Envie uma solicitação HTTP que é 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 o cliente se conectar ao Azure.

options: SynapseClientOptions

As opções de parâmetro

Detalhes de Propriedade

monitoring

monitoring: Monitoring

Valor de Propriedade

Monitoring

sparkBatch

sparkBatch: SparkBatch

Valor de Propriedade

SparkBatch

sparkSession

sparkSession: SparkSession

Valor de Propriedade

SparkSession

workspaceAcl

workspaceAcl: WorkspaceAcl

Valor de Propriedade

WorkspaceAcl

Detalhes da Propriedade Herdada

acceptLanguage

acceptLanguage: string

Valor de Propriedade

string

herdado deSynapseClientContext.acceptLanguage

apiVersion

apiVersion?: string

Valor de Propriedade

string

herdado deSynapseClientContext.apiVersion

credentials

credentials: ServiceClientCredentials

Valor de Propriedade

ServiceClientCredentials

herdado deSynapseClientContext.credentials

livyApiVersion

livyApiVersion?: string

Valor de Propriedade

string

herdado deSynapseClientContext.livyApiVersion

longRunningOperationRetryTimeout

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

longRunningOperationRetryTimeout?: number

Valor de Propriedade

number

herdado deSynapseClientContext.longRunningOperationRetryTimeout

synapseDnsSuffix

synapseDnsSuffix?: string

Valor de Propriedade

string

herdado de de sufixo SynapseClientContext.synapseDnsSuffix

Detalhes do Método Herdado

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Envie a solicitação inicial de um LRO (operação de longa duração) 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

Devoluções

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 a partir do LROPollState fornecido. Este método pode ser usado para recriar um LROPoller em um processo ou máquina diferente.

function restoreLROPoller(lroPollState: LROPollState): LROPoller

Parâmetros

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

Devoluções

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

herdado deSynapseClientContext.restoreLROPoller

sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Fornece um mecanismo para fazer uma solicitação que irá 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

Devoluções

Promise<HttpOperationResponse>

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 o pedido inicial de um LRO (operação de longa duração) e obtenha de volta um LROPoller que fornece métodos para sondar o LRO e verificar se o LRO está 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 para a operação.

options: RequestOptionsBase

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

Devoluções

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

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

herdado deSynapseClientContext.sendLRORequest

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

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

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

Parâmetros

operationArguments: OperationArguments

Os argumentos a partir 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 para ligar quando a resposta for recebida.

Devoluções

Promise<RestResponse>

herdado de SynapseClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Envie o httpRequest fornecido.

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

Parâmetros

options: RequestPrepareOptions | WebResourceLike

Devoluções

Promise<HttpOperationResponse>

herdado deSynapseClientContext.sendRequest