Leases - Add
Adds new leases for pipeline runs.
POST https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?api-version=6.0-preview.1
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
project
|
path | True |
string |
Project ID or project name |
api-version
|
query | True |
string |
Version of the API to use. This should be set to '6.0-preview.1' to use this version of the api. |
Request Body
Name | Type | Description |
---|---|---|
body |
Responses
Name | Type | Description |
---|---|---|
200 OK |
successful operation |
Security
accessToken
Personal access token. Use any value for the user name and the token as the password.
Type:
basic
Definitions
Name | Description |
---|---|
New |
|
Retention |
A valid retention lease prevents automated systems from deleting a pipeline run. |
NewRetentionLease
Name | Type | Description |
---|---|---|
daysValid |
integer |
The number of days to consider the lease valid. |
definitionId |
integer |
The pipeline definition of the run. |
ownerId |
string |
User-provided string that identifies the owner of a retention lease. |
protectPipeline |
boolean |
If set, this lease will also prevent the pipeline from being deleted while the lease is still valid. |
runId |
integer |
The pipeline run to protect. |
RetentionLease
A valid retention lease prevents automated systems from deleting a pipeline run.
Name | Type | Description |
---|---|---|
createdOn |
string |
When the lease was created. |
definitionId |
integer |
The pipeline definition of the run. |
leaseId |
integer |
The unique identifier for this lease. |
ownerId |
string |
Non-unique string that identifies the owner of a retention lease. |
runId |
integer |
The pipeline run protected by this lease. |
validUntil |
string |
The last day the lease is considered valid. |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for