Microsoft Azure

Azure Synapse Analytics: Spark Job

Azure Synapse Analytics: Spark Job endpoints from Microsoft Azure

Data & analytics#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Azure Synapse Analytics: Spark Job endpoints from Microsoft Azure

Endpoints 13

SparkBatch

  • GETSparkBatch_GetSparkBatchJobs/livyApi/versions/:livyApiVersion/sparkPools/:sparkPoolName/batches?from=0&size=0&detailed=trueList all spark batch jobs which are running under a particular spark pool.
  • POSTSparkBatch_CreateSparkBatchJob/livyApi/versions/:livyApiVersion/sparkPools/:sparkPoolName/batches?detailed=trueCreate new spark batch job.
  • GETSparkBatch_GetSparkBatchJob/livyApi/versions/:livyApiVersion/sparkPools/:sparkPoolName/batches/:batchId?detailed=trueGets a single spark batch job.
  • DELETESparkBatch_CancelSparkBatchJob/livyApi/versions/:livyApiVersion/sparkPools/:sparkPoolName/batches/:batchIdCancels a running spark batch job.

SparkSession

  • GETSparkSession_GetSparkSessions/livyApi/versions/:livyApiVersion/sparkPools/:sparkPoolName/sessions?from=0&size=0&detailed=trueList all spark sessions which are running under a particular spark pool.
  • POSTSparkSession_CreateSparkSession/livyApi/versions/:livyApiVersion/sparkPools/:sparkPoolName/sessions?detailed=trueCreate new spark session.
  • GETSparkSession_GetSparkSession/livyApi/versions/:livyApiVersion/sparkPools/:sparkPoolName/sessions/:sessionId?detailed=trueGets a single spark session.
  • DELETESparkSession_CancelSparkSession/livyApi/versions/:livyApiVersion/sparkPools/:sparkPoolName/sessions/:sessionIdCancels a running spark session.
  • PUTSparkSession_ResetSparkSessionTimeout/livyApi/versions/:livyApiVersion/sparkPools/:sparkPoolName/sessions/:sessionId/reset-timeoutSends a keep alive call to the current session to reset the session timeout.
  • GETSparkSession_GetSparkStatements/livyApi/versions/:livyApiVersion/sparkPools/:sparkPoolName/sessions/:sessionId/statementsGets a list of statements within a spark session.
  • POSTSparkSession_CreateSparkStatement/livyApi/versions/:livyApiVersion/sparkPools/:sparkPoolName/sessions/:sessionId/statementsCreate statement within a spark session.
  • GETSparkSession_GetSparkStatement/livyApi/versions/:livyApiVersion/sparkPools/:sparkPoolName/sessions/:sessionId/statements/:statementIdGets a single statement within a spark session.
  • POSTSparkSession_CancelSparkStatement/livyApi/versions/:livyApiVersion/sparkPools/:sparkPoolName/sessions/:sessionId/statements/:statementId/cancelKill a statement within a session.

API details

Authentication
None declared in the description
Operations
13 operations on 8 pathsGET 6POST 4DELETE 2PUT 1
Main resources
SparkSession 9SparkBatch 4
Response formats
application/json
Description format
Swagger 2.0, API version 2020-12-01

How to test the Azure Synapse Analytics: Spark Job in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Synapse Analytics: Spark Job collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “SparkBatch_GetSparkBatchJobs” (GET /livyApi/versions/:livyApiVersion/sparkPools/:sparkPoolName/batches?from=0&size=0&detailed=true), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Synapse Analytics: Spark Job?

Azure Synapse Analytics: Spark Job endpoints from Microsoft Azure It is listed under Data & analytics and has 13 endpoints.

Who publishes the Azure Synapse Analytics: Spark Job?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Azure Synapse Analytics: Spark Job?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Azure Synapse Analytics: Spark Job have?

13 operations on 8 paths (6 GET, 4 POST, 2 DELETE, 1 PUT). The largest groups are SparkSession, SparkBatch.

Is forking the Azure Synapse Analytics: Spark Job free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.