SynapseClient class

Extends

Constructores

SynapseClient(ServiceClientCredentials, SynapseClientOptions)

Inicializa una nueva instancia de la clase SynapseClient.

Propiedades

monitoring
sparkBatch
sparkSession
workspaceAcl

Propiedades heredadas

acceptLanguage
apiVersion
credentials
livyApiVersion
longRunningOperationRetryTimeout

Tiempo de espera de reintento en segundos para las operaciones de larga duración. El valor predeterminado es 30.

synapseDnsSuffix

Métodos heredados

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Envíe la solicitud inicial de un LRO (operación de ejecución prolongada) y obtenga una httpLongRunningOperationResponse que proporciona métodos para sondear el LRO y comprobar si el LRO ha finalizado.

restoreLROPoller(LROPollState)

Restaure un LROPoller desde el LROPollState proporcionado. Este método se puede usar para volver a crear un LROPoller en un proceso o máquina diferente.

sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Proporciona un mecanismo para realizar una solicitud que sondeará y proporcionará el resultado final.

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Envíe la solicitud inicial de un LRO (operación de larga duración) y devuelva un LROPoller que proporcione métodos para sondear el LRO y comprobar si el LRO ha finalizado.

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Envíe una solicitud HTTP que se rellene mediante operationSpec proporcionada.

sendRequest(RequestPrepareOptions | WebResourceLike)

Envíe el httpRequest proporcionado.

Detalles del constructor

SynapseClient(ServiceClientCredentials, SynapseClientOptions)

Inicializa una nueva instancia de la clase SynapseClient.

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

Parámetros

credentials
ServiceClientCredentials

Credenciales necesarias para que el cliente se conecte a Azure.

options
SynapseClientOptions

Opciones del parámetro

Detalles de las propiedades

monitoring

monitoring: Monitoring

Valor de propiedad

sparkBatch

sparkBatch: SparkBatch

Valor de propiedad

sparkSession

sparkSession: SparkSession

Valor de propiedad

workspaceAcl

workspaceAcl: WorkspaceAcl

Valor de propiedad

Detalles de las propiedades heredadas

acceptLanguage

acceptLanguage: string

Valor de propiedad

string

Heredado deSynapseClientContext.acceptLanguage

apiVersion

apiVersion?: string

Valor de propiedad

string

Heredado deSynapseClientContext.apiVersion

credentials

credentials: ServiceClientCredentials

Valor de propiedad

Heredado deSynapseClientContext.credentials

livyApiVersion

livyApiVersion?: string

Valor de propiedad

string

Heredado deSynapseClientContext.livyApiVersion

longRunningOperationRetryTimeout

Tiempo de espera de reintento en segundos para las operaciones de larga duración. El valor predeterminado es 30.

longRunningOperationRetryTimeout?: number

Valor de propiedad

number

Heredado deSynapseClientContext.longRunningOperationRetryTimeout

synapseDnsSuffix

synapseDnsSuffix?: string

Valor de propiedad

string

Heredado deSynapseClientContext.synapseDnsSuffix

Detalles de los métodos heredados

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Envíe la solicitud inicial de un LRO (operación de ejecución prolongada) y obtenga una httpLongRunningOperationResponse que proporciona métodos para sondear el LRO y comprobar si el LRO ha finalizado.

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

Parámetros

request

RequestPrepareOptions | WebResource

El objeto request

options
RequestOptionsBase

Opciones adicionales que se enviarán al realizar la solicitud

Devoluciones

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

HttpLongRunningOperationResponse que proporciona métodos para interactuar con el LRO.

Heredado deSynapseClientContext.beginLongRunningRequest

restoreLROPoller(LROPollState)

Restaure un LROPoller desde el LROPollState proporcionado. Este método se puede usar para volver a crear un LROPoller en un proceso o máquina diferente.

function restoreLROPoller(lroPollState: LROPollState): LROPoller

Parámetros

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

Devoluciones

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

Heredado deSynapseClientContext.restoreLROPoller

sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Proporciona un mecanismo para realizar una solicitud que sondeará y proporcionará el resultado final.

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

Parámetros

request

RequestPrepareOptions | WebResource

El objeto request

options
RequestOptionsBase

Opciones adicionales que se enviarán al realizar la solicitud

Devoluciones

HttpOperationResponse que contiene la solicitud de sondeo final, la respuesta y la respuestaBody.

Heredado deSynapseClientContext.sendLongRunningRequest

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Envíe la solicitud inicial de un LRO (operación de larga duración) y devuelva un LROPoller que proporcione métodos para sondear el LRO y comprobar si el LRO ha finalizado.

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

Parámetros

operationArguments
OperationArguments

Argumentos de la operación.

operationSpec
OperationSpec

Especificación de la operación.

options
RequestOptionsBase

Opciones adicionales que se enviarán al realizar la solicitud.

Devoluciones

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

Objeto LROPoller que proporciona métodos para interactuar con el LRO.

Heredado deSynapseClientContext.sendLRORequest

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Envíe una solicitud HTTP que se rellene mediante operationSpec proporcionada.

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

Parámetros

operationArguments
OperationArguments

Argumentos desde los que se rellenarán los valores con plantilla de la solicitud HTTP.

operationSpec
OperationSpec

OperationSpec que se va a usar para rellenar httpRequest.

callback

ServiceCallback<any>

Devolución de llamada que se va a llamar cuando se recibe la respuesta.

Devoluciones

Promise<RestResponse>

Heredado deSynapseClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Envíe el httpRequest proporcionado.

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

Parámetros

Devoluciones

Heredado deSynapseClientContext.sendRequest