Leases - Get Retention Leases By Owner Id
필요에 따라 단일 파이프라인 정의로 범위가 지정된 지정된 엔터티가 소유한 임대를 반환하고 실행합니다.
GET https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?api-version=7.1-preview.2
GET https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?ownerId={ownerId}&definitionId={definitionId}&runId={runId}&api-version=7.1-preview.2
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
organization
|
path | True |
string |
Azure DevOps 조직의 이름입니다. |
project
|
path | True |
string |
프로젝트 ID 또는 프로젝트 이름 |
api-version
|
query | True |
string |
사용할 API의 버전입니다. 이 API 버전을 사용하려면 '7.1-preview.2'로 설정해야 합니다. |
definition
|
query |
integer int32 |
검색을 특정 파이프라인 정의로 제한하는 선택적 매개 변수입니다. |
|
owner
|
query |
string |
||
run
|
query |
integer int32 |
검색을 단일 파이프라인 실행으로 제한하는 선택적 매개 변수입니다. definitionId가 필요합니다. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
성공적인 작업 |
보안
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Scopes
Name | Description |
---|---|
vso.build | 빌드 결과, 정의 및 요청을 포함하여 빌드 아티팩트 액세스 기능과 서비스 후크를 통해 빌드 이벤트에 대한 알림을 받을 수 있는 기능을 부여합니다. |
정의
RetentionLease
유효한 보존 임대는 자동화된 시스템이 파이프라인 실행을 삭제하는 것을 방지합니다.
Name | 형식 | Description |
---|---|---|
createdOn |
string |
임대를 만든 경우. |
definitionId |
integer |
실행의 파이프라인 정의입니다. |
leaseId |
integer |
이 임대의 고유 식별자입니다. |
ownerId |
string |
보존 임대의 소유자를 식별하는 고유하지 않은 문자열입니다. |
protectPipeline |
boolean |
이 임대를 설정하면 임대가 여전히 유효한 동안 파이프라인이 삭제되지 않습니다. |
runId |
integer |
이 임대로 보호되는 파이프라인 실행입니다. |
validUntil |
string |
임대가 유효한 것으로 간주되는 마지막 날입니다. |