Compartir a través de

Leases - Get Retention Leases By Owner Id

  • Referencia
Service:
Build
API Version:
7.1-preview.2

Devuelve las concesiones que pertenecen a la entidad especificada, que opcionalmente tienen como ámbito una única definición de canalización y se ejecutan.

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 identificador URI

Nombre En Requerido Tipo Description
organization
 path True

string

El nombre de la organización de Azure DevOps.
project
 path True

string

Id. de proyecto o nombre del proyecto
api-version
 query True

string

Versión de la API que se va a usar. Debe establecerse en "7.1-preview.2" para usar esta versión de la API.
definitionId
 query

integer

int32

Parámetro opcional para limitar la búsqueda a una definición de canalización específica.
ownerId
 query

string

runId
 query

integer

int32

Parámetro opcional para limitar la búsqueda a una sola ejecución de canalización. Requiere definitionId.

Respuestas

Nombre Tipo Description
200 OK

RetentionLease[]

operación correcta

Seguridad

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

Nombre Description
vso.build Concede la capacidad de acceder a los artefactos de compilación, incluidos los resultados de compilación, las definiciones y las solicitudes, y la capacidad de recibir notificaciones sobre eventos de compilación a través de enlaces de servicio.

Definiciones

RetentionLease

Una concesión de retención válida impide que los sistemas automatizados eliminen una ejecución de canalización.

Nombre Tipo Description
createdOn

string

Cuando se creó la concesión.
definitionId

integer

Definición de canalización de la ejecución.
leaseId

integer

Identificador único de esta concesión.
ownerId

string

Cadena no única que identifica al propietario de una concesión de retención.
protectPipeline

boolean

Si se establece, esta concesión también impedirá que se elimine la canalización mientras la concesión sigue siendo válida.
runId

integer

La canalización se ejecuta protegida por esta concesión.
validUntil

string

El último día en que el contrato de arrendamiento se considera válido.