InvokeRESTAPI@0 – REST API v0-feladat meghívása

Ezzel a feladatsal meghívhat egy REST API-t a folyamat részeként.

Syntax

# Invoke REST API v0
# Invoke REST API as a part of your process.
- task: InvokeRESTAPI@0
  inputs:
    serviceConnection: # string. Alias: connectedServiceName. Required. Generic endpoint. 
    method: 'POST' # 'OPTIONS' | 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'TRACE' | 'PATCH'. Required. Method. Default: POST.
    #headers: # string. Headers. 
    #body: '{"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}' # string. Optional. Use when method != GET && method != HEAD. Body. Default: {"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}.
    #urlSuffix: # string. Url suffix string. 
  # Completion Options
    waitForCompletion: 'false' # 'true' | 'false'. Required. Complete based on. Default: false.
    #successCriteria: # string. Optional. Use when waitForCompletion = false. Success criteria.

Bevitelek

serviceConnection - Általános végpont
Bemeneti alias: connectedServiceName. string. Kötelező.

Megadja azt az általános szolgáltatáskapcsolatot, amely a baseURL híváshoz és a tevékenységhez használható engedélyezést biztosítja.

method - Módszer
string. Kötelező. Engedélyezett értékek: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE. PATCH Alapértelmezett érték: POST.

Meghatározza az API-t meghívó HTTP-metódust.

headers - Fejlécek
string. Alapértelmezett érték: {\n"Content-Type":"application/json"\n}.

A fejlécet JSON formátumban határozza meg. A fejléc az API-nak küldött kérelemhez van csatolva.

body - Szervezet
string. Választható. Használja a következőt: method != GET && method != HEAD. Alapértelmezett érték: {"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}.

A függvényhívás kérelemtörzsét adja meg JSON formátumban.

urlSuffix - URL-utótag sztringje
string.

Megadja azt a sztringet, amely hozzáfűzendő a baseUrlhoz az általános szolgáltatáskapcsolatból a HTTP-hívás végrehajtása során.

Példa: Ha a szolgáltatáskapcsolat URL-címe és https:...TestProj/_apis/Release/releases az URL-utótag, /2/environments/1a szolgáltatáskapcsolat URL-címe lesz https:.../TestProj/_apis/Release/releases/2/environments/1. Ha az URL-utótag a ?definitionId=1&releaseCount=1, akkor a szolgáltatáskapcsolat URL-címe lesz https//...TestProj/_apis/Release/releases?definitionId=1&releaseCount=1.

waitForCompletion - Kész a
string. Kötelező. Engedélyezett értékek: true (Visszahívás), false (ApiResponse). Alapértelmezett érték: false.

Meghatározza, hogy a tevékenység hogyan fejeződik be. Az engedélyezett értékek a következők:

• false - API-válasz: Azt jelenti, hogy a függvény 20 másodpercen belül sikeres eredményt ad vissza, és a sikerességi feltétel igaz értéket ad vissza.
• true - Visszahívás: Azt jelenti, hogy a külső szolgáltatás visszahívást végez az idősorrekord frissítéséhez.

successCriteria - Sikerességi feltételek
string. Választható. Használja a következőt: waitForCompletion = false.

Meghatározza a feladat sikerességi feltételeit. A válasz tartalma nem befolyásolja az eredményt, ha nincs megadva feltétel. Alapértelmezés szerint a feladat akkor halad át, amikor a hívás visszatér 200 OK.

Példa: Válasz esetén {"status" : "successful"}a kifejezés lehet eq(root['status'], 'successful'). További információ a feltételek megadásáról.

Feladatvezérlési lehetőségek

Minden feladathoz tartoznak vezérlési lehetőségek is a feladat bemenetei mellett. További információ: Vezérlési beállítások és gyakori feladattulajdonságok.

Kimeneti változók

Nincsenek.

Megjegyzések

Megjegyzés

Ez a feladat csak ügynök nélküli feladatokban használható.

Sikeres, ha az API sikert ad vissza, és a választörzs elemzése sikeres, vagy ha az API sikeresen frissíti az idősorrekordot.

A REST API meghívása feladat nem hajt végre közvetlenül üzembehelyezési műveleteket. Ehelyett lehetővé teszi, hogy bármilyen általános HTTP REST API-t meghívjon az automatizált folyamat részeként, és opcionálisan várja meg, amíg befejeződik.

A feladat használatáról további információt a Jóváhagyások és kapuk áttekintése című témakörben talál.

Milyen alap URL-címeket használ a rendszer az Azure Management API-k meghívásakor?

Az Azure management API-k meghívása a kiválasztott környezet ResourceManagerEndpoint használatával történik. Például https://management.Azure.com akkor használatos, ha az előfizetés AzureCloud-környezetben van.

Hol jelezzen a feladat befejezést, ha a visszahívást választja a befejezési eseményként?

A befejezés jelzéséhez a külső szolgáltatásnak POST befejezési adatokat kell elküldenie a következő folyamatok REST-végpontjára.

{planUri}/{projectId}/_apis/distributedtask/hubs/{hubName}/plans/{planId}/events?api-version=2.0-preview.1

**Request Body**
 { "name": "TaskCompleted", "taskId": "taskInstanceId", "jobId": "jobId", "result": "succeeded" }

A részletekért tekintse meg ezt az egyszerű parancsmagalkalmazást .

Emellett rendelkezésre áll egy C#-segédtár, amely lehetővé teszi az ügynök nélküli tevékenységek élő naplózását és feladatállapotának kezelését. További információ

Használhatom a választörzset egy másik feladat bemeneteként?

Nem, mivel ez a feladat ügynök nélküli tevékenység, és a TFS belső HttpRequestjét használja, amely nem adja vissza a HTTP-kérés tartalmát.

Követelmények

Követelmény	Leírás
Folyamattípusok	YAML, klasszikus build, klasszikus kiadás
Futtatás	Kiszolgáló, ServerGate
Igények	None
Képességek	Ez a feladat nem felel meg a feladat későbbi tevékenységeire vonatkozó követelményeknek.
Parancskorlátozások	Bármelyik
Változók beállítása	Bármelyik
Ügynök verziója	Minden támogatott ügynökverzió.
Feladatkategória	Üzembe helyezés