Leases - Update
Met à jour la durée ou l’état de protection du pipeline d’un bail de rétention.
PATCH https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases/{leaseId}?api-version=7.1Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
lease
|
path | True |
integer (int32) |
ID du bail à mettre à jour. |
|
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 » pour utiliser cette version de l’API. |
Corps de la demande
| Nom | Type | Description |
|---|---|---|
| daysValid |
integer (int32) |
Nombre de jours à prendre en compte le bail valide. Un bail de rétention valide pendant plus de 100 ans (36500 jours) s’affiche comme conservant la build « pour toujours ». |
| protectPipeline |
boolean |
S’il est défini, ce bail empêche également la suppression du pipeline pendant que le bail est toujours valide. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
opération réussie |
Sécurité
oauth2
Type:
oauth2
Flux:
accessCode
URL d’autorisation:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton:
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
Étendues
| Nom | Description |
|---|---|
| vso.build_execute | Accorde la possibilité d’accéder aux artefacts de build, notamment les résultats de build, les définitions et les demandes, ainsi que la possibilité de mettre en file d’attente une build, de mettre à jour les propriétés de build et de recevoir des notifications sur les événements de génération via des hooks de service. |
Définitions
| Nom | Description |
|---|---|
|
Retention |
Un bail de rétention valide empêche les systèmes automatisés de supprimer une exécution de pipeline. |
|
Retention |
Mise à jour des paramètres de rétention d’un bail de rétention. |
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 (date-time) |
Lorsque le bail a été créé. |
| definitionId |
integer (int32) |
Définition du pipeline de l’exécution. |
| leaseId |
integer (int32) |
Identificateur unique pour 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 pendant que le bail est toujours valide. |
| runId |
integer (int32) |
Le pipeline est protégé par ce bail. |
| validUntil |
string (date-time) |
Le dernier jour où le bail est considéré comme valide. |
RetentionLeaseUpdate
Mise à jour des paramètres de rétention d’un bail de rétention.
| Nom | Type | Description |
|---|---|---|
| daysValid |
integer (int32) |
Nombre de jours à prendre en compte le bail valide. Un bail de rétention valide pendant plus de 100 ans (36500 jours) s’affiche comme conservant la build « pour toujours ». |
| protectPipeline |
boolean |
S’il est défini, ce bail empêche également la suppression du pipeline pendant que le bail est toujours valide. |