Leases - Get Retention Leases By Owner Id

Référence

Service:: Build

API Version:: 7.1-preview.2

Retourne tous les baux appartenant à l’entité spécifiée, éventuellement limités à une définition de pipeline unique et à une exécution.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
project	path	True	string	ID de projet ou nom du projet
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.2 » pour utiliser cette version de l’API.
definitionId	query		integer int32	Paramètre facultatif pour limiter la recherche à une définition de pipeline spécifique.
ownerId	query		string
runId	query		integer int32	Paramètre facultatif pour limiter la recherche à une seule exécution de pipeline. Nécessite definitionId.

Réponses

Nom	Type	Description
200 OK	RetentionLease[]	opération réussie

Sécurité

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

Nom	Description
vso.build	Accorde la possibilité d’accéder aux artefacts de build, y compris les résultats de build, les définitions et les demandes, et la possibilité de recevoir des notifications sur les événements de build via des hooks de service.

Définitions

RetentionLease

Un bail de rétention valide empêche les systèmes automatisés de supprimer une exécution de pipeline.

Nom	Type	Description
createdOn	string	Lorsque le bail a été créé.
definitionId	integer	Définition du pipeline de l’exécution.
leaseId	integer	Identificateur unique de ce bail.
ownerId	string	Chaîne non unique qui identifie le propriétaire d’un bail de rétention.
protectPipeline	boolean	S’il est défini, ce bail empêche également la suppression du pipeline tant que le bail est toujours valide.
runId	integer	Exécution du pipeline protégée par ce bail.
validUntil	string	Dernier jour où le bail est considéré comme valide.

Partager via