WebActivity Class

Definition

Web activity.

public class WebActivity : Azure.ResourceManager.DataFactory.Models.ExecutionActivity, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.WebActivity>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.WebActivity>
public class WebActivity : Azure.ResourceManager.DataFactory.Models.ExecutionActivity
type WebActivity = class
    inherit ExecutionActivity
    interface IJsonModel<WebActivity>
    interface IPersistableModel<WebActivity>
type WebActivity = class
    inherit ExecutionActivity
Public Class WebActivity
Inherits ExecutionActivity
Implements IJsonModel(Of WebActivity), IPersistableModel(Of WebActivity)
Public Class WebActivity
Inherits ExecutionActivity
Inheritance
Implements

Constructors

WebActivity(String, WebActivityMethod, DataFactoryElement<String>)

Initializes a new instance of WebActivity.

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:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from PipelineActivity)
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).

ConnectVia

The integration runtime reference.

Datasets

List of datasets passed to web endpoint.

DependsOn

Activity depends on condition.

(Inherited from PipelineActivity)
Description

Activity description.

(Inherited from PipelineActivity)
DisableCertValidation

When set to true, Certificate validation will be disabled.

HttpRequestTimeout

Timeout for the HTTP request to get a response. Format is in TimeSpan (hh:mm:ss). This value is the timeout to get a response, not the activity timeout. The default value is 00:01:00 (1 minute). The range is from 1 to 10 minutes.

LinkedServiceName

Linked service reference.

(Inherited from ExecutionActivity)
LinkedServices

List of linked services passed to web endpoint.

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.

(Inherited from ExecutionActivity)
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:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

State

Activity state. This is an optional property and if not provided, the state will be Active by default.

(Inherited from PipelineActivity)
TurnOffAsync

Option to disable invoking HTTP GET on location given in response header of a HTTP 202 Response. If set true, it stops invoking HTTP GET on http location given in response header. If set false then continues to invoke HTTP GET call on location given in http response headers.

Uri

Web 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 ExecutionActivity)

Explicit Interface Implementations

IJsonModel<ExecutionActivity>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from ExecutionActivity)
IJsonModel<ExecutionActivity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from ExecutionActivity)
IJsonModel<PipelineActivity>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from PipelineActivity)
IJsonModel<PipelineActivity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from PipelineActivity)
IJsonModel<WebActivity>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<WebActivity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ExecutionActivity>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from ExecutionActivity)
IPersistableModel<ExecutionActivity>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from ExecutionActivity)
IPersistableModel<ExecutionActivity>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from ExecutionActivity)
IPersistableModel<PipelineActivity>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from PipelineActivity)
IPersistableModel<PipelineActivity>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from PipelineActivity)
IPersistableModel<PipelineActivity>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from PipelineActivity)
IPersistableModel<WebActivity>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<WebActivity>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<WebActivity>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to