Dapr-uitvoerbinding aanroepen voor Azure Functions

Met de Dapr-uitvoerbinding kunt u een andere Dapr-toepassing aanroepen tijdens een functie-uitvoering.

Zie het overzicht van de Dapr-extensie voor meer informatie over het instellen en configureren van de Dapr-extensie.

Opmerking

U kunt een C#-functie maken met behulp van een van de volgende C#-modi:

Uitvoeringsmodel	Beschrijving
Geïsoleerde werkrolmodel	Uw functiecode wordt uitgevoerd in een afzonderlijk .NET-werkproces. Gebruiken met ondersteunde versies van .NET en .NET Framework. Zie .NET geïsoleerde werkprocesfuncties ontwikkelen voor meer informatie.
Model in proces	Uw functiecode wordt uitgevoerd in hetzelfde proces als het Functions-hostproces. Ondersteunt alleen LTS-versies (Long Term Support) van .NET. Zie .NET-klassebibliotheekfuncties ontwikkelen voor meer informatie.

In-proces

In het volgende voorbeeld ziet u hoe u een Dapr-uitvoerbinding gebruikt om een aanroepbewerking van de Dapr-service uit te voeren die wordt gehost in een andere met Dapr geïnitieerde toepassing. In dit voorbeeld fungeert de functie als een proxy.

[FunctionName("InvokeOutputBinding")]
public static async Task<IActionResult> Run(
    [HttpTrigger(AuthorizationLevel.Function, "get", Route = "invoke/{appId}/{methodName}")] HttpRequest req,
    [DaprInvoke(AppId = "{appId}", MethodName = "{methodName}", HttpVerb = "post")] IAsyncCollector<InvokeMethodParameters> output,
    ILogger log)
{
    log.LogInformation("C# HTTP trigger function processed a request.");

    string requestBody = await new StreamReader(req.Body).ReadToEndAsync();

    var outputContent = new InvokeMethodParameters
    {
        Body = requestBody
    };

    await output.AddAsync(outputContent);

    return new OkResult();
}

Geïsoleerd proces

Meer voorbeelden voor de Dapr-uitvoerbinding zijn beschikbaar in de GitHub-opslagplaats.

[Function("InvokeOutputBinding")]
[DaprInvokeOutput(AppId = "{appId}", MethodName = "{methodName}", HttpVerb = "post")]
public static async Task<InvokeMethodParameters> Run(
    [HttpTrigger(AuthorizationLevel.Function, "get", "post", Route = "invoke/{appId}/{methodName}")] HttpRequestData req, FunctionContext functionContext)
{
    var log = functionContext.GetLogger("InvokeOutputBinding");
    log.LogInformation("C# HTTP trigger function processed a request.");

    string requestBody = await new StreamReader(req.Body).ReadToEndAsync();

    var outputContent = new InvokeMethodParameters
    {
        Body = requestBody
    };

    return outputContent;
}

In het volgende voorbeeld wordt een "InvokeOutputBinding" functie gemaakt met behulp van de DaprInvokeOutput binding met een HttpTrigger:

@FunctionName("InvokeOutputBinding")
public String run(
        @HttpTrigger(
            name = "req",
            methods = {HttpMethod.GET, HttpMethod.POST},
            authLevel = AuthorizationLevel.ANONYMOUS,
            route = "invoke/{appId}/{methodName}")
            HttpRequestMessage<Optional<String>> request,
        @DaprInvokeOutput(
            appId = "{appId}", 
            methodName = "{methodName}", 
            httpVerb = "post")
        OutputBinding<String> payload,
        final ExecutionContext context)

Node.js v4

In het volgende voorbeeld wordt de Dapr-uitvoerbinding gekoppeld aan een HTTP-trigger, die is geregistreerd door het app object:

const { app, trigger } = require('@azure/functions');

app.generic('InvokeOutputBinding', {
    trigger: trigger.generic({
        type: 'httpTrigger',
        authLevel: 'anonymous',
        methods: ['POST'],
        route: "invoke/{appId}/{methodName}",
        name: "req"
    }),
    return: daprInvokeOutput,
    handler: async (request, context) => {
        context.log("Node HTTP trigger function processed a request.");

        const payload = await request.text();
        context.log(JSON.stringify(payload));

        return { body: payload };
    }
});

Node.js v3

In de volgende voorbeelden ziet u Dapr-triggers in een function.json-bestand en JavaScript-code die gebruikmaakt van deze bindingen.

Dit is het function.json-bestand voor daprInvoke:

{
  "bindings":
    {
      "type": "daprInvoke",
      "direction": "out",
      "appId": "{appId}",
      "methodName": "{methodName}",
      "httpVerb": "post",
      "name": "payload"
    }
}

Zie de sectie Configuratie voor meer informatie over function.json bestandseigenschappen.

Dit is de JavaScript-code:

module.exports = async function (context, req) {
    context.log("Node HTTP trigger function processed a request.");
    context.bindings.output = { body: req.body };
    context.done(null);
};

In de volgende voorbeelden ziet u Dapr-triggers in een function.json-bestand en PowerShell-code die gebruikmaakt van deze bindingen.

Dit is het function.json-bestand voor daprInvoke:

{
  "bindings":
    {
      "type": "daprInvoke",
      "direction": "out",
      "appId": "{appId}",
      "methodName": "{methodName}",
      "httpVerb": "post",
      "name": "payload"
    }
}

Zie de sectie Configuratie voor meer informatie over function.json bestandseigenschappen.

In code:

using namespace System.Net

# Input bindings are passed in via param block.
param($req, $TriggerMetadata)

# Write to the Azure Functions log stream.
Write-Host "Powershell InvokeOutputBinding processed a request."

$req_body = $req.Body

$invoke_output_binding_req_body = @{
    "body" = $req_body
}

# Associate values to output bindings by calling 'Push-OutputBinding'.
Push-OutputBinding -Name payload -Value $invoke_output_binding_req_body

Push-OutputBinding -Name res -Value ([HttpResponseContext]@{
    StatusCode = [HttpStatusCode]::OK
    Body = $req_body
})

Python v2

In het volgende voorbeeld ziet u een Dapr Invoke-uitvoerbinding, die gebruikmaakt van het v2 Python-programmeermodel. Ga als volgt te werk om deze te gebruiken daprInvoke in de code van uw Python-functie-app:

import logging
import json
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="InvokeOutputBinding")
@app.route(route="invoke/{appId}/{methodName}", auth_level=dapp.auth_level.ANONYMOUS)
@app.dapr_invoke_output(arg_name = "payload", app_id = "{appId}", method_name = "{methodName}", http_verb = "post")
def main(req: func.HttpRequest, payload: func.Out[str] ) -> str:
    # request body must be passed this way "{\"body\":{\"value\":{\"key\":\"some value\"}}}" to use the InvokeOutputBinding, all the data must be enclosed in body property.
    logging.info('Python function processed a InvokeOutputBinding request from the Dapr Runtime.')

    body = req.get_body()
    logging.info(body)
    if body is not None:
        payload.set(body)
    else:
        logging.info('req body is none')
    return 'ok'

Python v1

In het volgende voorbeeld ziet u een Dapr Invoke-uitvoerbinding, die gebruikmaakt van het python-programmeermodel v1.

Dit is het function.json-bestand voor daprInvoke:

{
  "scriptFile": "__init__.py",
  "bindings":
    {
      "type": "daprInvoke",
      "direction": "out",
      "appId": "{appId}",
      "methodName": "{methodName}",
      "httpVerb": "post",
      "name": "payload"
    }
}

Zie de sectie Configuratie voor meer informatie over function.json bestandseigenschappen deze eigenschappen.

Dit is de Python-code:

def main(req: func.HttpRequest,
         payload: func.Out[bytes]) -> func.HttpResponse:
    logging.info('Python InvokeOutputBinding processed a request.')
    data = req.params.get('data')

Kenmerken

In-proces

Gebruik in het procesmodel het DaprInvoke kenmerk om een Dapr-uitvoerbinding te definiëren die ondersteuning biedt voor deze parameters:

Parameter	Description	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
AppId	De Dapr-app-id die moet worden aangeroepen.	✔️	✔️
MethodName	De methodenaam van de app die moet worden aangeroepen.	✔️	✔️
HttpVerb	Optioneel. HTTP-werkwoord voor het gebruik van de app die moet worden aangeroepen. Standaard is POST.	✔️	✔️
Tekst	Vereist. De hoofdtekst van de aanvraag.	❌	✔️

Geïsoleerd proces

Gebruik in het geïsoleerde werkrolmodel het DaprInvokeOutput kenmerk om een Dapr-uitvoerbinding te definiëren die ondersteuning biedt voor deze parameters:

Parameter	Description	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
AppId	De Dapr-app-id die moet worden aangeroepen.	✔️	✔️
MethodName	De methodenaam van de app die moet worden aangeroepen.	✔️	✔️
HttpVerb	Optioneel. HTTP-werkwoord voor het gebruik van de app die moet worden aangeroepen. Standaard is POST.	✔️	✔️
Tekst	Vereist. De hoofdtekst van de aanvraag.	❌	✔️

Aantekeningen

Met de DaprInvokeOutput aantekening kunt u uw functie aanroepen en luisteren naar een uitvoerbinding.

Element	Beschrijving	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
Appid	De app-id van de toepassing die betrokken is bij de aanroepbinding.	✔️	✔️
methodName	De naam van de methodevariabele.	✔️	✔️
httpVerb	Posten of ophalen.	✔️	✔️
hoofdtekst	Vereist. De hoofdtekst van de aanvraag.	❌	✔️

Configuratie

Node.js v4

In de volgende tabel worden de bindingsconfiguratie-eigenschappen uitgelegd die u in de code hebt ingesteld.

Eigenschappen	Beschrijving	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
Appid	De app-id van de toepassing die betrokken is bij de aanroepbinding.	✔️	✔️
Methoden	Posten of ophalen.	✔️	✔️
hoofdtekst	Vereist. De hoofdtekst van de aanvraag.	❌	✔️

Node.js v3

In de volgende tabel worden de bindingsconfiguratie-eigenschappen uitgelegd die u in het function.json-bestand hebt ingesteld.

function.json-eigenschap	Beschrijving	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
Appid	De app-id van de toepassing die betrokken is bij de aanroepbinding.	✔️	✔️
methodName	De naam van de methodevariabele.	✔️	✔️
httpVerb	Posten of ophalen.	✔️	✔️
hoofdtekst	Vereist. De hoofdtekst van de aanvraag.	❌	✔️

In de volgende tabel worden de bindingsconfiguratie-eigenschappen uitgelegd die u in het function.json-bestand hebt ingesteld.

function.json-eigenschap	Beschrijving	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
Appid	De app-id van de toepassing die betrokken is bij de aanroepbinding.	✔️	✔️
methodName	De naam van de methodevariabele.	✔️	✔️
httpVerb	Posten of ophalen.	✔️	✔️
hoofdtekst	Vereist. De hoofdtekst van de aanvraag.	❌	✔️

Python v2

In de volgende tabel worden de bindingsconfiguratie-eigenschappen @dapp.dapr_invoke_output uitgelegd die u in uw Python-code hebt ingesteld.

Eigenschappen	Beschrijving	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
app_id	De app-id van de toepassing die betrokken is bij de aanroepbinding.	✔️	✔️
method_name	De naam van de methodevariabele.	✔️	✔️
http_verb	Ingesteld op post of get.	✔️	✔️
hoofdtekst	Vereist. De hoofdtekst van de aanvraag.	❌	✔️

Python v1

In de volgende tabel worden de bindingsconfiguratie-eigenschappen uitgelegd die u in het function.json-bestand hebt ingesteld.

function.json-eigenschap	Beschrijving	Kan worden verzonden via kenmerk	Kan worden verzonden via RequestBody
Appid	De app-id van de toepassing die betrokken is bij de aanroepbinding.	✔️	✔️
methodName	De naam van de methodevariabele.	✔️	✔️
httpVerb	Posten of ophalen.	✔️	✔️
hoofdtekst	Vereist. De hoofdtekst van de aanvraag.	❌	✔️

Als eigenschappen zijn gedefinieerd in zowel kenmerken als RequestBody, wordt prioriteit gegeven aan gegevens die zijn opgegeven in RequestBody.

Zie de sectie Voorbeeld voor volledige voorbeelden.

Gebruik

Als u de Uitvoerbinding voor aanroepen van de Dapr-service wilt gebruiken, vindt u meer informatie over het gebruik van dapr-service-aanroep in de officiële Dapr-documentatie.

Python v2

Als u het daprInvoke project in Python v2 wilt gebruiken, stelt u uw project in met de juiste afhankelijkheden.

1. Een virtuele omgeving maken en activeren.

2. Voeg in het requirements.text bestand de volgende regel toe:

   azure-functions==1.18.0b3
   

3. Installeer de Python-bibliotheek in de terminal.

   pip install -r .\requirements.txt
   

4. Wijzig uw local.setting.json bestand met de volgende configuratie:

   "PYTHON_ISOLATE_WORKER_DEPENDENCIES":1
   

Python v1

Voor het Python v1-model zijn geen aanvullende wijzigingen vereist, afgezien van het instellen van de onderdelen voor het aanroepen van de service.

Volgende stappen

Meer informatie over aanroepen van dapr-services.