Webhook-tevékenység az Azure Data Factoryben

  • Cikk

A következőkre vonatkozik: Azure Data Factory Azure Synapse Analytics

Tipp.

Próbálja ki a Data Factoryt a Microsoft Fabricben, amely egy teljes körű elemzési megoldás a nagyvállalatok számára. A Microsoft Fabric az adattovábbítástól az adatelemzésig, a valós idejű elemzésig, az üzleti intelligenciáig és a jelentéskészítésig mindent lefed. Ismerje meg, hogyan indíthat új próbaverziót ingyenesen!

A webhook-tevékenységek egyéni kóddal szabályozhatják a folyamatok végrehajtását. A webhook-tevékenységgel a kód meghívhat egy végpontot, és visszahívási URL-címet adhat át neki. A folyamatfuttatás megvárja a visszahívási meghívást, mielőtt továbblép a következő tevékenységre.

Fontos

A WebHook-tevékenység mostantól lehetővé teszi a hibák állapotának és az egyéni üzeneteknek a tevékenységhez és a folyamathoz való visszatérését. Állítsa a reportStatusOnCallBack értéket true értékre, és adja meg a StatusCode és a Error értéket a visszahívás hasznos adatai között. További információ: További megjegyzések szakasz.

Webhook-tevékenység létrehozása felhasználói felülettel

Ha webhook-tevékenységet szeretne használni egy folyamatban, hajtsa végre a következő lépéseket:

  1. Keresse meg a Webhookot a folyamattevékenységek panelen, és húzzon egy Webhook-tevékenységet a folyamatvászonra.

  2. Jelölje ki az új webhook-tevékenységet a vászonon, ha még nincs kijelölve, és a Gépház fület a részleteinek szerkesztéséhez.

    Shows the UI for a Webhook activity.

  3. Adjon meg egy URL-címet a webhook számára, amely lehet egy literális URL-sztring, vagy a dinamikus kifejezések, függvények, rendszerváltozók vagy más tevékenységek kimeneteinek bármilyen kombinációja. Adja meg a kéréssel elküldendő egyéb adatokat.

  4. Használja a tevékenység kimenetét bármely más tevékenység bemeneteként, és hivatkozzon arra a kimenetre, ahol a dinamikus tartalom támogatott a céltevékenységben.

Syntax


{
    "name": "MyWebHookActivity",
    "type": "WebHook",
    "typeProperties": {
        "method": "POST",
        "url": "<URLEndpoint>",
        "headers": {
            "Content-Type": "application/json"
        },
        "body": {
            "key": "value"
        },
        "timeout": "00:10:00",
        "reportStatusOnCallBack": false,
        "authentication": {
            "type": "ClientCertificate",
            "pfx": "****",
            "password": "****"
        }
    }
}

Típustulajdonságok

Property Leírás Megengedett értékek Szükséges
név A webhook-tevékenység neve. Sztring Igen
type A "WebHook" értéket kell beállítani. Sztring Igen
Módszer A célvégpont REST API-metódusa. Karakterlánc. A támogatott típus a "POST". Igen
Url A célvégpont és az elérési út. Sztring vagy kifejezés egy karakterlánc resultType értékével. Igen
Fejlécek A kérelemnek küldött fejlécek. Íme egy példa, amely beállítja a nyelvet, és beír egy kérést: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Sztring vagy kifejezés egy karakterlánc resultType értékével. Igen. Szükség van egy Content-Type fejlécre "headers":{ "Content-Type":"application/json"} .
Szervezet A végpontnak küldött hasznos adatokat jelöli. Érvényes JSON vagy jSON resultType értékkel rendelkező kifejezés. Tekintse meg a kérelem hasznos adatséma kérését a kérelem hasznos adatainak sémájára vonatkozóan. Igen
Hitelesítés A végpont meghívására használt hitelesítési módszer. A támogatott típusok az "Alapszintű" és a "ClientCertificate". További információért lásd: Hitelesítés. Ha nincs szükség hitelesítésre, zárja ki ezt a tulajdonságot. Sztring vagy kifejezés egy karakterlánc resultType értékével. Nem
Időtúllépés Mennyi ideig vár a tevékenység a callBackUri által megadott visszahívás meghívására. Az alapértelmezett érték 10 perc ("00:10:00"). Az értékek a TimeSpan formátumot d formátumban használják.óó:mm:ss. Sztring Nem
Jelentés állapota visszahívás esetén Lehetővé teszi, hogy a felhasználó jelentse egy webhook-tevékenység sikertelen állapotát. Logikai Nem

Authentication

A webhook-tevékenységek a következő hitelesítési típusokat támogatják.

None

Ha nincs szükség hitelesítésre, ne tartalmazza a hitelesítési tulajdonságot.

Alap

Adja meg az alapszintű hitelesítéshez használni kívánt felhasználónevet és jelszót.

"authentication":{
   "type":"Basic",
   "username":"****",
   "password":"****"
}

Ügyféltanúsítvány

Adja meg egy PFX-fájl Base64 kódolású tartalmát és egy jelszót.

"authentication":{
   "type":"ClientCertificate",
   "pfx":"****",
   "password":"****"
}

Managed identity

A data factory vagy a Synapse-munkaterület felügyelt identitásával adja meg azt az erőforrás-URI-t, amelyhez a hozzáférési jogkivonatot kérik. Az Azure Resource Management API meghívásához használja a következőt https://management.azure.com/: . A felügyelt identitások működésével kapcsolatos további információkért tekintse meg az Azure-erőforrások felügyelt identitásainak áttekintését.

"authentication": {
    "type": "MSI",
    "resource": "https://management.azure.com/"
}

Megjegyzés:

Ha a szolgáltatás Git-adattárral van konfigurálva, a hitelesítő adatokat az Azure Key Vaultban kell tárolnia az alapszintű vagy ügyféltanúsítvány-hitelesítés használatához. A szolgáltatás nem tárolja a jelszavakat a Gitben.

További megjegyzések

A szolgáltatás átadja a callBackUri további tulajdonságot az URL-végpontnak küldött törzsben. A szolgáltatás elvárja, hogy az URI a megadott időtúllépési érték előtt legyen meghívva. Ha az URI nem hívható meg, a tevékenység "TimedOut" állapottal meghiúsul.

A webhook-tevékenység meghiúsul, ha az egyéni végpont hívása meghiúsul. Bármilyen hibaüzenet hozzáadható a visszahívási törzshez, és felhasználható egy későbbi tevékenységben.

Minden REST API-hívás esetén az ügyfél időtúllépést hajt végre, ha a végpont egy percen belül nem válaszol. Ez a viselkedés általános HTTP-ajánlott eljárás. A probléma megoldásához implementáljon egy 202-s mintát. Az aktuális esetben a végpont a 202-et (Elfogadva) adja vissza, és az ügyfél lekérdezi.

A kérelem egyperces időtúllépésének semmi köze a tevékenység időtúllépéséhez. Az utóbbi a callbackUri által megadott visszahívásra való várakozásra szolgál.

A visszahívási URI-nak visszaadott törzsnek érvényes JSON-nak kell lennie. Állítsa be a Content-Type fejlécet a következőre application/json: .

Ha a visszahívási tulajdonság jelentésállapotát használja, a visszahíváskor a következő kódot kell hozzáadnia a törzshöz:

{
    "Output": {
        // output object is used in activity output
        "testProp": "testPropValue"
    },
    "Error": {
        // Optional, set it when you want to fail the activity
        "ErrorCode": "testErrorCode",
        "Message": "error message to show in activity error"
    },
    "StatusCode": "403" // when status code is >=400, activity is marked as failed
}

Kapcsolódó tartalom

Tekintse meg a következő támogatott vezérlési folyamatokat: