你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

durable-functions package

AggregatedError

context.df.Task.all() 失败时引发的特定错误。 其消息包含失败的所有异常的聚合。 它应采用以下格式:

context.df.Task.all() 遇到以下错误消息:

名称:DurableError 消息:活动函数“ActivityA”失败。 StackTrace: <堆栈跟踪>

名称:DurableError 消息:活动函数“ActivityB”失败。 StackTrace: <堆栈跟踪>

DummyEntityContext

具有虚拟默认值的实体上下文,用于促进模拟/扩展 Durable Functions API。

DummyOrchestrationContext

具有虚拟默认值的业务流程上下文,以方便模拟/删除 Durable Functions API。

DurableClient

用于启动、查询、终止和引发事件到业务流程和实体实例的客户端。

DurableError

计划活动或子序表失败时引发的规范错误。 可以通过 instanceof 防护检查此错误,以仅捕获 DurableJS 库引发的异常。

DurableOrchestrationContext

提供实现业务流程作的应用程序代码的功能。

DurableOrchestrationStatus

表示持久业务流程实例的状态。

可以使用 DurableClient.getStatus() 提取

EntityId

实体的唯一标识符,由实体类和实体键组成。

EntityStateResponse

DurableClient.readEntityState 返回的响应。

HttpManagementPayload

包含实例管理 HTTP 终结点的数据结构。

ManagedIdentityTokenSource

Azure 托管标识的令牌源实现。

示例

通过调用 Azure 资源管理器 HTTP API 获取 Azure 订阅的列表。

const df = require("durable-functions");

df.app.orchestration(function* (context) {
  return yield context.df.callHttp({
      method: "GET",
      url: "https://management.azure.com/subscriptions?api-version=2019-06-01",
      tokenSource: df.ManagedIdentityTokenSource("https://management.core.windows.net"),
  });
});
PurgeHistoryResult

用于保存有关此清除历史记录执行的统计信息的类。 DurableClient.purgeHistory() 的返回类型

RetryOptions

定义可作为参数传递给各种作的重试策略。

接口

ActivityOptions
ActivityTrigger
CallHttpOptions

提供给业务流程上下文 callHttp() 方法的选项对象

DurableClientInput
DurableClientOptions

为 Durable Client 函数配置输入、输出和处理程序。

DurableEntityContext

提供实现实体作的应用程序代码的功能。

EntityContext

传递给实体函数的上下文对象。

EntityOptions
EntityTrigger
GetStatusOptions

传递给客户端 getStatus() 方法的选项对象

HttpDurableClientOptions

配置 HTTP 触发的 Durable Client 函数的选项。

OrchestrationContext

传递给业务流程函数的上下文对象。

OrchestrationFilter

传递给 DurableClient API 的选项对象,用于筛选要对其执行作的业务流程

OrchestrationOptions
OrchestrationTrigger
RegisteredActivityTask

Durable Functions 任务。

RegisteredOrchestrationTask

Durable Functions 任务。

StartNewOptions

选项对象作为 client.startNew() 方法的可选第二个参数提供

Task

Durable Functions 任务。

TaskHubOptions

传递给 DurableClient API 以指定任务中心属性的选项对象

TimerDurableClientOptions

为计时器触发的 Durable Client 函数配置选项。

TimerTask

从 durableClient 返回。如果调用未 createTimer(Date)-ed,yield。 表示挂起的计时器。 有关详细信息,请参阅有关 任务 的文档。

必须完成或取消所有挂起的计时器,以便业务流程完成。

示例

取消计时器

// calculate expiration date
const timeoutTask = context.df.createTimer(expirationDate);

// do some work

if (!timeoutTask.isCompleted) {
    // An orchestration won't get marked as completed until all its scheduled
    // tasks have returned, or been cancelled. Therefore, it is important
    // to cancel timers when they're no longer needed
    timeoutTask.cancel();
}

示例

创建超时

const now = Date.now();
const expiration = new Date(now.valueOf()).setMinutes(now.getMinutes() + 30);

const timeoutTask = context.df.createTimer(expirationDate);
const otherTask = context.df.callActivity("DoWork");

const winner = yield context.df.Task.any([timeoutTask, otherTask]);

if (winner === otherTask) {
    // do some more work
}

if (!timeoutTask.isCompleted) {
    // An orchestration won't get marked as completed until all its scheduled
    // tasks have returned, or been cancelled. Therefore, it is important
    // to cancel timers when they're no longer needed
    timeoutTask.cancel();
}
WaitForCompletionOptions

传递给 durableClient.waitForCompletionOrCreateCheckStatusResponse() 方法的选项对象指定等待持久函数输出的超时时间,以及检查输出的频率。

类型别名

ActivityHandler
DurableClientHandler

由某些触发器触发并接收 DurableClient 实例作为输入的处理程序函数的类型。

EntityHandler
HttpDurableClientHandler
OrchestrationHandler

可注册为业务流程的生成器的类型

RegisteredActivity
RegisteredOrchestration
TimerDurableClientHandler
TokenSource

枚举

OrchestrationRuntimeStatus

业务流程实例的状态。

函数

getClient(InvocationContext)

返回 OrchestrationClient 实例。

函数详细信息

getClient(InvocationContext)

返回 OrchestrationClient 实例。

function getClient(context: InvocationContext): DurableClient

参数

context
InvocationContext

其正文调用此方法的 Azure 函数的上下文对象。

返回