Microsoft Azure

Azure Synapse Analytics: Pipelines

Azure Synapse Analytics: Pipelines 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: Pipelines endpoints from Microsoft Azure

Endpoints 10

pipelines

  • GETPipeline_GetPipelinesByWorkspace/pipelines?api-version=stringLists pipelines.
  • GETPipeline_GetPipeline/pipelines/:pipelineName?api-version=stringGets a pipeline.
  • PUTPipeline_CreateOrUpdatePipeline/pipelines/:pipelineName?api-version=stringCreates or updates a pipeline.
  • DELETEPipeline_DeletePipeline/pipelines/:pipelineName?api-version=stringDeletes a pipeline.
  • POSTPipeline_RenamePipeline/pipelines/:pipelineName/rename?api-version=stringRenames a pipeline.
  • POSTPipeline_CreatePipelineRun/pipelines/:pipelineName/createRun?api-version=string&referencePipelineRunId=string&isRecovery=true&startActivityName=stringCreates a run of a pipeline.

pipelineruns

  • POSTPipelineRun_QueryPipelineRunsByWorkspace/queryPipelineRuns?api-version=stringQuery pipeline runs in the workspace based on input filter conditions.
  • GETPipelineRun_GetPipelineRun/pipelineruns/:runId?api-version=stringGet a pipeline run by its run ID.
  • POSTPipelineRun_CancelPipelineRun/pipelineruns/:runId/cancel?isRecursive=true&api-version=stringCancel a pipeline run by its run ID.

activityruns

  • POSTPipelineRun_QueryActivityRuns/pipelines/:pipelineName/pipelineruns/:runId/queryActivityruns?api-version=stringQuery activity runs based on input filter conditions.

API details

Authentication
None declared in the description
Operations
10 operations on 8 pathsPOST 5GET 3PUT 1DELETE 1
Main resources
pipelines 6pipelineruns 3activityruns 1
Response formats
application/json
Description format
Swagger 2.0, API version 2020-12-01

How to test the Azure Synapse Analytics: Pipelines 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: Pipelines 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 “Pipeline_GetPipelinesByWorkspace” (GET /pipelines?api-version=string), 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: Pipelines?

Azure Synapse Analytics: Pipelines endpoints from Microsoft Azure It is listed under Data & analytics and has 10 endpoints.

Who publishes the Azure Synapse Analytics: Pipelines?

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: Pipelines?

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: Pipelines have?

10 operations on 8 paths (5 POST, 3 GET, 1 PUT, 1 DELETE). The largest groups are pipelines, pipelineruns, activityruns.

Is forking the Azure Synapse Analytics: Pipelines 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.