FAQ¶

What is this cookbook?¶

It is a curated collection of Azure Functions Python v2 recipes and runnable examples. It focuses on production-oriented patterns, not just minimal demos.

Is this a Python library I install with pip?¶

No. This repository is content-first and example-first. You clone it, read recipes, and run example apps locally.

Can I use these recipes in production?¶

Yes, as starting points. You should still do normal production hardening:

secret management
identity and access controls
observability and alerting
retries and idempotency validation
cost/performance review

Do I need an Azure subscription to use this repository?¶

Not for initial learning and local execution. You can run examples locally with Azure Functions Core Tools. Queue workflows can be tested with Azurite.

Which Python versions are supported?¶

The project targets >=3.10,<3.15.

Which Azure Functions model is used?¶

All recipes use the Python v2 programming model with decorators and func.FunctionApp().

How do I run examples locally?¶

General flow:

cd examples/<example_name>
pip install -e ".[dev]"
func start

Example names:

apis-and-ingress/hello_http_minimal
apis-and-ingress/http_routing_query_body
apis-and-ingress/webhook_github
messaging/queue_consumer
timer-and-scheduling/timer_cron_job
... and 55+ more (see Patterns Overview)

What is the difference between recipes and examples?¶

docs/patterns/: narrative pattern docs (why/how/architecture/operations)
examples/: executable function apps that implement those patterns

Use both together. Recipes explain intent; examples prove execution.

How do I choose the right recipe?¶

Start from trigger and operational requirement:

Simple HTTP endpoint -> Hello HTTP Minimal
Full CRUD API -> HTTP Routing, Query & Body
Signed GitHub events -> GitHub Webhook
Async queue processing -> Queue Consumer
Periodic scheduled tasks -> Timer Cron Job
Blob processing -> Blob Upload Processor
Multi-step workflows -> Durable Hello Sequence

Where is the recipe template for adding new patterns?¶

Follow the canonical template structure used in existing pattern pages under docs/patterns/.

How do I contribute a new recipe?¶

Add a pattern doc under docs/patterns/<category>/ following the canonical template.
Add a matching runnable example under examples/<category>/.
Add navigation entry in mkdocs.yml.
Run checks and open a PR.

See Contributing Guidelines for details.

Why are some examples intentionally simple?¶

Examples are designed to teach core trigger mechanics clearly. Complex production concerns are covered in recipe and documentation notes so the baseline code stays readable.

Does the cookbook cover Durable Functions?¶

Yes! The cookbook includes 7 Durable Functions recipes covering orchestration chaining, fan-out/fan-in, human interaction, entity state, retry patterns, determinism gotchas, and unit testing. See the Durable Functions Durable Functions patterns for the full list.

Is OpenAPI support built into Azure Functions Python?¶

OpenAPI is available through the companion azure-functions-openapi-python ecosystem package for Azure Functions Python projects.

How do I test queue and timer recipes quickly?¶

Queue: run Azurite and enqueue JSON messages to work-items
Timer: use the admin endpoint to trigger immediately

See Testing for step-by-step checks.

Why am I getting webhook signature failures?¶

Common causes:

mismatched GITHUB_WEBHOOK_SECRET
missing X-Hub-Signature-256 header
signing different bytes than those received by function

See Troubleshooting for a full checklist.

azure-functions-scaffold-python
azure-functions-validation-python
azure-functions-openapi-python
azure-functions-logging-python
azure-functions-doctor-python
azure-functions-db-python
azure-functions-langgraph-python

They complement this cookbook; they do not replace recipe guidance.

Where should I start if I am new?¶

Begin with Installation, then Getting Started, then Patterns Overview.