Deployment Pipelines - Get Deployment Pipeline

Service:

Core

API Version:

v1

Returns the specified deployment pipeline metadata.

Required Delegated Scopes

Pipeline.Read.All or Pipeline.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	Yes

Interface

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}

URI Parameters

Name	In	Required	Type	Description
deploymentPipelineId	path	True	string uuid	The deployment pipeline ID.

Responses

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

Examples

Get a deployment pipeline example

Sample request

HTTP

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824

Sample response

Status code:

200

{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "Marketing Deployment Pipeline",
  "description": "Fabric deployment pipeline to manage marketing reports"
}

Definitions

Name	Description
DeploymentPipeline	A Fabric deployment pipeline.
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.

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.