Bindingen voor Durable Functions (Azure Functions)

Python v2-programmeermodel

Durable Functions wordt ondersteund in het nieuwe Python v2-programmeermodel. Als u het v2-model wilt gebruiken, moet u de Durable Functions SDK installeren. Dit is het PyPI-pakket azure-functions-durable, de versie 1.2.2 of een latere versie. U moet ook controleren host.json of uw app verwijst naar Extensiebundels versie 4.x om het v2-model te gebruiken met Durable Functions.

U kunt feedback en suggesties geven in de Durable Functions SDK voor Python-opslagplaats.

Wanneer u functies in .NET ontwerpt, wordt de orchestrationtrigger geconfigureerd met behulp van het . NET-kenmerk OrchestrationTriggerAttribute .

Voor Java wordt de @DurableOrchestrationTrigger aantekening gebruikt om de orchestrationtrigger te configureren.

Wanneer u orchestratorfuncties schrijft, wordt de orchestrationtrigger gedefinieerd door het volgende JSON-object in de bindings matrix van het function.json-bestand :

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

• orchestration is de naam van de orkestratie die klanten moeten gebruiken wanneer ze nieuwe exemplaren van deze orkestratiefunctie willen starten. Deze eigenschap is optioneel. Als dit niet is opgegeven, wordt de naam van de functie gebruikt.

Azure Functions ondersteunt twee programmeermodellen voor Python. De manier waarop u een orkestratietrigger definieert, is afhankelijk van het gekozen programmeermodel.

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

Het specifieke kenmerk dat wordt gebruikt voor het definiëren van de trigger, is afhankelijk van of u uw C# -functies in het proces of in een geïsoleerd werkproces uitvoert.

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

De meeste orchestratorfuncties roepen activiteitsfuncties aan, dus hier volgt een 'Hallo wereld'-voorbeeld dat laat zien hoe u een activiteitsfunctie aanroept:

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

De activiteitstrigger wordt geconfigureerd met behulp van het . NET-kenmerk ActivityTriggerAttribute .

De activiteitstrigger wordt geconfigureerd met behulp van de @DurableActivityTrigger aantekening.

De activiteitstrigger wordt gedefinieerd door het volgende JSON-object in de bindings matrix van function.json:

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

• activity is de naam van de activiteit. Deze waarde is de naam die orchestratorfuncties gebruiken om deze activiteitsfunctie aan te roepen. Deze eigenschap is optioneel. Als dit niet is opgegeven, wordt de naam van de functie gebruikt.

De manier waarop u een activiteitstrigger definieert, is afhankelijk van het gekozen programmeermodel.

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

JavaScript-bindingen kunnen ook worden doorgegeven als extra parameters, zodat dezelfde functie als volgt kan worden vereenvoudigd:

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

U kunt bijvoorbeeld de invoer naar uw activiteitsbinding nemen en een bericht verzenden naar een Event Hub met behulp van de Event Hubs-uitvoerbinding:

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

U kunt verbinding maken met de orchestration-client met behulp van het kenmerk DurableClientAttribute (OrchestrationClientAttribute in Durable Functions v1.x).

U kunt verbinding maken met de orchestratieclient met behulp van de @DurableClientInput annotatie.

De duurzame clienttrigger wordt gedefinieerd door het volgende JSON-object in de bindings matrix van 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 - Wordt gebruikt in scenario's waarin meerdere functie-apps hetzelfde opslagaccount delen, maar moeten worden geïsoleerd van elkaar. Als dit niet is opgegeven, wordt de standaardwaarde gebruikt host.json . Deze waarde moet overeenkomen met de waarde die wordt gebruikt door de doelorchestratorfuncties.
• connectionName - De naam van een app-instelling die een verbindingsreeks voor een opslagaccount bevat. Het opslagaccount dat wordt vertegenwoordigd door deze verbindingsreeks, moet hetzelfde zijn dat wordt gebruikt door de doelorchestratorfuncties. Als dit niet is opgegeven, wordt de standaard verbindingsreeks van het opslagaccount voor de functie-applicatie gebruikt.

De manier waarop u een duurzame clienttrigger definieert, is afhankelijk van het gekozen programmeermodel.

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

Doorgaans verbindt u zich met IDurableClient (DurableOrchestrationClient in Durable Functions v1.x), waarmee u volledige toegang krijgt tot alle orchestration-client-API's die worden ondersteund door Durable Functions.

Normaal gesproken bindt u aan de DurableClientContext klas.

U moet de taalspecifieke SDK gebruiken om toegang te krijgen tot een clientobject.

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

De entiteitstrigger wordt geconfigureerd met behulp van het .NET-kenmerk EntityTriggerAttribute .

De entiteittrigger wordt gedefinieerd door het volgende JSON-object in de bindings matrix van function.json:

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

De naam van een entiteit is standaard de naam van de functie.

De manier waarop u een entiteitstrigger definieert, is afhankelijk van het gekozen programmeermodel.

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

U kunt verbinding maken met de entiteitsclient met behulp van het . NET-kenmerk DurableClientAttribute in .NET-klassebibliotheekfuncties.

De entiteitsclient wordt gedefinieerd door het volgende JSON-object in de bindings matrix van 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 - Wordt gebruikt in scenario's waarin meerdere functie-apps hetzelfde opslagaccount delen, maar moeten worden geïsoleerd van elkaar. Als dit niet is opgegeven, wordt de standaardwaarde gebruikt host.json . Deze waarde moet overeenkomen met de waarde die wordt gebruikt door de doelentiteitsfuncties.
• connectionName - De naam van een app-instelling die een verbindingsreeks voor een opslagaccount bevat. Het opslagaccount dat wordt vertegenwoordigd door deze verbindingsreeks, moet dezelfde zijn die wordt gebruikt door de doelentiteitsfuncties. Als dit niet is opgegeven, wordt de standaard verbindingsreeks van het opslagaccount voor de functie-applicatie gebruikt.

De manier waarop u een entiteitsclient definieert, is afhankelijk van het gekozen programmeermodel.

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