WebHookActivity Klasse
WebHook-Aktivität.
Alle erforderlichen Parameter müssen aufgefüllt werden, um an Azure senden zu können.
- Vererbung
-
azure.mgmt.datafactory.models._models_py3.ControlActivityWebHookActivity
Konstruktor
WebHookActivity(*, name: str, method: str | _models.WebHookActivityMethod, url: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None, state: str | _models.ActivityState | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties: List[_models.UserProperty] | None = None, policy: _models.SecureInputOutputPolicy | None = None, timeout: str | None = None, headers: MutableMapping[str, Any] | None = None, body: MutableMapping[str, Any] | None = None, authentication: _models.WebActivityAuthentication | None = None, report_status_on_call_back: MutableMapping[str, Any] | None = None, **kwargs: Any)Parameter
Nicht übereinstimmende Eigenschaften aus der Nachricht werden für diese Auflistung deserialisiert.
- name
- str
Aktivitätsname. Erforderlich.
- description
- str
Aktivitätsbeschreibung.
- state
- str oder ActivityState
Aktivitätsstatus. Dies ist eine optionale Eigenschaft, und wenn nicht angegeben, lautet der Status standardmäßig Aktiv. Bekannte Werte sind: "Active" und "Inactive".
- on_inactive_mark_as
- str oder ActivityOnInactiveMarkAs
Statusergebnis der Aktivität, wenn der Status auf Inaktiv festgelegt ist. Dies ist eine optionale Eigenschaft. Wenn die Aktivität nicht bereitgestellt wird, lautet die status standardmäßig Erfolgreich. Bekannte Werte sind: "Succeeded", "Failed" und "Skipped".
- depends_on
- list[ActivityDependency]
Die Aktivität hängt von der Bedingung ab.
- user_properties
- list[UserProperty]
Aktivitätsbenutzereigenschaften.
- policy
- SecureInputOutputPolicy
Aktivitätsrichtlinie.
- method
- str oder WebHookActivityMethod
Rest-API-Methode für den Zielendpunkt. Erforderlich. „POST“
- url
- <xref:JSON>
Zielendpunkt und Pfad der WebHook-Aktivität. Type: string (oder Expression with resultType string). Erforderlich.
- timeout
- str
Das Timeout, innerhalb dessen der Webhook zurück aufgerufen werden soll. Wenn kein Wert angegeben ist, beträgt er standardmäßig 10 Minuten. Typ: string. Muster: ((d+).)? (dd):(60|( [0-5] [0-9]):(60|( [0-5] [0-9])).
- headers
- <xref:JSON>
Stellt die Header dar, die an die Anforderung gesendet werden. So legen Sie beispielsweise die Sprache und den Typ für eine Anforderung fest: „headers“: { „Accept-Language“: „en-us“, „Content-Type“: „application/json“ }. Type: string (oder Expression with resultType string).
- body
- <xref:JSON>
Stellt die Nutzlast dar, die an den Endpunkt gesendet wird. Erforderlich für die POST/PUT-Methode, nicht zulässig für GET-Methodentyp: string (oder Expression mit resultType-Zeichenfolge).
- authentication
- WebActivityAuthentication
Die zum Aufrufen des Endpunkts verwendete Authentifizierungsmethode.
- report_status_on_call_back
- <xref:JSON>
Wenn diese Einstellung auf true festgelegt ist, werden statusCode, Ausgabe und Fehler im Rückrufanforderungstext von der Aktivität verwendet. Die Aktivität kann als fehlgeschlagen markiert werden, indem statusCode >= 400 in der Rückrufanforderung festgelegt wird. Der Standardwert ist "false". Typ: boolean (oder Expression with resultType boolean).
Variablen
Nicht übereinstimmende Eigenschaften aus der Nachricht werden für diese Auflistung deserialisiert.
- name
- str
Aktivitätsname. Erforderlich.
- type
- str
Der Typ der Aktivität. Erforderlich.
- description
- str
Aktivitätsbeschreibung.
- state
- str oder ActivityState
Aktivitätsstatus. Dies ist eine optionale Eigenschaft, und wenn nicht angegeben, lautet der Status standardmäßig Aktiv. Bekannte Werte sind: "Active" und "Inactive".
- on_inactive_mark_as
- str oder ActivityOnInactiveMarkAs
Statusergebnis der Aktivität, wenn der Status auf Inaktiv festgelegt ist. Dies ist eine optionale Eigenschaft. Wenn die Aktivität nicht bereitgestellt wird, lautet die status standardmäßig Erfolgreich. Bekannte Werte sind: "Succeeded", "Failed" und "Skipped".
- depends_on
- list[ActivityDependency]
Die Aktivität hängt von der Bedingung ab.
- user_properties
- list[UserProperty]
Aktivitätsbenutzereigenschaften.
- policy
- SecureInputOutputPolicy
Aktivitätsrichtlinie.
- method
- str oder WebHookActivityMethod
Rest-API-Methode für den Zielendpunkt. Erforderlich. „POST“
- url
- <xref:JSON>
Zielendpunkt und Pfad der WebHook-Aktivität. Type: string (oder Expression with resultType string). Erforderlich.
- timeout
- str
Das Timeout, innerhalb dessen der Webhook zurück aufgerufen werden soll. Wenn kein Wert angegeben ist, beträgt er standardmäßig 10 Minuten. Typ: string. Muster: ((d+).)? (dd):(60|( [0-5] [0-9]):(60|( [0-5] [0-9])).
- headers
- <xref:JSON>
Stellt die Header dar, die an die Anforderung gesendet werden. So legen Sie beispielsweise die Sprache und den Typ für eine Anforderung fest: „headers“: { „Accept-Language“: „en-us“, „Content-Type“: „application/json“ }. Type: string (oder Expression with resultType string).
- body
- <xref:JSON>
Stellt die Nutzlast dar, die an den Endpunkt gesendet wird. Erforderlich für die POST/PUT-Methode, nicht zulässig für GET-Methodentyp: string (oder Expression mit resultType-Zeichenfolge).
- authentication
- WebActivityAuthentication
Die zum Aufrufen des Endpunkts verwendete Authentifizierungsmethode.
- report_status_on_call_back
- <xref:JSON>
Wenn diese Einstellung auf true festgelegt ist, werden statusCode, Ausgabe und Fehler im Rückrufanforderungstext von der Aktivität verwendet. Die Aktivität kann als fehlgeschlagen markiert werden, indem statusCode >= 400 in der Rückrufanforderung festgelegt wird. Der Standardwert ist "false". Typ: boolean (oder Expression with resultType boolean).
Azure SDK for Python