NewRetentionLease interface

Package:

azure-devops-extension-api

Required information to create a new retention lease.

Properties

daysValid	The number of days to consider the lease valid. A retention lease valid for more than 100 years (36500 days) will display as retaining the build "forever".
definitionId	The pipeline definition of the run.
ownerId	User-provided string that identifies the owner of a retention lease.
protectPipeline	If set, this lease will also prevent the pipeline from being deleted while the lease is still valid.
runId	The pipeline run to protect.

Property Details

daysValid

The number of days to consider the lease valid. A retention lease valid for more than 100 years (36500 days) will display as retaining the build "forever".

daysValid: number

Property Value

number

definitionId

The pipeline definition of the run.

definitionId: number

Property Value

number

ownerId

User-provided string that identifies the owner of a retention lease.

ownerId: string

Property Value

string

protectPipeline

If set, this lease will also prevent the pipeline from being deleted while the lease is still valid.

protectPipeline: boolean

Property Value

boolean

runId

The pipeline run to protect.

runId: number

Property Value

number