Tworzenie nowej kompilacji usługi Azure DevOps i aktualizowanie jej zmiennych za pomocą interfejsu API REST

Tworzenie nowej kompilacji usługi Azure DevOps i aktualizowanie jej zmiennych za pomocą interfejsu API REST.

Azure DevOps to kompleksowy zestaw narzędzi i usług programistycznych zaprojektowanych, aby pomóc zespołom w szybszym i wydajniejszym tworzeniu i dostarczaniu oprogramowania. Jedną z kluczowych funkcji usługi Azure DevOps jest jej system kompilacji, co pozwala zespołom zautomatyzować kompilację, test, i proces wdrażania ich oprogramowania.

W tym artykule, przyjrzymy się, jak utworzyć nową kompilację Azure DevOps i zaktualizować jej zmienne za pomocą interfejsu API REST. Wykorzystamy przykładowy fragment kodu, który pokazuje, jak utworzyć nową kompilację za pomocą cURL, ale możesz użyć dowolnego języka programowania obsługującego wywołania API REST.

Pierwszym krokiem podczas tworzenia nowej kompilacji Azure DevOps jest zdefiniowanie jej właściwości, takie jak definicja kompilacji i parametry kompilacji. Definicja kompilacji definiuje kroki kompilacji, które mogą obejmować zadania takie jak kompilowanie kodu, przeprowadzanie testów, i tworzenie artefaktów. Parametry kompilacji to zmienne używane w etapach kompilacji w celu dostosowania procesu kompilacji.

Aby utworzyć nową kompilację za pomocą interfejsu API REST, musisz wysłać żądanie POST do Punkt końcowy interfejsu API usługi Azure DevOps, który tworzy kompilacje. Poniższy fragment kodu demonstruje, jak utworzyć nową kompilację przy użyciu 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}\"}"
}'

Przykład działania z 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}\"}"
}'

Podzielmy ten fragment kodu:

• The -X POST flaga określa, że ​​chcemy wysłać żądanie POST.
• Punktem końcowym interfejsu API do tworzenia kompilacji jest https://dev.azure.com/{organizacja}/{projekt}/_apis/kompilacja/kompilacje?wersja API=7.0, Gdzie {organizacja} to twoje imię Azure DevOps organizacja i {projekt} to nazwa twojego projektu. The api-version Parametr określa wersję API, z której chcemy skorzystać.
• The -H "Content-Type: application/json" flaga określa, że ​​w treści żądania wysyłamy dane JSON.
• Treść żądania to obiekt JSON zawierający następujące właściwości:
  • definition: obiekt określający definicję kompilacji. The id Właściwość określa identyfikator definicji kompilacji.
  • parameters: ciąg w formacie JSON, który określa parametry kompilacji. The {parameter_name} I {parameter_value} symbole zastępcze należy zastąpić rzeczywistą nazwą i wartością parametru, odpowiednio.

W przykładowym fragmencie kodu, tworzymy nową kompilację przy użyciu definicji kompilacji z identyfikatorem 15 i aktualizowanie jego NUMBER_OF_WORKERS parametr z wartością zmiennej 2_NUMBER_OF_WORKERS, którą można zastąpić rzeczywistą wartością w czasie wykonywania. Ustawiamy także NUMBER_OF_WORKERS2 parametru na wartość statyczną wynoszącą 5.

Aby zaktualizować zmienną kompilacji za pomocą interfejsu API REST, musisz wysłać żądanie PATCH do punktu końcowego API, który aktualizuje zmienne kompilacji. Poniższy fragment kodu demonstruje, jak zaktualizować zmienną kompilacji za pomocą 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}"
        }
    }
}'

Podzielmy ten fragment kodu:

• The -X PATCH flaga określa, że ​​chcemy wysłać żądanie PATCH.
• Punktem końcowym interfejsu API do aktualizowania zmiennych kompilacji jest `https://dev.azure.com/{organizacja}/{projekt}/_apis/kompilacja/kompilacje/{id_kompilacji}/zmienne?wersja API=7.0