DurableTaskOptions Class

Reference

Definition

Namespace:: Microsoft.Azure.WebJobs.Extensions.DurableTask

Assembly:: Microsoft.Azure.WebJobs.Extensions.DurableTask.dll

Package:: Microsoft.Azure.WebJobs.Extensions.DurableTask v2.8.1

Package:: Microsoft.Azure.WebJobs.Extensions.DurableTask v1.8.3

Source:: DurableTaskOptions.cs

Source:: DurableTaskOptions.cs

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.

Configuration options for the Durable Task extension.

public class DurableTaskOptions

type DurableTaskOptions = class

Public Class DurableTaskOptions

Inheritance: Object
DurableTaskOptions

Constructors

DurableTaskOptions()

Properties

AppLeaseOptions	If UseAppLease is true, gets or sets the AppLeaaseOptions used for acquiring the lease to start the application.
AzureStorageConnectionStringName	Gets or sets the name of the Azure Storage connection string used to manage the underlying Azure Storage resources.
ControlQueueBatchSize	Gets or sets the number of messages to pull from the control queue at a time.
ControlQueueVisibilityTimeout	Gets or sets the visibility timeout of dequeued control queue messages.
CustomLifeCycleNotificationHelperType	Gets or sets the type name of a custom to use for handling lifecycle notification events.
EntityMessageReorderWindowInMinutes	Gets or sets the time window within which entity messages get deduplicated and reordered.
EventGridKeySettingName	Gets or sets the name of the app setting containing the key used for authenticating with the Azure Event Grid custom topic at EventGridTopicEndpoint.
EventGridPublishEventTypes	Gets or sets the event types that will be published to Event Grid.
EventGridPublishRetryCount	Gets or sets the Event Grid publish request retry count.
EventGridPublishRetryHttpStatus	Gets or sets the Event Grid publish request http status.
EventGridPublishRetryInterval	Gets orsets the Event Grid publish request retry interval.
EventGridTopicEndpoint	Gets or sets the URL of an Azure Event Grid custom topic endpoint. When set, orchestration life cycle notification events will be automatically published to this endpoint.
ExtendedSessionIdleTimeoutInSeconds	Gets or sets the amount of time in seconds before an idle session times out. The default value is 30 seconds.
ExtendedSessionsEnabled	Gets or sets a flag indicating whether to enable extended sessions.
FetchLargeMessagesAutomatically	Gets or sets whether the extension will automatically download large inputs and outputs in orchestration status queries. If set to false, the extension will instead return a blob storage url pointing to the GZip compressed input or output data.
HttpSettings	Settings used for Durable HTTP functionality.
HubName	Gets or sets default task hub name to be used by all IDurableClient, IDurableEntityClient, IDurableOrchestrationClient, IDurableOrchestrationContext, and IDurableActivityContext instances.
LocalRpcEndpointEnabled	Gets or sets a value indicating whether to enable the local RPC endpoint managed by this extension.
LogReplayEvents	Gets or sets if logs for replay events need to be recorded.
MaxConcurrentActivityFunctions	Gets or sets the maximum number of activity functions that can be processed concurrently on a single host instance.
MaxConcurrentOrchestratorFunctions	Gets or sets the maximum number of orchestrator functions that can be processed concurrently on a single host instance.
MaxEntityOperationBatchSize	Gets or sets the maximum number of entity operations that are processed as a single batch.
MaxOrchestrationActions	Gets or sets the maximum number of orchestration actions. The default value is 100,000.
MaxQueuePollingInterval	Gets or sets the maximum queue polling interval.
Notifications	The section of configuration related to notifications.
NotificationUrl	Gets or sets the base URL for the HTTP APIs managed by this extension.
OverridableExistingInstanceStates	States that will override an existing orchestrator when attempting to start a new orchestrator with the same instance Id.
PartitionCount	Gets or sets the partition count for the control queue.
RollbackEntityOperationsOnExceptions	Controls whether an uncaught exception inside an entity operation should roll back the effects of the operation.
StorageProvider	The section of configuration related to storage providers. If using Azure Storage provider, the schema should match AzureStorageOptions.
TraceInputsAndOutputs	Gets or sets a value indicating whether to trace the inputs and outputs of function calls.
Tracing	The section of configuration related to tracing.
TrackingStoreConnectionStringName	Gets or sets the name of the Azure Storage connection string to use for the durable tracking store (History and Instances tables).
TrackingStoreNamePrefix	Gets or sets the name prefix to use for history and instance tables in Azure Storage.
UseAppLease	If true, takes a lease on the task hub container, allowing for only one app to process messages in a task hub at a time.
UseGracefulShutdown	Preview setting for gracefully shutting down to prevent WebJob shutdowns from failing activities or orchestrations.
WorkItemQueueVisibilityTimeout	Gets or sets the visibility timeout of dequeued work item queue messages.

Methods

SetDefaultHubName(String)

Sets HubName to a value that is considered a default value.

Applies to

Share via