Compartilhar via

Leases - Get Retention Leases By Owner Id

  • Referência
Service:
Build
API Version:
7.1-preview.2

Retorna quaisquer concessões pertencentes à entidade especificada, opcionalmente com escopo para uma única definição de pipeline e execução.

GET https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?api-version=7.1-preview.2
With optional parameters: 
GET https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?ownerId={ownerId}&definitionId={definitionId}&runId={runId}&api-version=7.1-preview.2

Parâmetros de URI

Nome Em Obrigatório Tipo Description
organization
 path True

string

O nome da organização do Azure DevOps.
project
 path True

string

ID do projeto ou nome do projeto
api-version
 query True

string

Versão da API a ser usada. Isso deve ser definido como '7.1-preview.2' para usar essa versão da API.
definitionId
 query

integer

int32

Um parâmetro opcional para limitar a pesquisa a uma definição de pipeline específica.
ownerId
 query

string

runId
 query

integer

int32

Um parâmetro opcional para limitar a pesquisa a uma única execução de pipeline. Requer definitionId.

Respostas

Nome Tipo Description
200 OK

RetentionLease[]

operação bem-sucedida

Segurança

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

Nome Description
vso.build Concede a capacidade de acessar artefatos de build, incluindo resultados de build, definições e solicitações e a capacidade de receber notificações sobre eventos de build por meio de ganchos de serviço.

Definições

RetentionLease

Uma concessão de retenção válida impede que sistemas automatizados excluam uma execução de pipeline.

Nome Tipo Description
createdOn

string

Quando a concessão foi criada.
definitionId

integer

A definição de pipeline da execução.
leaseId

integer

O identificador exclusivo dessa concessão.
ownerId

string

Cadeia de caracteres não exclusiva que identifica o proprietário de uma concessão de retenção.
protectPipeline

boolean

Se definida, essa concessão também impedirá que o pipeline seja excluído enquanto a concessão ainda for válida.
runId

integer

O pipeline é executado protegido por essa concessão.
validUntil

string

O último dia em que a concessão é considerada válida.