Durable Functions 扩展引入了两个新的触发器绑定,用于控制业务流程协调程序和活动函数的执行。 它还引入了输出绑定,充当 Durable Functions 运行时的客户端。
业务流程触发器
业务流程触发器可用于创作持久业务流程协调程序函数。 此触发器支持启动新的业务流程协调程序函数实例和恢复“等待”任务的现有业务流程协调程序函数实例。
使用适用于 Azure Functions 的 Visual Studio 工具时,使用 OrchestrationTriggerAttribute .NET 属性配置业务流程触发器。
使用脚本语言(例如 JavaScript 或 C# scripting)编写业务流程协调程序函数时,由 function.json 文件中 bindings 数组的以下 JSON 对象定义业务流程协调程序触发器:
{
"name": "<Name of input parameter in function signature>",
"orchestration": "<Optional - name of the orchestration>",
"type": "orchestrationTrigger",
"direction": "in"
}
orchestration是客户端想要启动此业务流程协调程序函数的新实例时必须使用的业务流程名称。 此属性是可选的。 如果未指定,则使用该函数的名称。
本质上,此触发器绑定轮询函数应用的默认存储帐户中的一系列队列。 这些队列是扩展的内部实现详细信息,因此未在绑定属性中显式配置这些队列。
触发器行为
以下是有关业务流程触发器的一些注意事项:
- 单线程 - 单个调度程序线程用于单个主机实例上的所有业务流程协调程序函数执行 。 为此,必须确保业务流程协调程序函数代码有效,且不执行任何 I/O 操作。 还必须确保此线程不执行任何异步工作,等待特定于 Durable Functions 的任务类型除外。
- 有害消息处理 - 业务流程触发器中不支持有害消息。
- 消息可见性 - 业务流程触发器消息会取消排队并在可配置的持续时间内保持可见 。 只要函数应用正常运行,这些消息的可见性就会自动更新。
- 返回值 - 返回值序列化为 JSON,并持久保存到 Azure 表存储中的业务流程历史记录表 。 业务流程客户端绑定可以查询这些值,后文会对此进行介绍。
Warning: 业务流程协调程序函数不得使用业务流程触发器绑定之外的任何输入或输出绑定。 这样做有可能导致 Durable Task 扩展出现问题,因为这些绑定可能不遵从单线程处理和 I/O 规则。 若要使用其他绑定,请将它们添加到从业务流程协调程序函数调用的活动函数。
Warning: 绝不应当将 JavaScript 业务流程协调程序函数声明为
async。
触发器用法 (.NET)
业务流程触发器绑定同时支持输入和输出。 下面是有关输入和输出处理的一些须知事项:
- 输入 - .NET 业务流程函数仅支持以
DurableOrchestrationContext作为参数类型。 不支持在函数签名中直接反序列化输入。 代码必须使用GetInput<T>(.NET) 或getInput(JavaScript) 方法提取业务流程协调程序函数输入。 这些输入必须是 JSON 可序列化类型。 - 输出 - 业务流程触发器支持输出值以及输入 。 函数的返回值用于分配输出值,且必须是 JSON 可序列化的。 如果 .NET 函数返回
Task或void,则会将null值保存为输出。
触发器示例
以下示例代码演示了最简单的“Hello World”业务流程协调程序函数的形式:
C#
[FunctionName("HelloWorld")]
public static string Run([OrchestrationTrigger] IDurableOrchestrationContext context)
{
string name = context.GetInput<string>();
return $"Hello {name}!";
}
Note: 前面的代码适用于 Durable Functions 2.x。 对于 Durable Functions 1.x,必须使用
DurableOrchestrationContext而不是IDurableOrchestrationContext。 有关版本之间差异的详细信息,请参阅 Durable Functions 版本一文。
JavaScript(仅限 Functions 2.0)
const df = require("durable-functions");
module.exports = df.orchestrator(function*(context) {
const name = context.df.getInput();
return `Hello ${name}!`;
});
Note: JavaScript 中的
context对象并非表示 DurableOrchestrationContext,而是表示整个函数上下文。 可以通过context对象的df属性访问业务流程方法。
Note: JavaScript 业务流程协调程序应使用
return。durable-functions库将负责调用context.done方法。
大多数业务流程协调程序函数会调用活动函数,因此下面的“Hello World”示例演示了如何调用活动函数:
C#
[FunctionName("HelloWorld")]
public static async Task<string> Run(
[OrchestrationTrigger] IDurableOrchestrationContext context)
{
string name = context.GetInput<string>();
string result = await context.CallActivityAsync<string>("SayHello", name);
return result;
}
Note: 前面的代码适用于 Durable Functions 2.x。 对于 Durable Functions 1.x,必须使用
DurableOrchestrationContext而不是IDurableOrchestrationContext。 有关版本之间差异的详细信息,请参阅 Durable Functions 版本一文。
JavaScript(仅限 Functions 2.0)
const df = require("durable-functions");
module.exports = df.orchestrator(function*(context) {
const name = context.df.getInput();
const result = yield context.df.callActivity("SayHello", name);
return result;
});
活动触发器
使用活动触发器可以创作业务流程协调程序函数调用的函数(称为活动函数)。
如果使用 Visual Studio,则使用 ActivityTriggerAttribute .NET 属性配置活动触发器。
如果使用 VS Code 或 Azure 门户进行开发,则由 function.json 文件中 bindings 数组的以下 JSON 对象定义活动触发器:
{
"name": "<Name of input parameter in function signature>",
"activity": "<Optional - name of the activity>",
"type": "activityTrigger",
"direction": "in"
}
activity是活动的名称。 此值是业务流程协调程序函数用来调用此活动函数的名称。 此属性是可选的。 如果未指定,则使用该函数的名称。
本质上,此触发器绑定轮询函数应用的默认存储帐户中的一个轮询队列。 这个队列是扩展的内部实现详细信息,因此未在绑定属性中显式配置此队列。
触发器行为
以下是有关活动触发器的一些注意事项:
- 线程处理 - 与业务流程触发器不同,活动触发器没有关于线程处理或 I/O 的任何限制 。 可以将它们视为常规功能。
- 有害消息处理 - 活动触发器中不支持有害消息 。
- 消息可见性 - 活动触发器消息会取消排队并在可配置的持续时间内保持可见 。 只要函数应用正常运行,这些消息的可见性就会自动更新。
- 返回值 - 返回值序列化为 JSON,并持久保存到 Azure 表存储中的业务流程历史记录表 。
Warning: 活动函数的存储后端属于实现详细信息,用户代码不得直接与这些存储实体进行交互。
触发器用法 (.NET)
类似于业务流程触发器,活动触发器绑定也同时支持输入和输出。 下面是有关输入和输出处理的一些须知事项:
- 输入 - .NET 活动函数以本机方式使用
DurableActivityContext作为参数类型。 或者,可以使用任何 JSON 可序列化的参数类型声明活动函数。 如果使用DurableActivityContext,可以调用GetInput<T>来提取和反序列化活动函数输入。 - 输出 - 活动函数支持输出值以及输入。 函数的返回值用于分配输出值,且必须是 JSON 可序列化的。 如果 .NET 函数返回
Task或void,则会将null值保存为输出。 - 元数据 - .NET 活动函数可以绑定到
string instanceId参数,以获取父业务流程的实例 ID。
触发器示例
以下示例代码演示了简单的“Hello World”活动函数的形式:
C#
[FunctionName("SayHello")]
public static string SayHello([ActivityTrigger] IDurableActivityContext helloContext)
{
string name = helloContext.GetInput<string>();
return $"Hello {name}!";
}
Note: 前面的代码适用于 Durable Functions 2.x。 对于 Durable Functions 1.x,必须使用
DurableActivityContext而不是IDurableActivityContext。 有关版本之间差异的详细信息,请参阅 Durable Functions 版本一文。
.NET ActivityTriggerAttribute 绑定的默认参数类型是 IDurableActivityContext。 但是,.NET 活动触发器还支持直接绑定到 JSON 可序列化类型(包括基元类型),因此相同的函数可以简化为如下所示:
[FunctionName("SayHello")]
public static string SayHello([ActivityTrigger] string name)
{
return $"Hello {name}!";
}
JavaScript(仅限 Functions 2.0)
module.exports = async function(context) {
return `Hello ${context.bindings.name}!`;
};
JavaScript 绑定可以还作为附加参数进行传入,因此,同一函数可以简化如下:
module.exports = async function(context, name) {
return `Hello ${name}!`;
};
使用输入和输出绑定
除了活动触发器绑定以外,还可以使用普通的输入和输出绑定。 例如,可将输入提取到活动绑定,并使用“事件中心”输出绑定向事件中心发送消息:
{
"bindings": [
{
"name": "message",
"type": "activityTrigger",
"direction": "in"
},
{
"type": "eventHub",
"name": "outputEventHubMessage",
"connection": "EventhubConnectionSetting",
"eventHubName": "eh_messages",
"direction": "out"
}
]
}
module.exports = async function (context) {
context.bindings.outputEventHubMessage = context.bindings.message;
};
业务流程客户端
通过业务流程客户端绑定,可以编写与业务流程协调程序函数进行交互的函数。 这些函数有时称为客户端函数。 例如,可以通过以下方式对业务流程实例进行操作:
- 启动它们。
- 查询它们的状态。
- 终止它们。
- 当它们正在运行时,向它们发送事件。
- 清除实例历史记录。
如果使用 Visual Studio,可以使用 Durable Functions 1.0 的 OrchestrationClientAttribute .NET 属性绑定到业务流程客户端。 从 Durable Functions 2.0 开始,可以使用 DurableClientAttribute .NET 属性绑定到业务流程客户端。
如果使用脚本语言(例如, .csx 或 .js 文件)进行开发,由 function.json 的 bindings 数组中的以下 JSON 对象定义业务流程触发器:
{
"name": "<Name of input parameter in function signature>",
"taskHub": "<Optional - name of the task hub>",
"connectionName": "<Optional - name of the connection string app setting>",
"type": "orchestrationClient",
"direction": "in"
}
taskHub- 用于多个函数应用共享同一存储帐户但需要彼此独立的方案。 如果未指定,则使用host.json中的默认值。 此值必须与目标业务流程协调程序函数所使用的值匹配。connectionName- 包含存储帐户连接字符串的应用设置的名称。 此连接字符串表示的存储帐户必须与目标业务流程协调程序函数所用的存储帐户相同。 如果未指定,则使用函数应用的默认存储帐户连接字符串。
Note: 在大多数情况下,建议忽略这些属性,并依靠默认行为。
客户端使用情况
在 .NET 函数中,通常会绑定到 IDurableOrchestrationClient,后者可提供对 Durable Functions 支持的所有业务流程客户端 API 的完全访问权限。 在较旧的 Durable Functions 2.x 版本中,应改为绑定到 DurableOrchestrationClient 类。 在 JavaScript 中,相同的 API 是由从 getClient 返回的对象公开的。 客户端对象上的 API 包括:
StartNewAsyncGetStatusAsyncTerminateAsyncRaiseEventAsyncPurgeInstanceHistoryAsyncCreateCheckStatusResponseCreateHttpManagementPayload
另外,还可以将 .NET 函数绑定到 IAsyncCollector<T>,其中 T 是 StartOrchestrationArgs 或 JObject。
有关这些操作的详细信息,请参阅 IDurableOrchestrationClient API 文档。
客户端示例(Visual Studio 开发)
下面的示例是启动“HelloWorld”业务流程的队列触发型函数。
[FunctionName("QueueStart")]
public static Task Run(
[QueueTrigger("durable-function-trigger")] string input,
[DurableClient] IDurableOrchestrationClient starter)
{
// Orchestration input comes from the queue message content.
return starter.StartNewAsync("HelloWorld", input);
}
Note: 前面的 C# 代码适用于 Durable Functions 2.x。 对于 Durable Functions 1.x,必须使用
OrchestrationClient属性而不是DurableClient属性,并且必须使用DurableOrchestrationClient参数类型而不是IDurableOrchestrationClient。 有关版本之间差异的详细信息,请参阅 Durable Functions 版本一文。
客户端示例(非 Visual Studio)
如果未使用 Visual Studio 进行开发,则可以创建以下 function.json 文件。 此示例演示如何配置使用持久业务流程客户端绑定的队列触发型函数:
{
"bindings": [
{
"name": "input",
"type": "queueTrigger",
"queueName": "durable-function-trigger",
"direction": "in"
},
{
"name": "starter",
"type": "durableClient",
"direction": "in"
}
]
}
Note: 前面的 JSON 适用于 Durable Functions 2.x。 对于 Durable Functions 1.x,必须使用
orchestrationClient而不是durableClient作为触发器类型。 有关版本之间差异的详细信息,请参阅 Durable Functions 版本一文。
下面是启动新业务流程协调程序函数实例的语言特定示例。
C# 脚本示例
下面的示例演示如何使用持久业务流程客户端绑定从队列触发的 C# 函数启动新函数实例:
#r "Microsoft.Azure.WebJobs.Extensions.DurableTask"
using Microsoft.Azure.WebJobs.Extensions.DurableTask;
public static Task Run(string input, IDurableOrchestrationClient starter)
{
return starter.StartNewAsync("HelloWorld", input);
}
Note: 前面的代码适用于 Durable Functions 2.x。 对于 Durable Functions 1.x,必须使用
DurableOrchestrationClient参数类型而不是IDurableOrchestrationClient。 有关版本之间差异的详细信息,请参阅 Durable Functions 版本一文。
JavaScript 示例
下面的示例演示如何使用持久业务流程客户端绑定从 JavaScript 函数启动新函数实例:
const df = require("durable-functions");
module.exports = async function (context) {
const client = df.getClient(context);
return instanceId = await client.startNew("HelloWorld", undefined, context.bindings.input);
};
有关启动实例的更多详细信息,请参阅实例管理。
实体触发器
使用实体触发器可以创作实体函数。 此触发器支持处理特定实体实例的事件。
使用适用于 Azure Functions 的 Visual Studio 工具时,需使用 EntityTriggerAttribute .NET 属性配置实体触发器。
Note: 从 Durable Functions 2.x 开始提供实体触发器。
本质上,此触发器绑定轮询函数应用的默认存储帐户中的一系列队列。 这些队列是扩展的内部实现详细信息,因此未在绑定属性中显式配置这些队列。
触发器行为
以下是有关实体触发器的一些注意事项:
- 单线程:使用单个调度程序线程来处理特定实体的操作。 如果将多个消息同时发送到单个实体,将会逐个处理操作。
- 有害消息处理 - 实体触发器中不支持有害消息。
- 消息可见性 - 实体触发器消息会取消排队并在可配置的持续时间内保持可见。 只要函数应用正常运行,这些消息的可见性就会自动更新。
- 返回值 - 实体函数不支持返回值。 可以使用特定的 API 来保存状态,或者将值传回到业务流程。
在执行实体期间对实体所做的任何状态更改将在执行完成后自动保留。
触发器用法 (.NET)
每个实体函数具有参数类型 IDurableEntityContext,其中包含以下成员:
- EntityName:当前正在执行的实体的名称。
- EntityKey:当前正在执行的实体的键。
- EntityId:当前正在执行的实体的 ID。
- OperationName:当前操作的名称。
- HasState:实体是否存在,即,是否存在某种状态。
- GetState<TState>() :获取实体的当前状态。 如果它不存在,则会创建它并将它初始化为
default<TState>。TState参数必须是基元或 JSON 可序列化类型。 - GetState<TState>(initfunction) :获取实体的当前状态。 如果它不存在,则会通过调用提供的
initfunction参数来创建它。TState参数必须是基元或 JSON 可序列化类型。 - SetState(arg) :创建或更新实体的状态。
arg参数必须是 JSON 可序列化对象或基元。 - DeleteState() :删除实体的状态。
- GetInput<TInput>() :获取当前操作的输入。
TInput类型参数必须是基元或 JSON 可序列化类型。 - Return(arg) :将值返回到调用该操作的业务流程。
arg参数必须是基元或 JSON 可序列化对象。 - SignalEntity(EntityId, scheduledTimeUtc, operation, input) :向实体发送单向消息。
operation参数必须是非 NULL 字符串,可选scheduledTimeUtc必须是调用操作的 UTC 日期时间,input参数必须是基元或 JSON 可序列化对象。 - CreateNewOrchestration(orchestratorFunctionName, input) :启动新的业务流程。
input参数必须是基元或 JSON 可序列化对象。
传递给实体函数的 IDurableEntityContext 对象可以使用 Entity.Current 异步本地属性进行访问。 在使用基于类的编程模型时,此方法很方便。
触发器示例(基于 C# 函数的语法)
以下代码是作为持久函数实现的简单 Counter 实体示例。 此函数定义三个操作:add、reset 和 get,每个操作针对整数状态运行。
[FunctionName("Counter")]
public static void Counter([EntityTrigger] IDurableEntityContext ctx)
{
switch (ctx.OperationName.ToLowerInvariant())
{
case "add":
ctx.SetState(ctx.GetState<int>() + ctx.GetInput<int>());
break;
case "reset":
ctx.SetState(0);
break;
case "get":
ctx.Return(ctx.GetState<int>()));
break;
}
}
有关基于函数的语法及其用法的详细信息,请参阅基于函数的语法。
触发器示例(基于 C# 类的语法)
以下示例是使用类和方法的 Counter 实体的等效实现。
[JsonObject(MemberSerialization.OptIn)]
public class Counter
{
[JsonProperty("value")]
public int CurrentValue { get; set; }
public void Add(int amount) => this.CurrentValue += amount;
public void Reset() => this.CurrentValue = 0;
public int Get() => this.CurrentValue;
[FunctionName(nameof(Counter))]
public static Task Run([EntityTrigger] IDurableEntityContext ctx)
=> ctx.DispatchAsync<Counter>();
}
此实体的状态是 Counter 类型的对象,该对象包含存储计数器当前值的字段。 为了将此对象持久保存在存储中,Json.NET 库会将其序列化和反序列化。
有关基于类的语法及其用法的详细信息,请参阅定义实体类。
Note: 使用实体类时,必须将具有
[FunctionName]属性的函数入口点方法声明为static。 非静态入口点方法可能会导致多次进行对象初始化,并可能导致其他不确定的行为。
实体类使用特殊的机制来与绑定和 .NET 依赖项注入交互。 有关详细信息,请参阅实体构造。
触发器示例 (JavaScript)
以下代码是作为持久函数(以 JavaScript 编写)实现的简单 Counter 实体示例。 此函数定义三个操作:add、reset 和 get,每个操作针对整数状态运行。
function.json
{
"bindings": [
{
"name": "context",
"type": "entityTrigger",
"direction": "in"
}
],
"disabled": false
}
index.js
const df = require("durable-functions");
module.exports = df.entity(function(context) {
const currentValue = context.df.getState(() => 0);
switch (context.df.operationName) {
case "add":
const amount = context.df.getInput();
context.df.setState(currentValue + amount);
break;
case "reset":
context.df.setState(0);
break;
case "get":
context.df.return(currentValue);
break;
}
});
Note: 从
durable-functionsnpm 包版本 1.3.0 开始,JavaScript 中提供了持久实体 。
实体客户端
使用实体客户端绑定可以异步触发实体函数。 这些函数有时称为客户端函数。
如果使用 Visual Studio,则可以使用 DurableClientAttribute .NET 属性绑定到实体客户端。
Note: 还可以使用
[DurableClientAttribute]绑定到业务流程客户端。
如果使用脚本语言(例如, .csx 或 .js 文件)进行开发,由 function.json 的 bindings 数组中的以下 JSON 对象定义实体触发器:
{
"name": "<Name of input parameter in function signature>",
"taskHub": "<Optional - name of the task hub>",
"connectionName": "<Optional - name of the connection string app setting>",
"type": "durableClient",
"direction": "in"
}
taskHub- 用于多个函数应用共享同一存储帐户但需要彼此独立的方案。 如果未指定,则使用host.json中的默认值。 此值必须与目标实体函数所使用的值匹配。connectionName- 包含存储帐户连接字符串的应用设置的名称。 此连接字符串表示的存储帐户必须与目标实体函数所用的存储帐户相同。 如果未指定,则使用函数应用的默认存储帐户连接字符串。
Note: 在大多数情况下,建议忽略可选属性,并依赖默认行为。
实体客户端的用法
在 .NET 函数中,通常会绑定到 IDurableEntityClient,后者可提供对持久实体支持的所有客户端 API 的完全访问权限。 也可以绑定到 IDurableOrchestrationClient 接口,该接口提供对实体和业务流程的客户端 API 的访问。 客户端对象上的 API 包括:
- ReadEntityStateAsync<T> :读取实体的状态。 它会返回响应,指出目标实体是否存在,以及在存在的情况下,其状态是什么。
- SignalEntityAsync:将单向消息发送到实体,并等待消息排队。
- ListEntitiesAsync:查询多个实体的状态。 可以按“名称” 和“上次操作时间” 来查询实体。
不需在发送信号之前创建目标实体 - 实体状态可以在处理信号的实体函数内部创建。
Note: 必须知道,从客户端发送的“信号”会直接排队,稍后以异步方式对其进行处理。 具体说来,
SignalEntityAsync通常会在实体开始操作之前返回,因此不可能获取返回值或观察异常。 如果需要更强的保证(例如,在使用工作流的情况下),则应使用 业务流程协调程序函数,此类函数会等待实体操作完成,可以处理返回值并观察异常。
示例:客户端直接向实体发出信号 - C#
下面是一个调用“计数器”实体的示例队列触发的函数。
[FunctionName("AddFromQueue")]
public static Task Run(
[QueueTrigger("durable-function-trigger")] string input,
[DurableClient] IDurableEntityClient client)
{
// Entity operation input comes from the queue message content.
var entityId = new EntityId(nameof(Counter), "myCounter");
int amount = int.Parse(input);
return client.SignalEntityAsync(entityId, "Add", amount);
}
示例:客户端同接口向实体发出信号 - C#
我们建议尽量通过接口访问实体,因为这种方法提供更多的类型检查。 例如,假设前面所述的 Counter 实体实现 ICounter 接口,定义如下:
public interface ICounter
{
void Add(int amount);
void Reset();
Task<int> Get();
}
public class Counter : ICounter
{
// ...
}
然后,客户端代码可以使用 SignalEntityAsync<ICounter>,以生成类型安全的代理:
[FunctionName("UserDeleteAvailable")]
public static async Task AddValueClient(
[QueueTrigger("my-queue")] string message,
[DurableClient] IDurableEntityClient client)
{
var target = new EntityId(nameof(Counter), "myCounter");
int amount = int.Parse(message);
await client.SignalEntityAsync<ICounter>(target, proxy => proxy.Add(amount));
}
proxy 参数是动态生成的 ICounter 实例,它在内部将 Add 调用转换为等效的(非类型化)SignalEntityAsync 调用。
Note:
SignalEntityAsyncAPI 表示单向操作。 如果实体接口返回Task<T>,则T参数的值始终为 null 或default。
具体说来,向 Get 操作发出信号没有意义,因为这不会返回任何值。 客户端可以改用 ReadStateAsync 来直接访问计数器状态,或者可以启动一个调用 Get 操作的业务流程协调程序函数。
示例:客户端向实体发出信号 - JavaScript
下面是一个在 JavaScript 中指示“计数器”实体的队列触发函数示例。
function.json
{
"bindings": [
{
"name": "input",
"type": "queueTrigger",
"queueName": "durable-entity-trigger",
"direction": "in",
},
{
"name": "starter",
"type": "durableClient",
"direction": "in"
}
],
"disabled": false
}
index.js
const df = require("durable-functions");
module.exports = async function (context) {
const client = df.getClient(context);
const entityId = new df.EntityId("Counter", "myCounter");
await context.df.signalEntity(entityId, "add", 1);
};
Note: 从
durable-functionsnpm 包版本 1.3.0 开始,JavaScript 中提供了持久实体 。
host.json 设置
Durable Functions 的配置设置。
Note: Azure Functions 运行时的所有版本均支持 Durable Functions 的所有主要版本。 但是,根据 Azure Functions 运行时的版本和使用的 Durable Functions 扩展版本,host json 配置的架构略有不同。 以下示例可与 Azure Functions 2.0 和3.0 一起使用。 在这两个示例中,如果使用 Azure Functions 1.0,则可用设置是相同的,但 host.json 的“durableTask”部分应位于 host. json 配置的根目录中,而不是作为“extension”下的字段。
Durable Functions 2.x
{
"extensions": {
"durableTask": {
"hubName": "MyTaskHub",
"storageProvider": {
"connectionStringName": "AzureWebJobsStorage",
"controlQueueBatchSize": 32,
"controlQueueBufferThreshold": 256,
"controlQueueVisibilityTimeout": "00:05:00",
"maxQueuePollingInterval": "00:00:30",
"partitionCount": 4,
"trackingStoreConnectionStringName": "TrackingStorage",
"trackingStoreNamePrefix": "DurableTask",
"useLegacyPartitionManagement": true,
"workItemQueueVisibilityTimeout": "00:05:00",
},
"tracing": {
"traceInputsAndOutputs": false,
"traceReplayEvents": false,
},
"notifications": {
"eventGrid": {
"topicEndpoint": "https://topic_name.westus2-1.eventgrid.azure.net/api/events",
"keySettingName": "EventGridKey",
"publishRetryCount": 3,
"publishRetryInterval": "00:00:30",
"publishEventTypes": [
"Started",
"Pending",
"Failed",
"Terminated"
]
}
},
"maxConcurrentActivityFunctions": 10,
"maxConcurrentOrchestratorFunctions": 10,
"extendedSessionsEnabled": false,
"extendedSessionIdleTimeoutInSeconds": 30,
"useAppLease": true,
"useGracefulShutdown": false
}
}
}
Durable Functions 1.x
{
"extensions": {
"durableTask": {
"hubName": "MyTaskHub",
"controlQueueBatchSize": 32,
"partitionCount": 4,
"controlQueueVisibilityTimeout": "00:05:00",
"workItemQueueVisibilityTimeout": "00:05:00",
"maxConcurrentActivityFunctions": 10,
"maxConcurrentOrchestratorFunctions": 10,
"maxQueuePollingInterval": "00:00:30",
"azureStorageConnectionStringName": "AzureWebJobsStorage",
"trackingStoreConnectionStringName": "TrackingStorage",
"trackingStoreNamePrefix": "DurableTask",
"traceInputsAndOutputs": false,
"logReplayEvents": false,
"eventGridTopicEndpoint": "https://topic_name.westus2-1.eventgrid.azure.net/api/events",
"eventGridKeySettingName": "EventGridKey",
"eventGridPublishRetryCount": 3,
"eventGridPublishRetryInterval": "00:00:30",
"eventGridPublishEventTypes": ["Started", "Completed", "Failed", "Terminated"]
}
}
}
任务中心名称必须以字母开头且只能包含字母和数字。 如果未指定,则函数应用的默认任务中心名称是 DurableFunctionsHub。 有关详细信息,请参阅任务中心。
| properties | 默认 | 说明 |
|---|---|---|
| hubName | DurableFunctionsHub | 可以使用备用任务中心名称将多个 Durable Functions 应用程序彼此隔离,即使这些应用程序使用同一存储后端。 |
| controlQueueBatchSize | 32 | 要从控制队列中一次性拉取的消息数。 |
| controlQueueBufferThreshold | 256 | 一次可以在内存中缓冲的控制队列消息数,此时调度程序将等待,然后再将任何其他消息出队。 |
| partitionCount | 4 | 控制队列的分区计数。 可以是 1 到 16 之间的正整数。 |
| controlQueueVisibilityTimeout | 5 分钟 | 已取消排队的控制队列消息的可见性超时。 |
| workItemQueueVisibilityTimeout | 5 分钟 | 已取消排队的工作项队列消息的可见性超时。 |
| maxConcurrentActivityFunctions | 10 倍于当前计算机上的处理器数 | 可以在单个主机实例上并发处理的活动函数的最大数目。 |
| maxConcurrentOrchestratorFunctions | 10 倍于当前计算机上的处理器数 | 可以在单个主机实例上并发处理的业务流程协调程序函数的最大数目。 |
| maxQueuePollingInterval | 30 秒 | 最大的控制和工作项队列轮询时间间隔,采用 hh:mm:ss 格式。 值越高,可能导致的消息处理延迟也越高。 值越低,可能导致的存储成本会越高,因为存储事务数增高。 |
| azureStorageConnectionStringName | AzureWebJobsStorage | 应用设置的名称,其中的 Azure 存储连接字符串用于管理基础的 Azure 存储资源。 |
| trackingStoreConnectionStringName | 连接字符串的名称,用于“历史记录”和“实例”表。 如果未指定,则使用 connectionStringName (Durable 2.x) 或 azureStorageConnectionStringName (Durable 1.x) 连接。 |
|
| trackingStoreNamePrefix | 指定 trackingStoreConnectionStringName 时用于“历史记录”和“实例”表的前缀。 如果未设置,则默认前缀值为 DurableTask。 如果 trackingStoreConnectionStringName 未指定,则“历史记录”和“实例”表会使用 hubName 值作为其前缀,trackingStoreNamePrefix 的任何设置都会被忽略。 |
|
| traceInputsAndOutputs | false | 一个指示是否跟踪函数调用的输入和输出的值。 跟踪函数执行事件时的默认行为是在函数调用的序列化输入和输出中包括字节数。 此行为提供的有关输入和输出情况的信息是最少的,不会导致日志膨胀,也不会无意中将敏感信息公开。 将此属性设置为 true 会导致默认函数日志记录将函数输入和输出的整个内容都记录下来。 |
| logReplayEvents | false | 一个值,该值指示是否将业务流程重播事件写入到 Application Insights。 |
| eventGridTopicEndpoint | Azure 事件网格自定义主题终结点的 URL。 设置此属性后,业务流程生命周期通知事件就会发布到此终结点。 此属性支持应用设置解析。 | |
| eventGridKeySettingName | 应用设置的名称,该设置包含的密钥用于在 EventGridTopicEndpoint 上通过 Azure 事件网格自定义主题进行身份验证。 |
|
| eventGridPublishRetryCount | 0 | 发布到事件网格主题失败时要重试的次数。 |
| eventGridPublishRetryInterval | 5 分钟 | 事件网格发布重试间隔(采用 hh:mm:ss 格式)。 |
| eventGridPublishEventTypes | 要发布到事件网格的事件类型列表。 如果未指定,则将发布所有事件类型。 允许的值包括 Started、Completed、Failed、Terminated。 |
|
| useAppLease | 是 | 如果设置为 true,应用将要求在处理任务中心消息之前获取应用级别 blob 租约。 有关详细信息,请参阅灾难恢复和地理分布文档。 从 v2.3.0 开始可用。 |
| useLegacyPartitionManagement | 是 | 如果设置为 false,则将使用分区管理算法,该算法可减少在横向扩展时重复执行函数的可能性。从 v2.3.0 开始可用。 在将来的版本中,默认值将更改为 false。 |
| useGracefulShutdown | false | (预览)启用正常关闭以减少主机关闭导致进程内函数执行失败的机会。 |
许多此类设置用于优化性能。 有关详细信息,请参阅性能和规模。
后续步骤
历史资料。此文对应 2022-08-12 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 azfuncdf)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体、发布器占位标签和导航标记。
