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.true
— Обратный вызов — функция выполняет обратный вызов для обновления записи временная шкала.
successCriteria
- Критерии успешности
string
. Необязательный элемент. Используйте при waitForCompletion = false
.
Критерии успешной задачи. По умолчанию задача возвращает 200 OK
состояние при успешном выполнении.
Пример: для ответа {"status" : "successful"}
выражение может иметь значение eq(root['status'], 'successful')
. Дополнительные сведения об указании условий.
Параметры управления задачами
Помимо входных данных, все задачи имеют параметры управления. Дополнительные сведения см. в разделе Параметры управления и общие свойства задачи.
Выходные переменные
Нет.
Remarks
AzureFunction@2 — это более новая версия задачи "Вызов функции Azure".
Требования
Требование | Описание |
---|---|
Типы конвейеров | Классический выпуск |
Выполняется в | Server, ServerGate |
Требования | Нет |
Capabilities | Эта задача не удовлетворяет требованиям для последующих задач в задании. |
Ограничения команд | Любой |
Устанавливаемые переменные | Любой |
Версия агента | Все поддерживаемые версии агента. |
Категория задач | Служебная программа |
См. также раздел
- AzureFunction@2 — это более новая версия задачи "Вызов функции Azure".