AzureFunction@0. Вызов задачи Функции Azure версии 0
Используйте эту задачу в задании без агента конвейера выпуска, чтобы вызвать триггерную функцию HTTP в приложении-функции и проанализировать ответ. Приложение-функция должно быть создано и размещено в Функциях Azure.
Синтаксис
# Invoke Azure Function v0
# Invoke Azure function as a part of your process.
- task: AzureFunction@0
inputs:
function: # string. Required. Azure function url.
key: # string. Required. Function key.
method: 'POST' # 'OPTIONS' | 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'TRACE' | 'PATCH'. Required. Method. Default: POST.
#headers: # string. Headers.
#queryParameters: # string. Query parameters.
#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)"}.
# Completion Options
waitForCompletion: 'false' # 'true' | 'false'. Required. Complete based on. Default: false.
#successCriteria: # string. Optional. Use when waitForCompletion = false. Success criteria.
Входные данные
function
-
URL-адрес функции Azure
string
. Обязательное.
URL-адрес вызываемой функции Azure. Пример: https://azurefunctionapp.azurewebsites.net/api/HttpTriggerJS1
.
ключа функции key
-
string
. Обязательное.
Функция или ключ узла, используемые для доступа и вызова функции. Чтобы обеспечить безопасность ключа, используйте переменную секретного конвейера для хранения ключа функции. Пример: $(myFunctionKey)
.
myFunctionKey
— это переменная секрета уровня среды со значением в качестве секретного ключа.
Метод method
-
string
. Обязательное. Допустимые значения: OPTIONS
, GET
, HEAD
, POST
, PUT
, DELETE
, TRACE
, PATCH
. Значение по умолчанию: POST
.
Метод HTTP, с которым будет вызвана функция.
headers
-
заголовки
string
. Значение по умолчанию: {\n"Content-Type":"application/json"\n}
.
Заголовок в формате JSON, который должен быть присоединен к запросу, отправленному функции.
queryParameters
-
параметры запроса
string
.
Строковый запрос, добавляемый к URL-адресу функции. Не следует начинать с ?
или &
.
body
-
текст
string
. Необязательно. Используется при method != GET && method != HEAD
. Значение по умолчанию: {"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}
.
Текст запроса в формате JSON.
waitForCompletion
-
завершено на основе
string
. Обязательное. Допустимые значения: true
(обратный вызов), false
(ApiResponse). Значение по умолчанию: false
.
Как выполняется завершение задачи.
-
false
— ответ API — функция возвращает критерии успешности и успешности. -
true
— обратный вызов — функция выполняет обратный вызов для обновления записи временной шкалы.
successCriteria
-
критерии успешности
string
. Необязательно. Используется при waitForCompletion = false
.
Критерии успешной задачи. По умолчанию задача возвращает состояние 200 OK
при успешном выполнении.
Пример: для {"status" : "successful"}
ответа выражение может быть eq(root['status'], 'successful')
. Дополнительные сведения об указании условий.
Параметры управления задачами
Помимо входных данных, все задачи имеют параметры управления. Дополнительные сведения см. в разделе Параметры управления и общие свойства задач.
Выходные переменные
Нет.
Замечания
AzureFunction@2 — это более новая версия задачи "Вызвать функцию Azure".
Требования
Требование | Описание |
---|---|
Типы конвейеров | Классический выпуск |
Выполняется в | Сервер, ServerGate |
требования | Нет |
возможностей | Эта задача не удовлетворяет требованиям к последующим задачам в задании. |
ограничения команд | Любое |
переменные settable | Любое |
Версия агента | Все поддерживаемые версии агента. |
Категория задач | Полезность |
См. также
- AzureFunction@2 — это более новая версия задачи "Вызвать функцию Azure".