SynapseClient class
- Extends
Konstruktorer
| Synapse |
Initierar en ny instans av klassen SynapseClient. |
Egenskaper
| monitoring | |
| spark |
|
| spark |
|
| workspace |
Ärvda egenskaper
| accept |
|
| api |
|
| credentials | |
| livy |
|
| long |
Tidsgränsen för återförsök i sekunder för tidskrävande åtgärder. Standardvärdet är 30. |
| synapse |
Ärvda metoder
| begin |
Skicka den första begäran om en LRO (tidskrävande åtgärd) och hämta en HttpLongRunningOperationResponse som innehåller metoder för att avsöka LRO och kontrollera om LRO är klar. |
| restore |
Återställ en LROPoller från den angivna LROPollState. Den här metoden kan användas för att återskapa en LROPoller på en annan process eller dator. |
| send |
Tillhandahåller en mekanism för att göra en begäran som ska avsöka och tillhandahålla slutresultatet. |
| send |
Skicka den första begäran om en LRO (tidskrävande åtgärd) och hämta en LROPoller som tillhandahåller metoder för att avsöka LRO och kontrollera om LRO är klar. |
| send |
Skicka en HTTP-begäran som fylls i med den angivna OperationSpec. |
| send |
Skicka angivet httpRequest. |
Konstruktorinformation
SynapseClient(ServiceClientCredentials, SynapseClientOptions)
Initierar en ny instans av klassen SynapseClient.
new SynapseClient(credentials: ServiceClientCredentials, options?: SynapseClientOptions)
Parametrar
- credentials
- ServiceClientCredentials
Autentiseringsuppgifter som krävs för att klienten ska kunna ansluta till Azure.
- options
- SynapseClientOptions
Parameteralternativen
Egenskapsinformation
monitoring
sparkBatch
sparkSession
workspaceAcl
Information om ärvda egenskaper
acceptLanguage
apiVersion
credentials
livyApiVersion
longRunningOperationRetryTimeout
Tidsgränsen för återförsök i sekunder för tidskrävande åtgärder. Standardvärdet är 30.
longRunningOperationRetryTimeout?: number
Egenskapsvärde
number
ärvd frånSynapseClientContext.longRunningOperationRetryTimeout
synapseDnsSuffix
Ärvd metodinformation
beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)
Skicka den första begäran om en LRO (tidskrävande åtgärd) och hämta en HttpLongRunningOperationResponse som innehåller metoder för att avsöka LRO och kontrollera om LRO är klar.
function beginLongRunningRequest(request: RequestPrepareOptions | WebResource, options?: RequestOptionsBase): Promise<LROPoller>
Parametrar
- request
Begärandeobjektet
- options
- RequestOptionsBase
Ytterligare alternativ som ska skickas när begäran skickas
Returer
Promise<@azure/ms-rest-azure-js.LROPoller>
HttpLongRunningOperationResponse som tillhandahåller metoder för att interagera med LRO.
restoreLROPoller(LROPollState)
Återställ en LROPoller från den angivna LROPollState. Den här metoden kan användas för att återskapa en LROPoller på en annan process eller dator.
function restoreLROPoller(lroPollState: LROPollState): LROPoller
Parametrar
- lroPollState
- @azure/ms-rest-azure-js.LROPollState
Returer
sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)
Tillhandahåller en mekanism för att göra en begäran som ska avsöka och tillhandahålla slutresultatet.
function sendLongRunningRequest(request: RequestPrepareOptions | WebResource, options?: RequestOptionsBase): Promise<HttpOperationResponse>
Parametrar
- request
Begärandeobjektet
- options
- RequestOptionsBase
Ytterligare alternativ som ska skickas när begäran skickas
Returer
Promise<HttpOperationResponse>
HttpOperationResponse som innehåller den slutliga avsökningsbegäran, svaret och responseBody.
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)
Skicka den första begäran om en LRO (tidskrävande åtgärd) och hämta en LROPoller som tillhandahåller metoder för att avsöka LRO och kontrollera om LRO är klar.
function sendLRORequest(operationArguments: OperationArguments, operationSpec: OperationSpec, options?: RequestOptionsBase): Promise<LROPoller>
Parametrar
- operationArguments
- OperationArguments
Argumenten för åtgärden.
- operationSpec
- OperationSpec
Specifikationen för åtgärden.
- options
- RequestOptionsBase
Ytterligare alternativ som ska skickas när begäran skickas.
Returer
Promise<@azure/ms-rest-azure-js.LROPoller>
LROPoller-objektet som innehåller metoder för att interagera med LRO.
ärvd frånSynapseClientContext.sendLRORequest
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)
Skicka en HTTP-begäran som fylls i med den angivna OperationSpec.
function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>
Parametrar
- operationArguments
- OperationArguments
Argumenten som HTTP-begärans mallade värden fylls i från.
- operationSpec
- OperationSpec
Den OperationSpec som ska användas för att fylla i httpRequest.
- callback
-
ServiceCallback<any>
Återanropet för att anropa när svaret tas emot.
Returer
Promise<RestResponse>
sendRequest(RequestPrepareOptions | WebResourceLike)
Skicka angivet httpRequest.
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>
Parametrar
- options
Returer
Promise<HttpOperationResponse>
ärvd frånSynapseClientContext.sendRequest