AzureFunction@0 — wywoływanie zadania funkcji platformy Azure w wersji 0

Artykuł
07/02/2024

Użyj tego zadania w zadaniu bez agenta potoku wydania, aby wywołać funkcję wyzwalaną przez protokół HTTP w aplikacji funkcji i przeanalizować odpowiedź. Aplikacja funkcji musi zostać utworzona i hostowana w Azure Functions.

Składnia

# 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.

Dane wejściowe

function - Adres URL funkcji platformy Azure
string. Wymagane.

Adres URL funkcji platformy Azure do wywołania. Przykład: https://azurefunctionapp.azurewebsites.net/api/HttpTriggerJS1.

key - Klucz funkcji
string. Wymagane.

Funkcja lub klucz hosta używany do uzyskiwania dostępu do funkcji i wywoływania jej. Aby zachować bezpieczeństwo klucza, użyj zmiennej potoku wpisu tajnego do przechowywania klucza funkcji. Przykład: $(myFunctionKey). myFunctionKey to zmienna wpisu tajnego na poziomie środowiska z wartością jako klucz tajny.

method - Metoda
string. Wymagane. Dozwolone wartości: OPTIONS, , HEADGET, POSTPUTDELETE, TRACE, . PATCH Wartość domyślna: POST.

Metoda HTTP, za pomocą której zostanie wywołana funkcja.

headers - Nagłówki
string. Wartość domyślna: {\n"Content-Type":"application/json"\n}.

Nagłówek w formacie JSON, który ma zostać dołączony do żądania wysłanego do funkcji.

queryParameters - Parametry zapytania
string.

Zapytanie ciągu, które ma zostać dołączone do adresu URL funkcji. Nie może zaczynać się od ? lub &.

body - Ciała
string. Opcjonalny. Użyj polecenia , gdy method != GET && method != HEAD. Wartość domyślna: {"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}.

Treść żądania w formacie JSON.

waitForCompletion - Ukończono na podstawie
string. Wymagane. Dozwolone wartości: true (Wywołanie zwrotne), false (ApiResponse). Wartość domyślna: false.

Jak zadanie raportuje ukończenie.

false - Odpowiedź interfejsu API — funkcja zwraca kryteria powodzenia i powodzenia ocenia wartość true.
true - Wywołanie zwrotne — funkcja wykonuje wywołanie zwrotne w celu zaktualizowania rekordu osi czasu.

successCriteria - Kryteria powodzenia
string. Opcjonalny. Użyj polecenia , gdy waitForCompletion = false.

Kryteria pomyślnego zadania. Domyślnie zadanie zwraca 200 OK stan po pomyślnym zakończeniu.

Przykład: W przypadku odpowiedzi {"status" : "successful"}wyrażenie może mieć wartość eq(root['status'], 'successful'). Dowiedz się więcej o określaniu warunków.

Opcje sterowania zadania

Wszystkie zadania mają opcje sterowania oprócz danych wejściowych zadań. Aby uzyskać więcej informacji, zobacz Opcje sterowania i typowe właściwości zadań.

Zmienne wyjściowe

Brak.

Uwagi

AzureFunction@2 jest nowszą wersją zadania Wywołaj funkcję platformy Azure.

Wymagania

Wymaganie	Opis
Typy potoków	Wersja klasyczna
Działa na	Serwer, SerwerGate
Wymagania	Brak
Możliwości	To zadanie nie spełnia żadnych wymagań dotyczących kolejnych zadań w zadaniu.
Ograniczenia poleceń	Dowolne
Zmienne w formie tabeli settable	Dowolne
Wersja agenta	Wszystkie obsługiwane wersje agentów.
Kategoria zadania	Narzędzie

Zobacz też

AzureFunction@2 jest nowszą wersją zadania Wywołaj funkcję platformy Azure.

Udostępnij za pośrednictwem