Deployment Pipelines - List Deployment Pipelines

Service:

Core

API Version:

v1

Returns a list of deployment pipelines the user can access.

Required Delegated Scopes

Pipeline.Read.All or Pipeline.ReadWrite.All

GET https://api.fabric.microsoft.com/v1/deploymentPipelines

With optional parameters:

GET https://api.fabric.microsoft.com/v1/deploymentPipelines?continuationToken={continuationToken}

URI Parameters

Name	In	Required	Type	Description
continuationToken	query		string	A token for retrieving the next page of results.

Responses

Name	Type	Description
200 OK	DeploymentPipelines	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: UnknownError - An error occurred.

Examples

List deployment pipelines example

List deployment pipelines with continuation example

List deployment pipelines example

Sample request

HTTP

GET https://api.fabric.microsoft.com/v1/deploymentPipelines

Sample response

Status code:

200

{
  "value": [
    {
      "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
      "displayName": "Marketing Deployment Pipeline",
      "description": "Fabric deployment pipeline to manage marketing reports."
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance Deployment Pipeline",
      "description": "Fabric deployment pipeline to manage finance reports."
    }
  ]
}

List deployment pipelines with continuation example

Sample request

HTTP

GET https://api.fabric.microsoft.com/v1/deploymentPipelines

Sample response

Status code:

200

{
  "value": [
    {
      "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
      "displayName": "Marketing Deployment Pipeline",
      "description": "Fabric deployment pipeline to manage marketing reports."
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance Deployment Pipeline",
      "description": "Fabric deployment pipeline to manage finance reports."
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/deploymentPipelines?continuationToken=LDEsMTAwMDAwLDA%3D"
}

Definitions

Name	Description
DeploymentPipeline	A Fabric deployment pipeline.
DeploymentPipelines	A collection of Fabric deployment pipelines.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.

DeploymentPipeline

A Fabric deployment pipeline.

Name	Type	Description
description	string	The deployment pipeline description.
displayName	string	The deployment pipeline display name.
id	string	The deployment pipeline ID.

DeploymentPipelines

A collection of Fabric deployment pipelines.

Name	Type	Description
continuationToken	string	The token for the next result set batch. If there are no more records, it's removed from the response.
continuationUri	string	The URI of the next result set batch. If there are no more records, it's removed from the response.
value	DeploymentPipeline[]	A collection of deployment pipelines.

ErrorRelatedResource

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.