Skip to content

deployment-pipeline

Manage deployment pipelines (CI/CD stages, deploy items)

Authentication scope: fabric

List deployment pipelines

Terminal window
fabio deployment-pipeline list

Read-only · Returns list

Show details of a deployment pipeline

Terminal window
fabio deployment-pipeline show --id <value>
Flag Type Required Description
--id string Yes Deployment pipeline ID

Read-only · Returns object

Create a new deployment pipeline

Terminal window
fabio deployment-pipeline create --name <value>
Flag Type Required Description
--name string Yes Display name
--description string No Optional description
--stage string No A pipeline stage (repeatable, ordered). Each value is a stage display name, optionally suffixed with :public to make it a public stage (e.g. --stage Development --stage Test --stage Production:public)
--stages-json string No Full stages definition as JSON (overrides –stage): an array of {"displayName","description"?,"isPublic"?} (inline, @file, or stdin)

Examples

Terminal window
fabio deployment-pipeline create --name "Analytics Pipeline"

Mutates state · Returns object

Update a deployment pipeline

Terminal window
fabio deployment-pipeline update --id <value>
Flag Type Required Description
--id string Yes Deployment pipeline ID
--name string No New display name
--description string No New description

Mutates state · Returns object

Delete a deployment pipeline

Terminal window
fabio deployment-pipeline delete --id <value>
Flag Type Required Description
--id string Yes Deployment pipeline ID

Mutates state · Destructive · Returns void

List stages in a deployment pipeline

Terminal window
fabio deployment-pipeline list-stages --id <value>
Flag Type Required Description
--id string Yes Deployment pipeline ID

Read-only · Returns list

List items in a deployment pipeline stage

Terminal window
fabio deployment-pipeline list-stage-items --id <value> --stage-id <value>
Flag Type Required Description
--id string Yes Deployment pipeline ID
--stage-id string Yes Stage ID

Read-only · Returns list

Assign a workspace to a deployment pipeline stage

Terminal window
fabio deployment-pipeline assign-workspace --id <value> --stage-id <value> --workspace <value>
Flag Type Required Description
--id string Yes Deployment pipeline ID
--stage-id string Yes Stage ID to assign the workspace to
--workspace string Yes Workspace ID

Examples

Terminal window
fabio deployment-pipeline assign-workspace --id $DP --stage-id $DEV_STAGE --workspace $DEV_WS

Mutates state · Returns object

Unassign the workspace from a deployment pipeline stage

Terminal window
fabio deployment-pipeline unassign-workspace --id <value> --stage-id <value>
Flag Type Required Description
--id string Yes Deployment pipeline ID
--stage-id string Yes Stage ID to unassign

Mutates state · Returns void

List deploy operations for a deployment pipeline

Terminal window
fabio deployment-pipeline list-operations --id <value>
Flag Type Required Description
--id string Yes Deployment pipeline ID

Read-only · Returns list

Show details of a deploy operation

Terminal window
fabio deployment-pipeline show-operation --id <value> --operation-id <value>
Flag Type Required Description
--id string Yes Deployment pipeline ID
--operation-id string Yes Operation ID

Read-only · Returns object

List role assignments for a deployment pipeline

Terminal window
fabio deployment-pipeline list-role-assignments --id <value>
Flag Type Required Description
--id string Yes Deployment pipeline ID

Read-only · Returns list

Add a role assignment to a deployment pipeline

Terminal window
fabio deployment-pipeline add-role-assignment --id <value> --principal-id <value> --principal-type <value> --role <value>
Flag Type Required Description
--id string Yes Deployment pipeline ID
--principal-id string Yes Principal ID
--principal-type string Yes Principal type (e.g. User, Group, ServicePrincipal)
--role string Yes Role (e.g. Admin, Contributor, Viewer)

Mutates state · Returns object

Delete a role assignment from a deployment pipeline

Terminal window
fabio deployment-pipeline delete-role-assignment --id <value> --principal-id <value>
Flag Type Required Description
--id string Yes Deployment pipeline ID
--principal-id string Yes Principal ID to remove

Mutates state · Destructive · Returns void

Show details of a deployment pipeline stage

Terminal window
fabio deployment-pipeline show-stage --id <value> --stage-id <value>
Flag Type Required Description
--id string Yes Deployment pipeline ID
--stage-id string Yes Stage ID

Read-only · Returns object

Update a deployment pipeline stage configuration

Terminal window
fabio deployment-pipeline update-stage --id <value> --stage-id <value>
Flag Type Required Description
--id string Yes Deployment pipeline ID
--stage-id string Yes Stage ID
--file string No Path to JSON file with stage configuration
--content string No Inline JSON content with stage configuration

Mutates state · Returns void

Deploy items from one stage to another

Terminal window
fabio deployment-pipeline deploy --id <value> --source-stage-id <value>
Flag Type Required Description
--id string Yes Deployment pipeline ID
--source-stage-id string Yes Source stage ID
--target-stage-id string No Target stage ID (if omitted, deploys to the next stage)
--items string No Items to deploy as JSON array (if omitted, all items are deployed). Example: ‘[{“itemId”:“…”,“itemType”:“Notebook”}]’
--note string No Optional note for this deployment

Examples

Terminal window
fabio deployment-pipeline deploy --id $DP --source-stage $DEV_STAGE --target-stage $PROD_STAGE --wait
Terminal window
fabio deployment-pipeline deploy --id $DP --source-stage $DEV_STAGE --items '[{"itemId":"abc","itemType":"Notebook"}]'

Mutates state · Long-running operation · Returns object