Leases - Add
Ajoute de nouveaux baux pour les exécutions de pipeline.
POST https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?api-version=7.1-preview.2Paramè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. |
Corps de la demande
| Nom | Type | Description |
|---|---|---|
| body |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
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_execute | Accorde la possibilité d’accéder aux artefacts de build, y compris 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 build via des hooks de service. |
Définitions
| Nom | Description |
|---|---|
|
New |
Informations requises pour créer un bail de rétention. |
|
Retention |
Un bail de rétention valide empêche les systèmes automatisés de supprimer l’exécution d’un pipeline. |
NewRetentionLease
Informations requises pour créer un bail de rétention.
| Nom | Type | Description |
|---|---|---|
| daysValid |
integer |
Nombre de jours pendant lesquels le bail est valide. Un bail de rétention valide pendant plus de 100 ans (36 500 jours) s’affiche comme conservant la build « pour toujours ». |
| definitionId |
integer |
Définition de pipeline de l’exécution. |
| ownerId |
string |
Chaîne fournie par l’utilisateur 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éger. |
RetentionLease
Un bail de rétention valide empêche les systèmes automatisés de supprimer l’exécution d’un pipeline.
| Nom | Type | Description |
|---|---|---|
| createdOn |
string |
Lorsque le bail a été créé. |
| definitionId |
integer |
Définition de 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 |
Le dernier jour où le bail est considéré comme valide. |