Ligações para funções duráveis (Azure Functions)

Modelo de programação Python v2

Durable Functions é suportado no novo modelo de programação Python v2. Para usar o modelo v2, você deve instalar o Durable Functions SDK, que é o pacote azure-functions-durablePyPI, versão 1.2.2 ou uma versão posterior. Você também deve verificar host.json se seu aplicativo está fazendo referência aos Pacotes de Extensão versão 4.x para usar o modelo v2 com Funções Duráveis.

Você pode fornecer comentários e sugestões no repositório Durable Functions SDK for Python.

Quando você cria funções no .NET, o gatilho de orquestração é configurado usando o atributo OrchestrationTriggerAttribute .NET.

Para Java, a @DurableOrchestrationTrigger anotação é usada para configurar o gatilho de orquestração.

Quando você escreve funções de orquestrador, o gatilho de orquestração é definido pelo seguinte objeto JSON na bindings matriz do arquivo function.json :

{
    "name": "<Name of input parameter in function signature>",
    "orchestration": "<Optional - name of the orchestration>",
    "type": "orchestrationTrigger",
    "direction": "in"
}

• orchestration é o nome da orquestração que os clientes devem usar quando desejam iniciar novas instâncias dessa função do orquestrador. Esta propriedade é opcional. Se não for especificado, o nome da função será usado.

O Azure Functions suporta dois modelos de programação para Python. A maneira como você define um gatilho de orquestração depende do modelo de programação escolhido.

{
    "name": "<Name of input parameter in function signature>",
    "orchestration": "<Optional - name of the orchestration>",
    "type": "orchestrationTrigger",
    "direction": "in"
}

O atributo específico usado para definir o gatilho depende se você está executando suas funções C# em processo ou em um processo de trabalho isolado.

[FunctionName("HelloWorld")]
public static string Run([OrchestrationTrigger] IDurableOrchestrationContext context)
{
    string name = context.GetInput<string>();
    return $"Hello {name}!";
}

[Function("HelloWorld")]
public static string Run([OrchestrationTrigger] TaskOrchestrationContext context, string name)
{
    return $"Hello {name}!";
}

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

module.exports = df.orchestrator(function*(context) {
    const name = context.df.getInput();
    return `Hello ${name}!`;
});

param($Context)

$InputData = $Context.Input
$InputData

@FunctionName("HelloWorldOrchestration")
public String helloWorldOrchestration(
        @DurableOrchestrationTrigger(name = "ctx") TaskOrchestrationContext ctx) {
    return String.format("Hello %s!", ctx.getInput(String.class));
}

A maioria das funções do orquestrador chama funções de atividade, então aqui está um exemplo de "Hello World" que demonstra como chamar uma função de atividade:

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;
});

@FunctionName("HelloWorld")
public String helloWorldOrchestration(
        @DurableOrchestrationTrigger(name = "ctx") TaskOrchestrationContext ctx) {
    String input = ctx.getInput(String.class);
    String result = ctx.callActivity("SayHello", input, String.class).await();
    return result;
}

O gatilho de atividade é configurado usando o atributo .NET ActivityTriggerAttribute .

O gatilho de atividade é configurado usando a @DurableActivityTrigger anotação.

O gatilho de atividade é definido pelo seguinte objeto JSON na bindings matriz de function.json:

{
    "name": "<Name of input parameter in function signature>",
    "activity": "<Optional - name of the activity>",
    "type": "activityTrigger",
    "direction": "in"
}

• activity é o nome da atividade. Esse valor é o nome que as funções do orquestrador usam para invocar essa função de atividade. Esta propriedade é opcional. Se não for especificado, o nome da função será usado.

A maneira como você define um gatilho de atividade depende do modelo de programação escolhido.

{
    "name": "<Name of input parameter in function signature>",
    "activity": "<Optional - name of the activity>",
    "type": "activityTrigger",
    "direction": "in"
}

module.exports = async function(context) {
    return `Hello ${context.bindings.name}!`;
};

As ligações JavaScript também podem ser passadas como parâmetros adicionais, portanto, a mesma função pode ser simplificada da seguinte forma:

module.exports = async function(context, name) {
    return `Hello ${name}!`;
};

param($name)

"Hello $name!"

@FunctionName("SayHello")
public String sayHello(@DurableActivityTrigger(name = "name") String name) {
    return String.format("Hello %s!", name);
}

Por exemplo, você pode levar a entrada para sua vinculação de atividade e enviar uma mensagem para um Hub de Eventos usando a associação de saída de Hubs de Eventos:

{
  "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;
};

Você pode vincular ao cliente de orquestração usando o atributo DurableClientAttribute (OrchestrationClientAttribute em Durable Functions v1.x).

Você pode vincular ao cliente de orquestração usando a @DurableClientInput anotação.

O gatilho de cliente durável é definido pelo seguinte objeto JSON na bindings matriz de function.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 - Usado em cenários em que vários aplicativos de função compartilham a mesma conta de armazenamento, mas precisam ser isolados uns dos outros. Se não for especificado, o valor padrão de host.json será usado. Esse valor deve corresponder ao valor usado pelas funções do orquestrador de destino.
• connectionName - O nome de uma configuração de aplicativo que contém uma cadeia de conexão de conta de armazenamento. A conta de armazenamento representada por essa cadeia de conexão deve ser a mesma usada pelas funções do orquestrador de destino. Se não for especificado, a cadeia de conexão de conta de armazenamento padrão para o aplicativo de função será usada.

A maneira como você define um gatilho de cliente durável depende do modelo de programação escolhido.

{
    "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"
}

Você normalmente se liga a IDurableClient (DurableOrchestrationClient in Durable Functions v1.x), que lhe dá acesso total a todas as APIs de cliente de orquestração suportadas por Durable Functions.

Normalmente, DurableClientContext você se liga à classe.

Você deve usar o SDK específico do idioma para obter acesso a um objeto cliente.

function.json

{
  "bindings": [
    {
      "name": "input",
      "type": "queueTrigger",
      "queueName": "durable-function-trigger",
      "direction": "in"
    },
    {
      "name": "starter",
      "type": "durableClient",
      "direction": "in"
    }
  ]
}

index.js

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);
};

run.ps1

param([string] $input, $TriggerMetadata)

$InstanceId = Start-DurableOrchestration -FunctionName $FunctionName -Input $input

function.json

{
  "bindings": [
    {
      "name": "input",
      "type": "queueTrigger",
      "queueName": "durable-function-trigger",
      "direction": "in"
    },
    {
      "name": "starter",
      "type": "durableClient",
      "direction": "in"
    }
  ]
}

run.ps1

param([string]$InputData, $TriggerMetadata)

$InstanceId = Start-DurableOrchestration -FunctionName 'HelloWorld' -Input $InputData

@FunctionName("QueueStart")
public void queueStart(
        @QueueTrigger(name = "input", queueName = "durable-function-trigger", connection = "Storage") String input,
        @DurableClientInput(name = "durableContext") DurableClientContext durableContext) {
    // Orchestration input comes from the queue message content.
    durableContext.getClient().scheduleNewOrchestrationInstance("HelloWorld", input);
}

O gatilho de entidade é configurado usando o atributo .NET EntityTriggerAttribute .

O gatilho de entidade é definido pelo seguinte objeto JSON na bindings matriz de function.json:

{
    "name": "<Name of input parameter in function signature>",
    "entityName": "<Optional - name of the entity>",
    "type": "entityTrigger",
    "direction": "in"
}

Por padrão, o nome de uma entidade é o nome da função.

A maneira como você define um gatilho de entidade depende do modelo de programação escolhido.

{
    "name": "<Name of input parameter in function signature>",
    "entityName": "<Optional - name of the entity>",
    "type": "entityTrigger",
    "direction": "in"
}

Você pode vincular ao cliente de entidade usando o atributo .NET DurableClientAttribute em funções de biblioteca de classes .NET.

O cliente da entidade é definido pelo seguinte objeto JSON na bindings matriz de function.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 - Usado em cenários em que vários aplicativos de função compartilham a mesma conta de armazenamento, mas precisam ser isolados uns dos outros. Se não for especificado, o valor padrão de host.json será usado. Esse valor deve corresponder ao valor usado pelas funções da entidade de destino.
• connectionName - O nome de uma configuração de aplicativo que contém uma cadeia de conexão de conta de armazenamento. A conta de armazenamento representada por essa cadeia de conexão deve ser a mesma usada pelas funções da entidade de destino. Se não for especificado, a cadeia de conexão de conta de armazenamento padrão para o aplicativo de função será usada.

A maneira como você define um cliente de entidade depende do modelo de programação escolhido.

{
    "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"
}