Share via


AzureFunctionActivity Class

Definition

Azure Function activity.

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

Constructors

AzureFunctionActivity(String, AzureFunctionActivityMethod, DataFactoryElement<String>)

Initializes a new instance of AzureFunctionActivity.

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)
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)
FunctionName

Name of the Function that the Azure Function Activity will call. Type: string (or Expression with resultType string).

LinkedServiceName

Linked service reference.

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

Activity user properties.

(Inherited from PipelineActivity)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ExecutionActivity)

Explicit Interface Implementations

IJsonModel<AzureFunctionActivity>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<AzureFunctionActivity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

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)
IPersistableModel<AzureFunctionActivity>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<AzureFunctionActivity>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<AzureFunctionActivity>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

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)

Applies to