InvokeRESTAPI@1 - REST API v1 görevini çağırma

İşlem hattınızın bir parçası olarak REST API'yi çağırmak için bu görevi kullanın.

# Invoke REST API v1
# Invoke a REST API as a part of your pipeline.
- task: InvokeRESTAPI@1
  inputs:
    connectionType: 'connectedServiceName' # 'connectedServiceName' | 'connectedServiceNameARM'. Alias: connectedServiceNameSelector. Required. Connection type. Default: connectedServiceName.
    serviceConnection: # string. Alias: connectedServiceName | genericService. Required when connectedServiceNameSelector = connectedServiceName. Generic service connection. 
    #azureServiceConnection: # string. Alias: connectedServiceNameARM | azureSubscription. Required when connectedServiceNameSelector = connectedServiceNameARM. Azure subscription. 
    method: 'POST' # 'OPTIONS' | 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'TRACE' | 'PATCH'. Required. Method. Default: POST.
    #headers: # string. Headers. 
    #body: # string. Optional. Use when method != GET && method != HEAD. Body. 
    #urlSuffix: # string. URL suffix and parameters. 
  # Advanced
    waitForCompletion: 'false' # 'true' | 'false'. Required. Completion event. Default: false.
    #successCriteria: # string. Optional. Use when waitForCompletion = false. Success criteria.

# Invoke REST API v1
# Invoke a REST API as a part of your pipeline.
- task: InvokeRESTAPI@1
  inputs:
    connectionType: 'connectedServiceName' # 'connectedServiceName' | 'connectedServiceNameARM'. Alias: connectedServiceNameSelector. Required. Connection type. Default: connectedServiceName.
    serviceConnection: # string. Alias: connectedServiceName. Required when connectedServiceNameSelector = connectedServiceName. Generic service connection. 
    #azureServiceConnection: # string. Alias: connectedServiceNameARM. Required when connectedServiceNameSelector = connectedServiceNameARM. Azure subscription. 
    method: 'POST' # 'OPTIONS' | 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'TRACE' | 'PATCH'. Required. Method. Default: POST.
    #headers: # string. Headers. 
    #body: # string. Optional. Use when method != GET && method != HEAD. Body. 
    #urlSuffix: # string. URL suffix and parameters. 
  # Advanced
    waitForCompletion: 'false' # 'true' | 'false'. Required. Completion event. Default: false.
    #successCriteria: # string. Optional. Use when waitForCompletion = false. Success criteria.

connectionType - Bağlantı türü
Giriş diğer adı: connectedServiceNameSelector. string. Gereklidir. İzin verilen değerler: connectedServiceName (Genel), connectedServiceNameARM (Azure Resource Manager). Varsayılan değer: connectedServiceName.

REST API'yi çağırmak için kullanılacak hizmet bağlantı türünü belirtir. Azure yönetim API'sini çağırmak için Azure Resource Manager'i veya diğer tüm API'ler için Genel'i seçin.

serviceConnection - Genel hizmet bağlantısı
Giriş diğer adı: connectedServiceName | genericService. string. olduğunda connectedServiceNameSelector = connectedServiceNamegereklidir.

Çağrı için baseUrl sağlayan genel hizmet bağlantısını ve görev için kullanılacak yetkilendirmeyi belirtir.

serviceConnection - Genel hizmet bağlantısı
Giriş diğer adı: connectedServiceName. string. olduğunda connectedServiceNameSelector = connectedServiceNamegereklidir.

Çağrı için baseUrl sağlayan genel hizmet bağlantısını ve görev için kullanılacak yetkilendirmeyi belirtir.

azureServiceConnection - Azure aboneliği
Giriş diğer adı: connectedServiceNameARM | azureSubscription. string. olduğunda connectedServiceNameSelector = connectedServiceNameARMgereklidir.

Azure yönetim API'lerini çağırmak için yapılandırılıp kullanılacak Azure Resource Manager aboneliğini belirtir.

azureServiceConnection - Azure aboneliği
Giriş diğer adı: connectedServiceNameARM. string. olduğunda connectedServiceNameSelector = connectedServiceNameARMgereklidir.

Azure yönetim API'lerini çağırmak için yapılandırılıp kullanılacak Azure Resource Manager aboneliğini belirtir.

method - Yöntem
string. Gereklidir. İzin verilen değerler: OPTIONS, GET, HEAD, , POST, PUT, TRACEDELETE, PATCH. Varsayılan değer: POST.

API'yi çağıran HTTP yöntemini belirtir.

headers - Üstbilgi
string. Varsayılan değer: {\n"Content-Type":"application/json", \n"PlanUrl": "$(system.CollectionUri)", \n"ProjectId": "$(system.TeamProjectId)", \n"HubName": "$(system.HostType)", \n"PlanId": "$(system.PlanId)", \n"JobId": "$(system.JobId)", \n"TimelineId": "$(system.TimelineId)", \n"TaskInstanceId": "$(system.TaskInstanceId)", \n"AuthToken": "$(system.AccessToken)"\n}.

Üst bilgiyi JSON biçiminde tanımlar. Üst bilgi, API'ye gönderilen istekle birlikte eklenir.

body - Vücut
string. İsteğe bağlı. when method != GET && method != HEADkullanın.

İşlev çağrısının istek gövdesini JSON biçiminde belirtir.

urlSuffix - URL son eki ve parametreleri
string.

HTTP çağrısı yapılırken genel hizmet bağlantısından baseUrl öğesine eklenecek dizeyi belirtir.

Örnek: Hizmet bağlantısı URL'si ve https:...TestProj/_apis/Release/releases URL son eki ise /2/environments/1, hizmet bağlantısı URL'si olur https:.../TestProj/_apis/Release/releases/2/environments/1. URL son eki ise ?definitionId=1&releaseCount=1, hizmet bağlantısı URL'si olur https//...TestProj/_apis/Release/releases?definitionId=1&releaseCount=1.

waitForCompletion - Tamamlanma olayı
string. Gereklidir. İzin verilen değerler: true (Callback), false (ApiResponse). Varsayılan değer: false.

Görevin tamamlanma durumunu nasıl raporlamasını belirtir. İzin verilen değerler şunlardır:

• false - API yanıtı: İşlev 20 saniye içinde başarı döndürdüğünde tamamlanmayı bildirir ve başarı ölçütleri true olarak değerlendirilir.
• true - Geri arama: Dış hizmet zaman çizelgesi kaydını güncelleştirmek için geri arama yaptığında tamamlanma durumunu bildirir.

successCriteria - Başarı ölçütleri
string. İsteğe bağlı. when waitForCompletion = falsekullanın.

Görevin başarı ölçütlerini belirtir. Ölçüt tanımlanmadıysa yanıt içeriği sonucu etkilemez. Varsayılan olarak, çağrı döndürdüğünde 200 OKgörev geçer.

Örnek: Yanıt {"status" : "successful"}için ifadesi olabilir eq(root['status'], 'successful'). Koşulları belirtme hakkında daha fazla bilgi edinin.

Yok.