Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document settings required for CLI #108

Closed
lindydonna opened this issue Dec 16, 2016 · 4 comments
Closed

Document settings required for CLI #108

lindydonna opened this issue Dec 16, 2016 · 4 comments

Comments

@lindydonna
Copy link
Contributor

lindydonna commented Dec 16, 2016

The CLI requires various local settings that are similar to those required for building and running the -script project (see https://github.com/Azure/azure-webjobs-sdk-script/wiki). These need to be documented.

I'll start with a wiki page which should later be migrated to real product documentation.

Things to include:

  • appsettings.json structure
  • The fact that appsettings.json is only used locally
  • How the environment variables AzureWebJobsStorage and AzureWebJobsDashboard are used
  • The fact that func run runs the host, meaning that other triggered functions will also run. See Cli: Run a function from a list of functions in a functionapp locally  azure-functions-core-tools#31 (comment) for instance.
  • All triggers other than HTTP require that AzureWebJobsStorage is set, because queue storage is used internally. It is possible to use the local storage emulator (via "AzureWebJobsStorage": "UseDevelopmentStorage=true"), but you may see limitations or differences in behavior.
@SyntaxC4
Copy link
Member

SyntaxC4 commented Jan 9, 2017

@lindydonna - Can you provide a little bit more information on how to get the appsettings.json using the CLI?

@lindydonna lindydonna self-assigned this Jan 10, 2017
@lindydonna
Copy link
Contributor Author

I meant to assign this to myself. I'll write a wiki article with all the details, that then we can migrate to documentation along with other CLI docs.

@lindydonna
Copy link
Contributor Author

Should document connection strings and app settings behavior of the CLI, see comment here: Azure/azure-functions-core-tools#33 (comment)

@lindydonna
Copy link
Contributor Author

All these notes are in the published article: https://azure.microsoft.com/en-us/documentation/articles/functions-run-local

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants