WebHookActivity Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
WebHook activity.
public class WebHookActivity : Azure.ResourceManager.DataFactory.Models.ControlActivity, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.WebHookActivity>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.WebHookActivity>public class WebHookActivity : Azure.ResourceManager.DataFactory.Models.ControlActivitytype WebHookActivity = class
inherit ControlActivity
interface IJsonModel<WebHookActivity>
interface IPersistableModel<WebHookActivity>type WebHookActivity = class
inherit ControlActivityPublic Class WebHookActivity
Inherits ControlActivity
Implements IJsonModel(Of WebHookActivity), IPersistableModel(Of WebHookActivity)Public Class WebHookActivity
Inherits ControlActivity- Inheritance
- Implements
Constructors
| WebHookActivity(String, WebHookActivityMethod, DataFactoryElement<String>) |
Initializes a new instance of WebHookActivity. |
Properties
| AdditionalProperties |
Additional Properties To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples:
|
| Authentication |
Authentication method used for calling the endpoint. |
| Body |
Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string). |
| DependsOn |
Activity depends on condition. (Inherited from PipelineActivity) |
| Description |
Activity description. (Inherited from PipelineActivity) |
| Method |
Rest API method for target endpoint. |
| Name |
Activity name. (Inherited from PipelineActivity) |
| OnInactiveMarkAs |
Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. (Inherited from PipelineActivity) |
| Policy |
Activity policy. |
| ReportStatusOnCallBack |
When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean). |
| RequestHeaders |
Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string). To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples:
|
| State |
Activity state. This is an optional property and if not provided, the state will be Active by default. (Inherited from PipelineActivity) |
| Timeout |
The timeout within which the webhook should be called back. If there is no value specified, it defaults to 10 minutes. Type: string. Pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). |
| Uri |
WebHook activity target endpoint and path. Type: string (or Expression with resultType string). |
| UserProperties |
Activity user properties. (Inherited from PipelineActivity) |
Methods
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | (Inherited from ControlActivity) |
