Where can I find documentation for the azure.functions.FunctionApp Python class?

JamesWatson-0269 25

Is there somewhere that I can see documentation for the FunctionApp class in the azure.functions module? I have found this: https://learn.microsoft.com/en-us/python/api/azure-functions/azure.functions?view=azure-python but the FunctionApp class is not listed.

I also found this: https://learn.microsoft.com/en-us/python/api/overview/azure/?view=azure-python

But 'Functions' links (yes there are 2, the second has even less information) lead back to the same unhelpful documentation as the first link above.

On the main GitHub Page there are links under 'Documentation' such as:

But many (including these two) go to a '404 not found' page. As I am moving beyond 'getting started' examples and/or troubleshooting when they don't work as expected, it would be very helpful to see what is available and some details on things such as what is expected w/ regard to parameters that can be passed to FunctionApp(). It seems crazy to even need to ask about this, so I feel like maybe I am missing something obvious.

Pinaki Ghatak 5,575 Reputation points Microsoft Employee

2024-12-20T16:32:02.3366667+00:00

Hi @JamesWatson-0269

The documentation for the FunctionApp class in the azure.functions module can be found in the Azure Functions Python developer guide. Here is the link to the specific page: Azure Functions Python developer guide. Regarding the parameters that can be passed to FunctionApp(), it depends on what you want to achieve. The FunctionApp class is used to create an instance of an Azure Functions application. You can pass parameters such as the name of the application, the storage account connection string, and the function runtime version. You can find more information about the parameters in the documentation link I provided above.

I hope that this response has addressed your query and helped you overcome your challenges. If so, please mark this response as Answered. This will not only acknowledge our efforts, but also assist other community members who may be looking for similar solutions.
JamesWatson-0269 25 Reputation points

2024-12-30T16:09:14.1633333+00:00

Thanks for the response. Could you point me to where in that page I can find the documentation for the allowed named parameters of FunctionApp()? I searched and skimmed but I'm not finding anything. Even just a list of the parameters would be helpful.
JamesWatson-0269 25 Reputation points

2024-12-31T17:17:05.4333333+00:00

Can you please point me to where on that page I can find a list of named parameters that FunctionApp() will accept?
Shireesha Eeraboina 1,895 Reputation points Microsoft External Staff

2025-01-03T09:45:21.97+00:00
Hi @JamesWatson-0269,Thanks for posting your question in Microsoft Q&A, apologize for any inconvenience caused on this.

As per my knowledge I am providing you some of the named parameters of the FunctionApp()

--name: The name of the function app.

--resource-group: The name of the resource group.

--consumption-plan-location: The location for the consumption plan.

--functions-version: The version of the Azure Functions runtime to use.

--runtime: The runtime stack to use (e.g., python, node, dotnet).

--os-type: The operating system type (e.g., Linux, Windows).

--assign-identity: Assign a managed identity to the function app.

--storage-account: The name of the storage account to use.

--plan: The name of the app service plan to use.

--key-name: The name of the key to set.

--key-value: The value of the new key.

--slot: The name of the slot. Defaults to the production slot if not specified.

Also, find the below document for your reference:

https://learn.microsoft.com/en-us/cli/azure/functionapp/function?view=azure-cli-latest

I hope the above provided information might help you, if you have any further queries, please feel free to reach out to us.

Thank you.
JamesWatson-0269 25 Reputation points

2025-01-03T16:15:48.6466667+00:00

Thanks for the reply. That list might be relevant but it doesn't seem to be specific to Python's FunctionApp() constructor. I'm not sure exactly where that list came from but it's missing 'http_auth_level' which I know is one of the allowed parameters. That suggests to me that this isn't the list I am looking for. I appreciate the reference, however.

Accepted answer

VenkateshDodda-MSFT 24,051 Reputation points Microsoft Employee

2025-01-17T04:51:04.1666667+00:00

@JamesWatson-0269 Thanks for your patience on this. I have checked with internal team and sharing the below.

The only parameter that can be passed to the FunctionApp class is http_auth_level. http_auth_level is an optional parameter, and it is used to determine what keys, if any, need to be present on the request in order to invoke the function.

By default, the AuthLevel is set to “function”, which means that a function-specific API key is required. Other AuthLevel values include “anonymous”, which does not require an API key, and “admin”, which requires the master key.

Currently team are looking into updating the documentation for the azure-functions package, and it will include the FunctionApp class.

This is the tracking issue: azure-functions documentation is outdated · Issue #1631 · Azure/azure-functions-python-worker

Hope this helps, let me know if you have any further questions on this.
Please sign in to rate this answer.

1 person found this answer helpful.

0 comments No comments
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.

Share via

Where can I find documentation for the azure.functions.FunctionApp Python class?

0 additional answers

Your answer