Een nieuwe Azure DevOps-build maken en de variabelen ervan bijwerken met REST API.
Azure DevOps is een uitgebreide suite met ontwikkelingstools en -services die zijn ontworpen om teams te helpen sneller en efficiënter software te bouwen en te verzenden. Een van de belangrijkste kenmerken van Azure DevOps is het buildsysteem, waarmee teams de build kunnen automatiseren, test, en implementatieproces van hun software.
In dit artikel, we zullen onderzoeken hoe je een nieuwe Azure DevOps-build kunt maken en de variabelen ervan kunt bijwerken met behulp van REST API. We zullen een voorbeeldcodefragment gebruiken dat laat zien hoe u een nieuwe build kunt maken met behulp van cURL, maar u kunt elke programmeertaal gebruiken die REST API-aanroepen ondersteunt.
De eerste stap bij het maken van een nieuwe Azure DevOps-build is het definiëren van de eigenschappen ervan, zoals de builddefinitie en de buildparameters. De builddefinitie definieert de buildstappen, Dit kan taken omvatten zoals het compileren van code, testen uitvoeren, en het creëren van artefacten. De bouwparameters zijn variabelen die door de bouwstappen worden gebruikt om het bouwproces aan te passen.
Om een nieuwe build te maken met behulp van de REST API, u moet een POST-verzoek sturen naar de Azure DevOps API-eindpunt dat builds maakt. Het volgende codefragment laat zien hoe u een nieuwe build maakt met behulp van cURL:
curl -X POST "https://dev.azure.com/{organization}/{project}/_apis/build/builds?api-version=7.0" \
-H "Content-Type: application/json" \
-d '{
"definition": {
"id": {definition_id}
},
"parameters": "{\"{parameter_name}\":\"{parameter_value}\"}"
}'
Werkvoorbeeld met PAT:
curl -X POST "https://{username}:{PAT}@dev.azure.com/{organization}/{project}/_apis/build/builds?api-version=7.0" \
-H "Content-Type: application/json" \
-d '{
"definition": {
"id": {definition_id}
},
"parameters": "{\"{parameter_name}\":\"{parameter_value}\"}"
}'
Laten we dit codefragment opsplitsen:
- De
-X POST
flag geeft aan dat we een POST-verzoek willen verzenden. - Het API-eindpunt voor het maken van builds is https://dev.azure.com/{organisatie}/{project}/_apis/build/builds?API-versie=7.0, waar {organisatie} is de naam van jouw Azure DevOps organisatie en {project} is de naam van uw project. De
api-version
parameter specificeert de versie van de API die we willen gebruiken. - De
-H "Content-Type: application/json"
flag geeft aan dat we JSON-gegevens verzenden in de verzoektekst. - De aanvraagtekst is een JSON-object dat de volgende eigenschappen bevat:
definition
: een object dat de builddefinitie specificeert. Deid
eigenschap specificeert de ID van de builddefinitie.parameters
: een JSON-geformatteerde tekenreeks die de buildparameters specificeert. De{parameter_name}
En{parameter_value}
tijdelijke aanduidingen moeten worden vervangen door de werkelijke parameternaam en -waarde, respectievelijk.
In het voorbeeldcodefragment, we maken een nieuwe build met behulp van de builddefinitie met ID 15 en het bijwerken ervan NUMBER_OF_WORKERS
parameter met de waarde van een variabele 2_NUMBER_OF_WORKERS
, die tijdens runtime kan worden vervangen door een werkelijke waarde. Wij stellen ook de NUMBER_OF_WORKERS2
parameter naar een statische waarde van 5.
Een buildvariabele bijwerken met behulp van de REST API, u moet een PATCH-verzoek sturen naar het API-eindpunt dat de buildvariabelen bijwerkt. Het volgende codefragment laat zien hoe u een buildvariabele bijwerkt met behulp van cURL:
curl -X PATCH "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{build_id}/variables?api-version=7.0" \
-H "Content-Type: application/json" \
-d '{
"variables": {
"{variable_name}": {
"value": "{new_value}"
}
}
}'
Laten we dit codefragment opsplitsen:
- De
-X PATCH
flag geeft aan dat we een PATCH-verzoek willen verzenden. - Het API-eindpunt voor het bijwerken van buildvariabelen is `https://dev.azure.com/{organisatie}/{project}/_apis/build/builds/{build_id}/variabelen?API-versie=7.0