Edit

Share via

Deployment Pipelines - Update Deployment Pipeline

Service:
Core
API Version:
v1

Updates the properties of the specified deployment pipeline.

Permissions

The caller must have an admin deployment pipelines role.

Required Delegated Scopes

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

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

URI Parameters

Name In Required Type Description
deploymentPipelineId
 path True

string (uuid)

The deployment pipeline ID.

Request Body

Name Type Description
description

string

maxLength: 1024

The description for the deployment pipeline.
The description cannot contain more than 1024 characters.
displayName

string

maxLength: 256

The display name for the deployment pipeline.
The display name cannot contain more than 256 characters.

Responses

Name Type Description
200 OK

DeploymentPipelineExtendedInfo

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • UnknownError - An error occurred

Examples

Update a deployment pipeline example

Sample request

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

{
  "displayName": "Updated Deployment Pipeline Name",
  "description": "Updated deployment pipeline description"
}

Sample response

Status code:
200 
{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "Updated Deployment Pipeline Name",
  "description": "Updated deployment pipeline description",
  "stages": [
    {
      "id": "2e6f0272-e809-410a-be63-50e1d97ba75a",
      "order": 0,
      "displayName": "Development",
      "description": "Development stage description",
      "isPublic": false
    },
    {
      "id": "d2056166-041c-4a56-8d37-ea90038bc0d6",
      "order": 1,
      "displayName": "Test",
      "description": "Test stage description",
      "isPublic": false
    },
    {
      "id": "4c3eb03b-fbbb-4605-9b1a-6fba1003679e",
      "order": 2,
      "displayName": "Production",
      "description": "Production stage description",
      "isPublic": true
    }
  ]
}

Definitions

Name Description
DeploymentPipelineExtendedInfo

A Fabric deployment pipeline.
DeploymentPipelineStage

A Fabric deployment pipeline stage.
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
UpdateDeploymentPipelineRequest

A request to update an existing deployment pipeline. An updated display name and/or a description is required.

DeploymentPipelineExtendedInfo

Object

A Fabric deployment pipeline.

Name Type Description
description

string

The deployment pipeline description.
displayName

string

The deployment pipeline display name.
id

string (uuid)

The deployment pipeline ID.
stages

DeploymentPipelineStage[]

The collection of deployment pipeline stages.

DeploymentPipelineStage

Object

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 (uuid)

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 (uuid)

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.

ErrorRelatedResource

Object

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

Object

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

Object

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.

UpdateDeploymentPipelineRequest

Object

A request to update an existing deployment pipeline. An updated display name and/or a description is required.

Name Type Description
description

string

maxLength: 1024

The description for the deployment pipeline.
The description cannot contain more than 1024 characters.
displayName

string

maxLength: 256

The display name for the deployment pipeline.
The display name cannot contain more than 256 characters.