Leases

Retention leases are used to manage the lifetime of pipeline runs beyond the configured retention periods.

Operations

Add

Adds new leases for pipeline runs.

Delete

Removes specific retention leases.

Get

Returns the details of the retention lease given a lease id.

Get Retention Leases By Minimal Retention Leases

Returns any leases matching the specified MinimalRetentionLeases

Get Retention Leases By Owner Id

Returns any leases owned by the specified entity, optionally scoped to a single pipeline definition and run.

Get Retention Leases By User Id

Returns any leases owned by the specified user, optionally scoped to a single pipeline definition and run.

Update

Updates the duration or pipeline protection status of a retention lease.