InvokeRESTAPI@0 - Memanggil tugas REST API v0
Gunakan tugas ini untuk memanggil REST API sebagai bagian dari alur Anda.
Sintaks
# 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.
Input
serviceConnection
- Titik akhir generik
Alias input: connectedServiceName
. string
. Wajib diisi.
Menentukan koneksi layanan generik yang menyediakan baseURL
panggilan dan otorisasi yang akan digunakan untuk tugas tersebut.
method
- Metode
string
. Wajib diisi. Nilai yang diizinkan: OPTIONS
, , HEAD
GET
, POST
, PUT
, DELETE
, TRACE
, PATCH
. Nilai default: POST
.
Menentukan metode HTTP yang memanggil API.
headers
- Header
string
. Nilai default: {\n"Content-Type":"application/json"\n}
.
Menentukan header dalam format JSON. Header dilampirkan dengan permintaan yang dikirim ke API.
body
- Tubuh
string
. Pilihan. Gunakan saat method != GET && method != HEAD
. Nilai default: {"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}
.
Menentukan isi permintaan untuk panggilan fungsi dalam format JSON.
urlSuffix
- String akhiran url
string
.
Menentukan string untuk ditambahkan ke baseUrl dari koneksi layanan generik saat melakukan panggilan HTTP.
Contoh: Jika URL koneksi layanan adalah https:...TestProj/_apis/Release/releases
dan akhiran URL adalah /2/environments/1
, URL koneksi layanan menjadi https:.../TestProj/_apis/Release/releases/2/environments/1
. Jika akhiran URL adalah ?definitionId=1&releaseCount=1
, maka URL koneksi layanan menjadi https//...TestProj/_apis/Release/releases?definitionId=1&releaseCount=1
.
waitForCompletion
- Lengkap berdasarkan
string
. Wajib diisi. Nilai yang diizinkan: true
(Callback), false
(ApiResponse). Nilai default: false
.
Menentukan bagaimana tugas melaporkan penyelesaian. Nilai yang diperbolehkan adalah:
false
- Respons API: Melaporkan penyelesaian ketika fungsi mengembalikan keberhasilan dalam waktu 20 detik, dan kriteria keberhasilan dievaluasi ke true.true
- Panggilan balik: Melaporkan penyelesaian saat layanan eksternal melakukan panggilan balik untuk memperbarui catatan garis waktu.
successCriteria
- Kriteria keberhasilan
string
. Opsional. Gunakan saat waitForCompletion = false
.
Menentukan kriteria tugas untuk keberhasilan. Konten respons tidak memengaruhi hasil jika tidak ada kriteria yang ditentukan. Secara default, tugas lolos 200 OK
saat panggilan kembali .
Contoh: Untuk respons {"status" : "successful"}
, ekspresinya bisa .eq(root['status'], 'successful')
Pelajari selengkapnya tentang menentukan kondisi.
Opsi kontrol tugas
Semua tugas memiliki opsi kontrol selain input tugas mereka. Untuk informasi selengkapnya, lihat Opsi kontrol dan properti tugas umum.
Variabel output
Tidak ada.
Keterangan
Catatan
Tugas ini hanya dapat digunakan dalam pekerjaan tanpa agen.
Berhasil jika API mengembalikan keberhasilan dan penguraian isi respons berhasil, atau saat API memperbarui catatan garis waktu dengan sukses.
Tugas Panggil REST API tidak melakukan tindakan penyebaran secara langsung. Sebaliknya, ini memungkinkan Anda untuk memanggil HTTP REST API generik sebagai bagian dari alur otomatis dan, secara opsional, menunggunya selesai.
Untuk informasi selengkapnya tentang menggunakan tugas ini, lihat Gambaran umum persetujuan dan gerbang.
URL dasar apa yang digunakan saat memanggil API Manajemen Azure?
API manajemen Azure dipanggil menggunakan ResourceManagerEndpoint dari lingkungan yang dipilih. Misalnya https://management.Azure.com
digunakan saat langganan berada di lingkungan AzureCloud .
Di mana sinyal tugas harus selesai saat Callback dipilih sebagai peristiwa penyelesaian?
Untuk penyelesaian sinyal, layanan eksternal harus MEMPOSTING data penyelesaian ke titik akhir REST alur berikut.
{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" }
Lihat aplikasi cmdline sederhana ini untuk detailnya.
Selain itu, pustaka pembantu C# tersedia untuk mengaktifkan pengelogan langsung dan mengelola status tugas untuk tugas tanpa agen. Pelajari lebih lanjut
Dapatkah saya menggunakan isi respons sebagai input untuk tugas lain?
Tidak, karena tugas ini adalah tugas tanpa agen dan menggunakan HttpRequest internal TFS, yang tidak mengembalikan konten permintaan HTTP.
Persyaratan
Persyaratan | Deskripsi |
---|---|
Jenis alur | YAML, Build klasik, Rilis klasik |
Berjalan pada | Server, ServerGate |
Permintaan | Tidak ada |
Kemampuan | Tugas ini tidak memenuhi tuntutan untuk tugas berikutnya dalam pekerjaan. |
Pembatasan perintah | Apa pun |
Variabel yang dapat diatur | Apa pun |
Versi agen | Semua versi agen yang didukung. |
Kategori tugas | Sebarkan |
Saran dan Komentar
https://aka.ms/ContentUserFeedback.
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat:Kirim dan lihat umpan balik untuk