Microsoft.Azure.WebJobs.Extensions.DurableTask Namespace
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.
Classes
ActivityTriggerAttribute |
Trigger attribute used for durable activity functions. |
AzureStorageOptions |
Configuration options for the Azure Storage storage provider. |
DeterministicAttribute |
Attribute used with the Durable Functions Analyzer to label a method as Deterministic. This allows the method to be called in an Orchestration function without causing a compiler warning. |
DurabilityProvider |
The backend storage provider that provides the actual durability of Durable Functions. This is functionally a superset of DurableTask.Core.IOrchestrationService and DurableTask.Core.IOrchestrationServiceClient. If the storage provider does not any of the Durable Functions specific operations, they can use this class directly with the expectation that only those interfaces will be implemented. All of the Durable Functions specific methods/operations are virtual and can be overwritten by creating a subclass. |
DurableClientAttribute |
Attribute used to bind a function parameter to a IDurableClient, IDurableEntityClient, or IDurableOrchestrationClient instance. |
DurableContextExtensions |
Defines convenient overloads for calling the context methods, for all the contexts. |
DurableEntityStatus |
Represents the status of a durable entity instance. |
DurableHttpRequest |
Request used to make an HTTP call through Durable Functions. |
DurableHttpResponse |
Response received from the HTTP request made by the Durable Function. |
DurableOrchestrationStatus |
Represents the status of a durable orchestration instance. |
DurableTaskExtension |
Configuration for the Durable Functions extension. |
DurableTaskJobHostConfigurationExtensions |
Extension for registering a Durable Functions configuration with |
DurableTaskOptions |
Configuration options for the Durable Task extension. |
Entity |
Statically accessible context for entity operations. |
EntityCurrentOperationStatus |
Information about the current status of an operation executing on an entity. Excludes potentially large data (such as the operation input) so it can be read with low latency. |
EntityProxy |
Provides the base implementation for the entity proxy. |
EntityQuery |
Query condition for searching the status of entity instances. |
EntityQueryResult |
The status of all entity instances with paging for a given query. |
EntitySchedulerException |
Exception used to describe various issues encountered by the entity scheduler. |
EntityStatus |
Information about the current status of an entity. Excludes potentially large data (such as the entity state, or the contents of the queue) so it can always be read with low latency. |
EntityTriggerAttribute |
Trigger attribute used for durable entity functions. |
EventGridNotificationOptions |
Configuration of the Event Grid notification options for the Durable Task Extension. |
FunctionFailedException |
The exception that is thrown when a sub-orchestrator or activity function fails with an error. |
HttpManagementPayload |
Data structure containing status, terminate and send external event HTTP endpoints. |
HttpOptions |
Used for Durable HTTP functionality. |
HttpRetryOptions |
Defines retry policies that can be passed as parameters to various operations. |
LockingRulesViolationException |
The exception that is thrown when application code violates the locking rules. |
ManagedIdentityOptions |
Configuration options for Managed Identity. |
ManagedIdentityTokenSource |
Token Source implementation for Azure Managed Identities. |
NotificationOptions |
Configuration of the notification options for the Durable Task Extension. |
OperationErrorException |
Exception result representing an operation that failed, in case the original exception is not serializable, or out-of-proc. |
OrchestrationClientAttribute |
Deprecated attribute to bind a function parameter to a IDurableClient. Here for backwards compatibility. Please use the DurableClientAttribute instead. |
OrchestrationStatusQueryCondition |
Query condition for searching the status of orchestration instances. |
OrchestrationStatusQueryResult |
The status of all orchestration instances with paging for a given query. |
OrchestrationTriggerAttribute |
Trigger attribute used for durable orchestrator functions. |
ProviderUtils |
Provides access to internal functionality for the purpose of implementing durability providers. |
PurgeHistoryResult |
Class to hold statistics about this execution of purge history. |
RetryOptions |
Defines retry policies that can be passed as parameters to various operations. |
StandardConnectionInfoProvider |
Connection info provider which resolves connection information from a standard application (Non WebJob). |
StandardConnectionStringProvider |
Connection string provider which resolves connection strings from the an standard application (Non WebJob). |
StartOrchestrationArgs |
Parameters for starting a new instance of an orchestration. |
TraceOptions |
Configuration of the trace options for the Durable Task Extension. |
WebJobsConnectionInfoProvider |
Connection info provider which resolves connection information from the WebJobs context. |
WebJobsConnectionStringProvider |
Connection string provider which resolves connection strings from the WebJobs context. |
Structs
CleanEntityStorageResult |
The result of a clean entity storage operation. |
EntityId |
A unique identifier for an entity, consisting of entity name and entity key. |
EntityStateResponse<T> |
The response returned by ReadEntityStateAsync<T>(EntityId, String, String). |
Interfaces
DurableActivityContextBase |
Formerly, the abstract base class for DurableActivityContext. Now obsolete: use IDurableActivityContext instead. |
DurableOrchestrationClientBase |
Formerly, the abstract base class for DurableOrchestrationClient. Now obsolete: use IDurableOrchestrationClient instead. |
DurableOrchestrationContextBase |
Formerly, the abstract base class for DurableOrchestrationContext. Now obsolete: use IDurableOrchestrationContext instead. |
IApplicationLifetimeWrapper |
Custom service interface for signaling the extension when the function app is starting up or shutting down. |
IConnectionInfoResolver |
Interface defining methods to resolve connection information. |
IConnectionStringResolver |
Interface defining methods to resolve connection strings. |
IDurabilityProviderFactory |
Interface defining methods to build instances of DurabilityProvider. |
IDurableActivityContext |
Provides functionality available to durable activities. |
IDurableClient |
Provides functionality available to durable orchestration and entity clients. |
IDurableEntityClient |
Provides functionality available to durable entity clients. |
IDurableEntityContext |
Provides functionality for application code implementing an entity operation. |
IDurableHttpMessageHandlerFactory |
Interface used for testing Durable HTTP. |
IDurableOrchestrationClient |
Provides functionality available to durable orchestration clients. |
IDurableOrchestrationContext |
Provides functionality available to orchestration code. |
IEntityProxyContext |
Abstract entity proxy context. |
IErrorSerializerSettingsFactory |
Interface defining methods to build instances of Newtonsoft.Json.JsonSerializerSettings for error serialization. |
ILifeCycleNotificationHelper |
Interface defining methods to life cycle notifications. |
IMessageSerializerSettingsFactory |
Interface defining methods to build instances of Newtonsoft.Json.JsonSerializerSettings for message serialization. |
IPlatformInformation |
Interface for accessing the AppService plan information, the OS, and user-facing PL. Note: The functionality is currently limited, but will grow along with the pursuit of more platform-specific defaults. |
ITokenSource |
Implementations of this interface can be used to provide authorization tokens for outbound HTTP requests. |
Enums
OperatingSystem |
Representation of the supported Operating Systems. |
OrchestrationRuntimeStatus |
Represents the possible runtime execution status values for an orchestration instance. |
OverridableStates |
Represents options for different states that an existing orchestrator can be in to be able to be overwritten by an attempt to start a new instance with the same instance Id. |
WorkerRuntimeType |
Representation of supported Programming Languages. |