Pipelines

Operations

Assign Workspace

Assigns the specified workspace to the specified deployment pipeline stage.

Required scope

Pipeline.ReadWrite.All and Workspace.ReadWrite.All

Limitations

  • The specified deployment pipeline stage is not already assigned.
  • You must be an admin of the specified workspace.
  • The specified workspace is not assigned to any other deployment pipeline.
  • This operation will fail if there's an active deployment operation.
Create Pipeline

Creates a new deployment pipeline.

Required scope

Pipeline.ReadWrite.All

Delete Pipeline

Deletes the specified deployment pipeline.

Required scope

Pipeline.ReadWrite.All

Limitations

This operation will fail if there's an active deployment operation.

Delete Pipeline User

Removes user permissions from the specified deployment pipeline.

Required scope

Pipeline.ReadWrite.All

Deploy All

Deploys all supported items from the source stage of the specified deployment pipeline.

To learn about items that aren't supported in deployment pipelines, see Unsupported items.

Permissions

The user must at least be a member on both source and target deployment workspaces. For more information, see Permissions.

Required scope

Pipeline.Deploy

Limitations

Maximum 300 deployed items per request.

Get Pipeline

Returns the specified deployment pipeline.

Required scope

Pipeline.ReadWrite.All or Pipeline.Read.All

Get Pipeline Operation

Returns the details of the specified deploy operation performed on the specified deployment pipeline, including the deployment execution plan.

Use to track the status of a deploy operation.

Required scope

Pipeline.ReadWrite.All or Pipeline.Read.All

Get Pipeline Operations

Returns a list of the up-to-20 most recent deploy operations performed on the specified deployment pipeline.

Required scope

Pipeline.ReadWrite.All or Pipeline.Read.All

Get Pipelines

Returns a list of deployment pipelines that the user has access to.

Required scope

Pipeline.Read.All or Pipeline.ReadWrite.All

Get Pipeline Stage Artifacts

Returns the supported items from the workspace assigned to the specified stage of the specified deployment pipeline.

To learn about items that aren't supported in deployment pipelines, see Unsupported items.

Permissions

The user must at least be a contributor on the workspace assigned to the specified stage. For more information, see Permissions.

Required scope

Pipeline.ReadWrite.All or Pipeline.Read.All

Get Pipeline Stages

Returns the stages of the specified deployment pipeline.

Required scope

Pipeline.ReadWrite.All or Pipeline.Read.All

Get Pipeline Users

Returns a list of users that have access to the specified deployment pipeline.

Required scope

Pipeline.ReadWrite.All or Pipeline.Read.All

Selective Deploy

Deploys the specified items from the source stage of the specified deployment pipeline.

Permissions

The user must at least be a member on both source and target deployment workspaces. For more information, see Permissions.

Required scope

Pipeline.Deploy

Limitations

Maximum 300 deployed items per request.

Unassign Workspace

Unassigns the workspace from the specified stage in the specified deployment pipeline.

Required scope

Pipeline.ReadWrite.All

Limitations

This operation will fail if there's an active deployment operation.

Update Pipeline

Updates the specified deployment pipeline.

Required scope

Pipeline.ReadWrite.All

Update Pipeline User

Grants user permissions to the specified deployment pipeline.

Required scope

Pipeline.ReadWrite.All