Sprawdzanie elementów webhook

  • 4 min

Uruchamianie elementu Runbook można zautomatyzować, planując go lub używając elementu webhook.

Element webhook umożliwia uruchomienie określonego elementu Runbook w usłudze Azure Automation za pomocą pojedynczego żądania HTTPS.

Umożliwia to usługom zewnętrznym, takim jak Azure DevOps, GitHub lub aplikacje niestandardowe, uruchamianie elementów Runbook bez implementowania bardziej złożonych rozwiązań przy użyciu interfejsu API usługi Azure Automation.

Więcej informacji na temat elementów webhook można znaleźć w temacie Uruchamianie elementu runbook usługi Azure Automation przy użyciu elementu webhook.

Diagram procesu elementu webhook schematu blokowego. Element Webhook i element Runbook znajdują się w kwadratowej etykiecie Automatyzacja.

Tworzenie elementu webhook

Utworzysz element webhook połączony z elementem Runbook, wykonując następujące kroki:

  1. W witrynie Azure Portal otwórz element runbook, który chcesz utworzyć element webhook.
  2. W okienku runbook w obszarze Zasoby wybierz pozycję Elementy webhook, a następnie wybierz pozycję Dodaj element webhook.
  3. Wybierz pozycję Utwórz nowy element webhook.
  4. W oknie dialogowym Tworzenie nowego elementu webhook należy skonfigurować kilka wartości. Po ich skonfigurowaniu wybierz pozycję Utwórz:
    • Name. Określ dowolną nazwę elementu webhook, ponieważ nazwa nie jest widoczna dla klienta. Służy ona tylko do identyfikowania elementu runbook w usłudze Azure Automation.
    • Włączone. Element webhook jest domyślnie włączony po jego utworzeniu. Jeśli ustawisz dla niego wartość Wyłączone, żaden klient nie będzie mógł go używać.
    • Wygasa. Każdy element webhook ma datę wygaśnięcia, o której godzinie nie można go już używać. Możesz nadal modyfikować datę po utworzeniu elementu webhook, podając, że element webhook nie wygasł.
    • URL. Adres URL elementu webhook to unikatowy adres, który klient wywołuje za pomocą żądania HTTP POST w celu uruchomienia elementu Runbook połączonego z elementem webhook. Jest on generowany automatycznie podczas tworzenia elementu webhook i nie można określić niestandardowego adresu URL. Adres URL zawiera token zabezpieczający, który umożliwia wywoływanie elementu Runbook przez system innej firmy bez dalszego uwierzytelniania. Z tego powodu traktuj go jak hasło. Adres URL można wyświetlić tylko w witrynie Azure Portal ze względów bezpieczeństwa podczas tworzenia elementu webhook. Zanotuj adres URL w bezpiecznej lokalizacji do użycia w przyszłości.Diagram przedstawiający przepływ wartości parametrów elementu webhook i sposób ich przepływu. Element webhook rozpoczyna się od przychodzącego żądania HTTP POST.

Uwaga

Podczas jego tworzenia upewnij się, że skopiujesz adres URL elementu webhook, a następnie zapisz go w bezpiecznym miejscu. Po utworzeniu elementu webhook nie można ponownie pobrać adresu URL.

  1. Wybierz opcję Ustawienia uruchamiania parametrów (ustawienie domyślne: Platforma Azure). Ta opcja ma następujące cechy, które umożliwiają wykonanie następujących akcji:

    • Jeśli element Runbook ma obowiązkowe parametry, podczas tworzenia należy podać te wymagane parametry. Nie można utworzyć elementu webhook, chyba że podano wartości.
    • Jeśli w elemecie Runbook nie ma obowiązkowych parametrów, w tym miejscu nie ma wymaganej konfiguracji.
    • Element webhook musi zawierać wartości dla wszystkich obowiązkowych parametrów elementu Runbook i zawierać wartości parametrów opcjonalnych.
    • Gdy klient uruchamia element Runbook przy użyciu elementu webhook, nie może zastąpić zdefiniowanych wartości parametrów.
    • Aby odbierać dane od klienta, element Runbook może zaakceptować pojedynczy parametr o nazwie $WebhookData typu [object] zawierającego dane zawarte przez klienta w żądaniu POST.
    • Nie ma wymaganej konfiguracji elementu webhook do obsługi parametru $WebhookData .Zrzut ekranu przedstawiający ostrzeżenie wyjaśniające, że po utworzeniu elementu webhook nie można wyświetlić jego adresu URL. Skopiuj go przed naciśnięciem przycisku OK.

  2. Po zakończeniu wybierz pozycję Utwórz.

Używanie elementu webhook

Aby użyć elementu webhook po jego utworzeniu, aplikacja kliencka musi wydać wpis HTTP POST z adresem URL elementu webhook.

  • Składnia elementu webhook ma następujący format:

      http://< Webhook Server >/token?=< Token Value >

  • Klient otrzymuje jeden z następujących kodów zwrotnych z żądania POST.

    Kod   Test Opis
    202 Zaakceptowano Żądanie zostało zaakceptowane, a element Runbook został pomyślnie w kolejce.
    400 Nieprawidłowe żądanie Żądanie nie zostało zaakceptowane, ponieważ element Runbook wygasł, został wyłączony lub token w adresie URL jest nieprawidłowy.
    404 Nie znaleziono Żądanie nie zostało zaakceptowane, ponieważ nie znaleziono elementu webhook, elementu Runbook lub konta.
    500 Wewnętrzny błąd serwera

  • W przypadku powodzenia odpowiedź elementu webhook zawiera identyfikator zadania w formacie JSON w następujący sposób:

    {"JobIds":["< JobId >"]}

    Odpowiedź będzie zawierać jeden identyfikator zadania, ale format JSON umożliwia potencjalne przyszłe ulepszenia.

  • Nie można określić, kiedy zadanie elementu Runbook zostanie ukończone lub określ jego stan ukończenia z elementu webhook. Te informacje można wybrać tylko przy użyciu identyfikatora zadania z inną metodą, taką jak program PowerShell lub interfejs API usługi Azure Automation.

Więcej szczegółów można znaleźć na stronie Uruchamianie elementu runbook usługi Azure Automation z elementem webhook .