Referentiehandleiding voor Azure Functions-ontwikkelaars voor Python-apps

Aan de slag

Kies de omgeving die past bij uw werkstroom en spring in Azure Functions voor Python:

• Visual Studio Code Quickstart
• Core Tools Quickstart

In het Python v1-programmeermodel wordt elke functie gedefinieerd als een globale, staatloze main() methode in een bestand met de naam __init__.py. De triggers en bindingen van de functie worden afzonderlijk geconfigureerd in een function.json bestand en de bindingswaarden name worden gebruikt als parameters in uw main() methode.

Voorbeeld

Hier volgt een eenvoudige functie die reageert op een HTTP-aanvraag:

# __init__.py
def main(req):
    user = req.params.get('user')
    return f'Hello, {user}!'

Dit is het bijbehorende function.json bestand:

{
    "scriptFile": "__init__.py",
    "bindings": [
        {
            "authLevel": "function",
            "type": "httpTrigger",
            "direction": "in",
            "name": "req",
            "methods": [
                "get",
                "post"
            ]
        },
        {
            "type": "http",
            "direction": "out",
            "name": "$return"
        }
    ]
}

Belangrijke concepten

• De functie heeft één HTTP-trigger.
• Het HttpRequest-object bevat aanvraagheaders, queryparameters, routeparameters en de hoofdtekst van het bericht. Met deze functie wordt de waarde van de name queryparameter opgehaald uit de params parameter van het HttpRequest-object .
• Als u een naam in dit voorbeeld wilt verzenden, voegt u deze toe aan ?name={name} de weergegeven functie-URL. Als u bijvoorbeeld lokaal werkt, kan http://localhost:7071/api/http_trigger?name=Test de volledige URL er als volgt uitzien. Zie Triggers en bindingen voor voorbeelden van het gebruik van bindingen.

Gebruik de azure-functions SDK en voeg typeaantekeningen toe om ondersteuning voor IntelliSense en editor te verbeteren:

# __init__.py
import azure.functions as func

def http_trigger(req: func.HttpRequest) -> str:

# requirements.txt
azure-functions

De azure-functions bibliotheek

De azure-functions Python-bibliotheek biedt de kerntypen die worden gebruikt voor interactie met de Azure Functions-runtime. Als u alle beschikbare typen en methoden wilt zien, gaat u naar de azure-functions API. Uw functiecode kan het volgende gebruiken azure-functions :

• Invoergegevens van Access-trigger (bijvoorbeeld HttpRequest, TimerRequest)
• Uitvoerwaarden maken (zoals HttpResponse)
• Interactie met door runtime geleverde context en bindingsgegevens

Als u azure-functions in uw app gebruikt, moet deze zijn opgenomen in uw projectafhankelijkheden.

Alternatief toegangspunt

U kunt het standaardgedrag van een functie wijzigen door de scriptFile en entryPoint eigenschappen in het function.json bestand op te geven. Het volgende function.json bestand leidt de runtime bijvoorbeeld om de custom_entry() methode in het main.py bestand te gebruiken als het toegangspunt voor uw Azure-functie.

{
  "scriptFile": "main.py",
  "entryPoint": "custom_entry",
  "bindings": [
      ...
  ]
}

Mapstructuur

Gebruik de volgende structuur voor een Python Azure Functions-project:

<project_root>/
│
├── .venv/                   # (Optional) Local Python virtual environment
├── .vscode/                 # (Optional) VS Code workspace settings
│
├── my_first_function/       # Function directory
│   └── __init__.py          # Function code file
│   └── function.json        # Function binding configuration file
│
├── my_second_function/
│   └── __init__.py  
│   └── function.json 
│
├── shared/                  # (Optional) Pure helper code with no triggers/bindings
│   └── utils.py
│
├── additional_functions/    # (Optional) Contains blueprints for organizing related Functions
│   └── blueprint_1.py  
│
├── tests/                   # (Optional) Unit tests for your functions
│   └── test_my_function.py
│
├── .funcignore              # Excludes files from being published
├── host.json                # Global function app configuration
├── local.settings.json      # Local-only app settings (not published)
├── requirements.txt         # (Optional) Defines Python dependencies for remote build
├── Dockerfile               # (Optional) For custom container deployment

Belangrijke bestanden en mappen

In het Python v2-programmeermodel gebruikt Azure Functions een op decorator gebaseerde benadering om triggers en bindingen rechtstreeks in uw code te definiëren. Elke functie wordt geïmplementeerd als een globale, staatloze methode in een function_app.py bestand.

Voorbeeld

Hier volgt een eenvoudige functie die reageert op een HTTP-aanvraag:

import azure.functions as func

app = func.FunctionApp()

@app.route("hello")
def http_trigger(req):
    user = req.params.get("user")
    return f"Hello, {user}!"

# requirements.txt
azure-functions

Belangrijke concepten

• De code importeert het azure-functions pakket en gebruikt decorators en typen om de functie-app te definiëren.
• De functie heeft één HTTP-trigger.
• Het HttpRequest-object bevat aanvraagheaders, queryparameters, routeparameters en de hoofdtekst van het bericht. Met deze functie wordt de waarde van de name queryparameter opgehaald uit de params parameter van het HttpRequest-object .
• Als u een naam in dit voorbeeld wilt verzenden, voegt u deze toe aan ?name={name} de weergegeven functie-URL. Als u bijvoorbeeld lokaal werkt, kan http://localhost:7071/api/http_trigger?name=Test de volledige URL er als volgt uitzien. Zie Triggers en bindingen voor voorbeelden van het gebruik van bindingen.

De azure-functions bibliotheek

De azure-functions Python-bibliotheek is een belangrijk onderdeel van het Azure Functions-programmeermodel. Het biedt de decorators, trigger- en bindingstypen en aanvraag-/antwoordobjecten die worden gebruikt om functies tijdens runtime te definiëren en ermee te communiceren. Als u alle beschikbare typen en decorators wilt zien, gaat u naar de azure-functions API. De code van uw functie-app is afhankelijk van deze bibliotheek voor het volgende:

• Alle functies definiëren met behulp van het FunctionApp object
• Triggers en bindingen declareren (bijvoorbeeld @app.route, @app.timer_trigger)
• Toegewezen toegang tot getypte invoer en uitvoer (zoals HttpRequest en HttpResponse, en Uit`)

De azure-functions moet worden opgenomen in de projectafhankelijkheden. Zie pakketbeheer voor meer informatie.

Typeaantekeningen gebruiken om ondersteuning voor IntelliSense en editor te verbeteren:

def http_trigger(req: func.HttpRequest) -> str:

Organiseren met blauwdrukken

Voor grotere of modulaire apps gebruikt u blauwdrukken om functies in afzonderlijke Python-bestanden te definiëren en deze te registreren bij uw hoofd-app. Met deze scheiding blijft uw code georganiseerd en herbruikbaar.

Een blauwdruk definiëren en registreren:

1. Een blauwdruk definiëren in een ander Python-bestand, zoals http_blueprint.py:

   import azure.functions as func
   
   bp = func.Blueprint()
   
   @bp.route(route="default_template")
   def default_template(req: func.HttpRequest) -> func.HttpResponse:
       return func.HttpResponse("Hello World!")
   

2. Registreer de blauwdruk in het hoofdbestand function_app.py :

   import azure.functions as func
   from http_blueprint import bp
   
   app = func.FunctionApp()
   app.register_functions(bp)
   

Met behulp van blauwdrukken kunt u het volgende doen:

• Uw app opsplitsen in herbruikbare modules
• Gerelateerde functies gegroepeerd houden op bestand of functie
• Blauwdrukken uitbreiden of delen over projecten heen

Mapstructuur

Gebruik de volgende structuur voor een Python Azure Functions-project:

<project_root>/
│
├── .venv/                   # (Optional) Local Python virtual environment
├── .vscode/                 # (Optional) VS Code workspace settings
│
├── function_app.py          # Main function entry point (decorator model)
├── shared/                  # (Optional) Pure helper code with no triggers/bindings
│   └── utils.py
│
├── additional_functions/    # (Optional) Contains blueprints for organizing related Functions
│   └── blueprint_1.py  
│
├── tests/                   # (Optional) Unit tests for your functions
│   └── test_my_function.py
│
├── .funcignore              # Excludes files from being published
├── host.json                # Global function app configuration
├── local.settings.json      # Local-only app settings (not published)
├── requirements.txt         # (Optional) Defines Python dependencies for remote build
├── Dockerfile               # (Optional) For custom container deployment

Belangrijke bestanden en mappen

Voorbeeld: Timertrigger met Blob-invoer

Deze functie:

• Triggers elke 10 minuten
• Leesbewerkingen uit een blob met behulp van SDK-typebindingen
• Slaat resultaten en schrijfbewerkingen op in een tijdelijk bestand

import azure.functions as func
import azurefunctions.extensions.bindings.blob as blob
import logging
import tempfile

CACHED_BLOB_DATA = None

app = func.FunctionApp()

@app.function_name(name="TimerTriggerWithBlob")
@app.schedule(schedule="0 */10 * * * *", arg_name="mytimer")
@app.blob_input(arg_name="client",
                path="PATH/TO/BLOB",
                connection="BLOB_CONNECTION_SETTING")
def timer_trigger_with_blob(mytimer: func.TimerRequest,
                            client: blob.BlobClient,
                            context: func.Context) -> None:
    global CACHED_BLOB_DATA
    if CACHED_BLOB_DATA is None:
        # Download blob and save as a global variable
        CACHED_BLOB_DATA = client.download_blob().readall()

        # Create temp file prefix
        my_prefix = context.invocation_id
        temp_file = tempfile.NamedTemporaryFile(prefix=my_prefix)
        temp_file.write(CACHED_BLOB_DATA)
        logging.info(f"Cached data written to {temp_file.name}")

Belangrijke concepten

• Gebruik SDK-typebindingen om te werken met uitgebreide typen. Zie SDK-typebindingen voor meer informatie.
• U kunt globale variabelen gebruiken om dure berekeningen in de cache te zetten, maar hun toestand wordt niet gegarandeerd behouden bij uitvoeringen van functies.
• Tijdelijke bestanden worden opgeslagen in tmp/ en blijven niet gegarandeerd behouden tussen aanroepen of uitschaalinstanties.
• U hebt toegang tot de aanroepcontext van een functie via de contextklasse.

# __init__.py
import azure.functions as func

def main(req: func.HttpRequest,
         documents: func.DocumentList,
         event: func.Out[str]) -> func.HttpResponse:

    # Content from HttpRequest and Cosmos DB input
    http_content = req.params.get("body")
    doc_id = documents[0]["id"] if documents else "No documents found"

    event.set(f"HttpRequest content: {http_content} | CosmosDB ID: {doc_id}")

    return func.HttpResponse(
        "Function executed successfully.",
        status_code=200
    )

// function.json
{
  "scriptFile": "__init__.py",
  "entryPoint": "main",
  "bindings": [
    {
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"],
      "route": "file"
    },
    {
      "type": "http",
      "direction": "out",
      "name": "$return"
    },
    {
      "type": "cosmosDB",
      "direction": "in",
      "name": "documents",
      "databaseName": "test",
      "containerName": "items",
      "id": "cosmosdb-input-test",
      "connection": "COSMOSDB_CONNECTION_SETTING"
    },
    {
      "type": "eventHub",
      "direction": "out",
      "name": "event",
      "eventHubName": "my-test-eventhub",
      "connection": "EVENTHUB_CONNECTION_SETTING"
    }
  ]
}

belangrijke concepten

• Elke functie heeft één trigger, maar kan meerdere bindingen hebben.
• Voeg invoer toe door de direction waarde 'in' op te geven in function.json. Uitvoer heeft een direction van out.
• U kunt toegang krijgen tot aanvraagdetails via het HttpRequest object en een aangepaste HttpResponse maken met headers, statuscode en hoofdtekst.

import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="HttpTriggerWithCosmosDB")
@app.route(route="file")
@app.cosmos_db_input(arg_name="documents",
                     database_name="test",
                     container_name="items",
                     connection="COSMOSDB_CONNECTION_SETTING")
@app.event_hub_output(arg_name="event",
                      event_hub_name="my-test-eventhub",
                      connection="EVENTHUB_CONNECTION_SETTING")
def http_trigger_with_cosmosdb(req: func.HttpRequest,
                               documents: func.DocumentList,
                               event: func.Out[str]) -> func.HttpResponse:
    # Content from HttpRequest and Cosmos DB input
    http_content = req.params.get('body')
    doc_id = documents[0]['id']

    event.set("HttpRequest content: " + http_content
              + " | CosmosDB ID: " + doc_id)

    return func.HttpResponse(
        f"Function executed successfully.",
        status_code=200
    )

Belangrijke concepten

• Gebruik @route() of triggerspecifieke decorators (@timer_trigger, @queue_trigger en andere) om te definiëren hoe uw functie wordt aangeroepen.
• Voeg invoer toe met behulp van decorators zoals @blob_input, @queue_inputen andere.
• Uitvoer kan het volgende zijn:
  • Rechtstreeks geretourneerd (als er slechts één uitvoer is)
  • Toegewezen met behulp van Out bindingen en de .set() methode voor meerdere uitvoer.
• U kunt toegang krijgen tot aanvraagdetails via het HttpRequest object en een aangepaste HttpResponse maken met headers, statuscode en hoofdtekst.

SDK-typebindingen

Voor geselecteerde triggers en bindingen kunt u werken met gegevenstypen die zijn geïmplementeerd door de onderliggende Azure SDK's en frameworks. Door deze SDK-typebindingen te gebruiken, kunt u communiceren met bindingsgegevens alsof u de onderliggende service-SDK gebruikt. Zie ondersteunde SDK-typebindingen voor meer informatie.

import azure.functions as func
import requests

def main(req: func.HttpRequest) -> func.HttpResponse:
    r = requests.get("https://api.github.com")
    return func.HttpResponse(f"Status: {r.status_code}")

import azure.functions as func
import requests

app = func.FunctionApp()

@app.function_name(name="HttpExample")
@app.route(route="call_api")
def main(req: func.HttpRequest) -> func.HttpResponse:
    r = requests.get("https://api.github.com")
    return func.HttpResponse(f"Status: {r.status_code}")

# function_app.py
import azure.functions as func

app = func.FunctionApp(http_auth_level=func.AuthLevel.ANONYMOUS)

@app.route(route="http_trigger")
def http_trigger(req: func.HttpRequest) -> func.HttpResponse:
    return "Hello, World!"

# Test the function directly
print(http_trigger(None))

Als u de uitvoer wilt zien, voert u het bestand rechtstreeks uit met Python:

> python function_app.py

Hello, World!

# __init__.py
import azure.functions as func

def main(req: func.HttpRequest) -> func.HttpResponse:
    return func.HttpResponse("Hello, World!")

# Test the function directly
print(main(None))

Als u de uitvoer wilt zien, voert u het bestand rechtstreeks uit met Python:

> python __init__.py

Hello, World!

• Versiebeheer voor runtime: u kunt uw app nu desgewenst vastmaken of upgraden naar specifieke Python-werkrolversies door te verwijzen naar het azure-functions-runtime pakket in uw requirements.txt.

  • Als versiebeheer niet is ingeschakeld, wordt uw app uitgevoerd op een standaardversie van de Python-runtime, die door Functions wordt beheerd. U moet uw requirements.txt-bestand wijzigen om de meest recente uitgebrachte versie, een vooraf uitgebrachte versie aan te vragen of uw app vast te maken aan een specifieke versie van de Python-runtime.

  • U schakelt runtimeversiebeheer in door een verwijzing naar het Python-runtimepakket toe te voegen aan uw requirements.txt-bestand , waarbij de waarde die aan het pakket is toegewezen, bepaalt welke runtimeversie wordt gebruikt.

  • Vermijd het koppelen van een productie-app aan prerelease (alfa, bèta of dev) runtimeversies.

  • Als u rekening wilt houden met wijzigingen, bekijkt u regelmatig de releaseopmerkingen voor Python Runtime .

  • De volgende tabel geeft het versiegedrag aan op basis van de versiewaarde van deze instelling in uw requirements.txt-bestand :

    Versie	Example	Gedrag
    Geen waarde ingesteld	azure-functions-runtime	Uw Python 3.13+-app wordt uitgevoerd op de nieuwste beschikbare versie van de Functions Python-runtime. Deze optie is het beste om op de hoogte te blijven van platformverbeteringen en -functies, omdat uw app automatisch de meest recente stabiele runtime-updates ontvangt.
    Vastgemaakt aan een specifieke versie	azure-functions-runtime==1.2.0	Uw Python 3.13+-app blijft op de vastgemaakte runtimeversie staan en ontvangt geen automatische updates. U moet in plaats daarvan uw vastgemaakte versie handmatig bijwerken om te profiteren van nieuwe functies, fixes en verbeteringen in de runtime. Vastmaken wordt aanbevolen voor kritieke productieworkloads, waarbij stabiliteit en voorspelbaarheid essentieel zijn. Door vast te zetten kunt u uw app ook testen op pre-release-runtimeversies tijdens de ontwikkeling.
    Geen pakketreferentie	n/a	Als u de azure-functions-runtimePython 3.13+-app niet instelt, wordt deze uitgevoerd op een standaardversie van de Python-runtime die zich achter de nieuwste uitgebrachte versie bevindt. Updates worden periodiek uitgevoerd door Functions. Deze optie zorgt voor stabiliteit en brede compatibiliteit. De toegang tot de nieuwste functies en oplossingen wordt echter uitgesteld totdat de standaardversie wordt bijgewerkt.

• Afhankelijkheidsisolatie: de afhankelijkheden van uw app (zoals grpcio of protobuf) zijn volledig geïsoleerd van de afhankelijkheden van de workerprocessen, waardoor versieconflicten worden voorkomen. De app-instelling PYTHON_ISOLATE_WORKER_DEPENDENCIES heeft geen invloed op apps die worden uitgevoerd op Python 3.13 of hoger.

• Vereenvoudigde instellingen voor HTTP-streaming : er zijn geen speciale app-instellingen vereist.

• Ondersteuning voor werkrolextensies en gedeelde geheugenfuncties is verwijderd.

• Versiebeheer voor runtime: u kunt uw app nu desgewenst vastmaken of upgraden naar specifieke Python-werkrolversies door te verwijzen naar het azure-functions-runtime-v1 pakket in uw requirements.txt.

  • Als versiebeheer niet is ingeschakeld, wordt uw app uitgevoerd op een standaardversie van de Python-runtime, die door Functions wordt beheerd. U moet uw requirements.txt-bestand wijzigen om de meest recente uitgebrachte versie, een vooraf uitgebrachte versie aan te vragen of uw app vast te maken aan een specifieke versie van de Python-runtime.

  • U schakelt runtimeversiebeheer in door een verwijzing naar het Python-runtimepakket toe te voegen aan uw requirements.txt-bestand , waarbij de waarde die aan het pakket is toegewezen, bepaalt welke runtimeversie wordt gebruikt.

  • Vermijd het koppelen van een productie-app aan prerelease (alfa, bèta of dev) runtimeversies.

  • Als u rekening wilt houden met wijzigingen, bekijkt u regelmatig de releaseopmerkingen voor Python Runtime .

  • De volgende tabel geeft het versiegedrag aan op basis van de versiewaarde van deze instelling in uw requirements.txt-bestand :

    Versie	Example	Gedrag
    Geen waarde ingesteld	azure-functions-runtime-v1	Uw Python 3.13+-app wordt uitgevoerd op de nieuwste beschikbare versie van de Functions Python-runtime. Deze optie is het beste om op de hoogte te blijven van platformverbeteringen en -functies, omdat uw app automatisch de meest recente stabiele runtime-updates ontvangt.
    Vastgemaakt aan een specifieke versie	azure-functions-runtime-v1==1.2.0	Uw Python 3.13+-app blijft op de vastgemaakte runtimeversie staan en ontvangt geen automatische updates. U moet in plaats daarvan uw vastgemaakte versie handmatig bijwerken om te profiteren van nieuwe functies, fixes en verbeteringen in de runtime. Vastmaken wordt aanbevolen voor kritieke productieworkloads, waarbij stabiliteit en voorspelbaarheid essentieel zijn. Met het vastzetten kunt u uw app ook testen op prerelease-runtimeversies tijdens de ontwikkeling.
    Geen pakketreferentie	n/a	Als u de azure-functions-runtime-v1Python 3.13+-app niet instelt, wordt deze uitgevoerd op een standaardversie van de Python-runtime die zich achter de nieuwste uitgebrachte versie bevindt. Updates worden periodiek uitgevoerd door Functions. Deze optie zorgt voor stabiliteit en brede compatibiliteit. De toegang tot de nieuwste functies en oplossingen wordt echter uitgesteld totdat de standaardversie wordt bijgewerkt.

• Afhankelijkheidsisolatie: de afhankelijkheden van uw app (zoals grpcio of protobuf) zijn volledig geïsoleerd van de afhankelijkheden van de worker, waardoor versieconflicten worden voorkomen. De app-instelling PYTHON_ISOLATE_WORKER_DEPENDENCIES heeft geen invloed op apps die worden uitgevoerd op Python 3.13 of hoger.

• Ondersteuning voor werkrolextensies en gedeelde geheugenfuncties is verwijderd.

import logging
import azure.functions as func

def main(req: func.HttpRequest) -> func.HttpResponse:
    logging.debug("Example debug log")
    logging.info("Example info log")
    logging.warning("Example warning")
    logging.error("Example error log")
    return func.HttpResponse("OK")

import logging
import azure.functions as func

app = func.FunctionApp()

@app.route(route="http_trigger")
def http_trigger(req) -> func.HttpResponse:
    logging.debug("Example debug log")
    logging.info("Example info log")
    logging.warning("Example warning")
    logging.error("Example error log")
    return func.HttpResponse("OK")

import logging
import threading
import azure.functions as func

def main(req: func.HttpRequest, context) -> func.HttpResponse:
    logging.info("Function started")
    t = threading.Thread(target=log_from_thread, args=(context,))
    t.start()
    return "okay"

def log_from_thread(context):
    # Associate the thread with the current invocation
    context.thread_local_storage.invocation_id = context.invocation_id  
    logging.info("Logging from a background thread")

import azure.functions as func
import logging
import threading

app = func.FunctionApp()

@app.route(route="http_trigger")
def http_trigger(req, context) -> func.HttpResponse:
    logging.info("Function started")
    t = threading.Thread(target=log_from_thread, args=(context,))
    t.start()
    return "okay"

def log_from_thread(context):
    # Associate the thread with the current invocation
    context.thread_local_storage.invocation_id = context.invocation_id  
    logging.info("Logging from a background thread")