Class StartOrchestrationArgs

Namespace

Microsoft.Azure.WebJobs

Assembly

Microsoft.Azure.WebJobs.Extensions.DurableTask.dll

Parameters for starting a new instance of an orchestration.

public class StartOrchestrationArgs

Inheritance

object

StartOrchestrationArgs

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

This class is primarily intended for use with IAsyncCollector<T>.

Constructors

StartOrchestrationArgs()

Initializes a new instance of the StartOrchestrationArgs class.

public StartOrchestrationArgs()

StartOrchestrationArgs(string, object)

Initializes a new instance of the StartOrchestrationArgs class.

public StartOrchestrationArgs(string functionName, object input)

Parameters

functionName string

The name of the orchestrator function to start.

input object

The JSON-serializeable input for the orchestrator function.

Properties

FunctionName

Gets or sets the name of the orchestrator function to start.

public string FunctionName { get; set; }

Property Value

string

The name of the orchestrator function to start.

Input

Gets or sets the JSON-serializeable input data for the orchestrator function.

public object Input { get; set; }

Property Value

object

JSON-serializeable input value for the orchestrator function.

InstanceId

Gets or sets the instance ID to assign to the started orchestration.

public string InstanceId { get; set; }

Property Value

string

The instance ID to assign.

Remarks

If this property value is null (the default), then a randomly generated instance ID will be assigned automatically.