Deployment Pipelines - List Deployment Pipeline Stages

Service:

Core

API Version:

v1

Returns the specified deployment pipeline stages.

Required Delegated Scopes

Pipeline.Read.All or Pipeline.ReadWrite.All

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
deploymentPipelineId	path	True	string uuid	The deployment pipeline ID.
continuationToken	query		string	A token for retrieving the next page of results.

Responses

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

Examples

List the deployment pipeline stages example

List the deployment pipeline stages with a continuation token example

List the deployment pipeline stages example

Sample request

HTTP

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

Sample response

Status code:

200

{
  "value": [
    {
      "id": "2e6f0272-e809-410a-be63-50e1d97ba75a",
      "order": 0,
      "displayName": "Development",
      "description": "Design, review, and revise your content in a development workspace. When it's ready to test and preview, deploy the content to the test stage.",
      "workspaceId": "4de5bcc4-2c88-4efe-b827-4ee7b289b496",
      "workspaceName": "Workpsace-Development",
      "isPublic": false
    },
    {
      "id": "d2056166-041c-4a56-8d37-ea90038bc0d6",
      "order": 1,
      "displayName": "Test",
      "description": "Test and verify your content in a preproduction workspace. When it's ready, deploy the content to the production stage.",
      "workspaceId": "44b499cf-1eeb-45e2-9ada-63b6ec9d516e",
      "isPublic": false
    },
    {
      "id": "4c3eb03b-fbbb-4605-9b1a-6fba1003679e",
      "order": 2,
      "displayName": "Production",
      "description": "Your content has been tested and is ready for your customers as an app or by access to the production workspace.",
      "isPublic": true
    }
  ]
}

List the deployment pipeline stages with a continuation token example

Sample request

HTTP

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

Sample response

Status code:

200

{
  "value": [
    {
      "id": "2e6f0272-e809-410a-be63-50e1d97ba75a",
      "order": 0,
      "displayName": "Development",
      "description": "Design, review, and revise your content in a development workspace. When it's ready to test and preview, deploy the content to the test stage.",
      "workspaceId": "4de5bcc4-2c88-4efe-b827-4ee7b289b496",
      "workspaceName": "Workpsace-Development",
      "isPublic": false
    },
    {
      "id": "d2056166-041c-4a56-8d37-ea90038bc0d6",
      "order": 1,
      "displayName": "Test",
      "description": "Test and verify your content in a preproduction workspace. When it's ready, deploy the content to the production stage.",
      "workspaceId": "44b499cf-1eeb-45e2-9ada-63b6ec9d516e",
      "isPublic": false
    },
    {
      "id": "4c3eb03b-fbbb-4605-9b1a-6fba1003679e",
      "order": 2,
      "displayName": "Production",
      "description": "Your content has been tested and is ready for your customers as an app or by access to the production workspace.",
      "isPublic": true
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/deploymentPipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/stages?continuationToken=LDEsMTAwMDAwLDA%3D"
}

Definitions

Name	Description
DeploymentPipelineStage	A Fabric deployment pipeline stage.
DeploymentPipelineStages	A collection of Fabric deployment pipeline stages.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.

DeploymentPipelineStage

A Fabric deployment pipeline stage.

Name	Type	Description
description	string	The deployment pipeline stage description.
displayName	string	The deployment pipeline stage display name.
id	string	The deployment pipeline stage ID.
isPublic	boolean	Indicates whether the deployment pipeline stage is public. True - the stage is public, False - the stage isn't public.
order	integer	The stage order, starting from zero.
workspaceId	string	The assigned workspace ID. Only applicable when there's an assigned workspace.
workspaceName	string	The assigned workspace name. Only applicable when there's an assigned workspace and the user has access to the workspace.

DeploymentPipelineStages

A collection of Fabric deployment pipeline stages.

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	DeploymentPipelineStage[]	The collection of deployment pipeline stages

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.