InvokeRESTAPI@1 - REST API v1 작업 호출

이 작업을 사용하여 파이프라인의 일부로 REST API를 호출합니다.

# 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 - 연결 유형
입력 별칭: connectedServiceNameSelector. string. 필수 요소. 허용되는 값: connectedServiceName (제네릭), connectedServiceNameARM (Azure Resource Manager). 기본값은 connectedServiceName입니다.

REST API를 호출하는 데 사용할 서비스 연결 형식을 지정합니다. Azure Resource Manager 선택하여 다른 모든 API에 대해 Azure 관리 API 또는 제네릭을 호출합니다.

serviceConnection - 일반 서비스 연결
입력 별칭: connectedServiceName | genericService. string. 필요한 경우 connectedServiceNameSelector = connectedServiceName입니다.

호출에 대한 baseUrl 및 작업에 사용할 권한 부여를 제공하는 제네릭 서비스 연결을 지정합니다.

serviceConnection - 일반 서비스 연결
입력 별칭: connectedServiceName. string. 필요한 경우 connectedServiceNameSelector = connectedServiceName입니다.

호출에 대한 baseUrl 및 작업에 사용할 권한 부여를 제공하는 제네릭 서비스 연결을 지정합니다.

azureServiceConnection - Azure 구독
입력 별칭: connectedServiceNameARM | azureSubscription. string. 필요한 경우 connectedServiceNameSelector = connectedServiceNameARM입니다.

Azure 관리 API를 호출하기 위해 구성하고 사용할 Azure Resource Manager 구독을 지정합니다.

azureServiceConnection - Azure 구독
입력 별칭: connectedServiceNameARM. string. 필요한 경우 connectedServiceNameSelector = connectedServiceNameARM입니다.

Azure 관리 API를 호출하기 위해 구성하고 사용할 Azure Resource Manager 구독을 지정합니다.

method - 메서드
string. 필수 요소. 허용되는 값: OPTIONS, , GET, HEADPOST, PUT, , DELETE, TRACE, PATCH. 기본값은 POST입니다.

API를 호출하는 HTTP 메서드를 지정합니다.

headers - 헤더
string. 기본값은 {\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}입니다.

헤더를 JSON 형식으로 정의합니다. 헤더는 API로 전송된 요청과 함께 연결됩니다.

body - 몸
string. 선택 사항입니다. 을 사용할 때 method != GET && method != HEAD사용합니다.

함수 호출에 대한 요청 본문을 JSON 형식으로 지정합니다.

urlSuffix - URL 접미사 및 매개 변수
string.

HTTP 호출을 수행하는 동안 제네릭 서비스 연결에서 baseUrl에 추가할 문자열을 지정합니다.

예: 서비스 연결 URL이 https:...TestProj/_apis/Release/releases 이고 URL 접미사가 /2/environments/1인 경우 서비스 연결 URL은 가 됩니다 https:.../TestProj/_apis/Release/releases/2/environments/1. URL 접미사가 ?definitionId=1&releaseCount=1이면 서비스 연결 URL은 가 됩니다 https//...TestProj/_apis/Release/releases?definitionId=1&releaseCount=1.

waitForCompletion - 완료 이벤트
string. 필수 요소. 허용되는 값: true (콜백), false (ApiResponse). 기본값은 false입니다.

태스크에서 완료를 보고하는 방법을 지정합니다. 허용되는 값은 다음과 같습니다.

• false - API 응답: 함수가 20초 이내에 성공을 반환하고 성공 조건이 true로 평가되면 완료를 보고합니다.
• true - 콜백: 외부 서비스가 콜백을 수행하여 타임라인 레코드를 업데이트할 때 완료를 보고합니다.

successCriteria - 성공 조건
string. 선택 사항입니다. 을 사용할 때 waitForCompletion = false사용합니다.

성공에 대한 작업의 조건을 지정합니다. 조건이 정의되지 않은 경우 응답 콘텐츠는 결과에 영향을 주지 않습니다. 기본적으로 호출이 를 반환 200 OK하면 태스크가 전달됩니다.

예: 응답 {"status" : "successful"}의 경우 식은 일 수 있습니다 eq(root['status'], 'successful'). 조건 지정에 대해 자세히 알아봅니다.

없음