Webhooks onderzoeken

  • 4 minuten

U kunt het starten van een runbook automatiseren door het te plannen of door een webhook te gebruiken.

Met een webhook kunt u een bepaald runbook in Azure Automation starten via één HTTPS-aanvraag.

Hiermee kunnen externe services zoals Azure DevOps, GitHub of aangepaste toepassingen runbooks starten zonder complexere oplossingen te implementeren met behulp van de Azure Automation-API.

Meer informatie over webhooks is beschikbaar bij Het starten van een Azure Automation-runbook met een webhook.

Diagram van het webhookproces voor stroomdiagrammen. De webhook en het runbook bevinden zich binnen een vierkant label Automation.

Een webhook maken

U maakt een webhook die is gekoppeld aan een runbook met behulp van de volgende stappen:

  1. Open in Azure Portal het runbook dat u wilt maken met de webhook.
  2. Selecteer in het runbookvenster onder Resources de optie Webhooks en kies Vervolgens Webhook toevoegen.
  3. Selecteer Nieuwe webhook maken.
  4. In het dialoogvenster Nieuwe webhook maken zijn er verschillende waarden die u moet configureren. Nadat u deze hebt geconfigureerd, selecteert u Maken:
    • Name. Geef een naam op die u wilt gebruiken voor een webhook omdat de naam niet beschikbaar is voor de client. Deze wordt alleen gebruikt om het runbook in Azure Automation te identificeren.
    • Ingeschakeld. Een webhook is standaard ingeschakeld wanneer deze wordt gemaakt. Als u deze instelt op Uitgeschakeld, kan er geen client deze gebruiken.
    • Verloopt. Elke webhook heeft een vervaldatum, op welk moment deze niet meer kan worden gebruikt. U kunt de datum blijven wijzigen nadat u de webhook hebt gemaakt, mits de webhook niet is verlopen.
    • URL. De webhook-URL is het unieke adres dat een client aanroept met een HTTP POST om het runbook te starten dat is gekoppeld aan de webhook. Deze wordt automatisch gegenereerd wanneer u de webhook maakt en u kunt geen aangepaste URL opgeven. De URL bevat een beveiligingstoken waarmee het runbook kan worden aangeroepen door een systeem van derden zonder verdere verificatie. Om deze reden behandelt u het als een wachtwoord. U kunt de URL alleen weergeven in Azure Portal om veiligheidsredenen wanneer de webhook wordt gemaakt. Noteer de URL op een veilige locatie voor toekomstig gebruik.Diagram van de stroom van webhookparameterwaarden en hoe ze stromen. De webhook begint met een binnenkomende HTTP POST-aanvraag.

Notitie

Wanneer u deze maakt, moet u de URL van de webhook kopiëren en opslaan op een veilige plaats. Nadat u de webhook hebt gemaakt, kunt u de URL niet meer ophalen.

  1. Selecteer de optie Parameters uitvoeren instellingen (Standaard: Azure ). Deze optie heeft de volgende kenmerken, waarmee u de volgende acties kunt uitvoeren:

    • Als het runbook verplichte parameters heeft, moet u deze vereiste parameters opgeven tijdens het maken. U kunt de webhook alleen maken als er waarden zijn opgegeven.
    • Als het runbook geen verplichte parameters bevat, is hier geen configuratie vereist.
    • De webhook moet waarden bevatten voor verplichte parameters van het runbook en waarden voor optionele parameters bevatten.
    • Wanneer een client een runbook start met behulp van een webhook, kunnen de gedefinieerde parameterwaarden niet worden overschreven.
    • Als u gegevens van de client wilt ontvangen, kan het runbook één parameter met de naam $WebhookData van het type [object] accepteren die gegevens bevat die de client in de POST-aanvraag bevat.
    • Er is geen vereiste webhookconfiguratie vereist ter ondersteuning van de parameter $WebhookData .Schermopname van een waarschuwing waarin wordt uitgelegd dat de URL na het maken van een webhook niet kan worden weergegeven. Kopieer het voordat u op OK drukt.

  2. Selecteer Maken wanneer u klaar bent.

Een webhook gebruiken

Als u een webhook wilt gebruiken nadat deze is gemaakt, moet uw clienttoepassing een HTTP POST met de URL voor de webhook uitgeven.

  • De syntaxis van de webhook heeft de volgende indeling:

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

  • De client ontvangt een van de volgende retourcodes van de POST-aanvraag.

    Code   Testen Beschrijving
    202 Geaccepteerd De aanvraag is geaccepteerd en het runbook is in de wachtrij geplaatst.
    400 Ongeldige aanvraag De aanvraag is niet geaccepteerd omdat het runbook is verlopen, uitgeschakeld of het token in de URL ongeldig is.
    404 Niet gevonden De aanvraag is niet geaccepteerd omdat de webhook, het runbook of het account niet is gevonden.
    500 Interne serverfout

  • Als dit lukt, bevat het antwoord van de webhook de taak-id in JSON-indeling als volgt:

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

    Het antwoord bevat één taak-id, maar de JSON-indeling maakt potentiële toekomstige verbeteringen mogelijk.

  • U kunt niet bepalen wanneer de runbooktaak is voltooid of de voltooiingsstatus van de webhook bepaalt. U kunt deze informatie alleen kiezen met behulp van de taak-id met een andere methode, zoals PowerShell of de Azure Automation-API.

Meer informatie vindt u op het starten van een Azure Automation-runbook met een webhookpagina .