Azure 函数模板,适用于 Azure 门户、CLI 和 VS
This repository is home to a collection of templates used by development tools to provide a quick start experience for Azure Functions. A template in this context is a sample that demonstrates use of one or more bindings supported by Azure Functions. Following are the development tools that use templates from this repository:
Dotnet templates are consumed by Visual Studio and Visual Studio code via tooling feed. Non-dotnet and C# Script templates are consumed via extension bundles.
| Branch | Status | Description |
|---|---|---|
| dev | This is the primary development branch all pull request go against this branch. | |
| release/main | This is the deployment branch all releases are performed from this branch. |
cd Build
.\build-all.ps1These build steps only work on Windows
There are two kind of dotnet templates contained within this repository, script type (.csx and .fsx) templates that do not require compilation and non-script type (.cs and .fs) templates that require compilation.
Template for dotnet precompiled functions apps adheres to the specification provided by the dotnet templating engine. The dotnet templating engine or an implementation of one is present within each of the dotnet client and is responsible for consuming dotnet templates. This format is not specific to Azure Functions but is a standard used for all dotnet templates by VS, VS Code and dotnet cli. This section covers some basic information needed to add a pre-compiled template.
There are 2 kinds of dotnet templates.
At the minimum you need the following files for a valid dotnet template. Please refer to the this link for detailed documentation on each of the files and properties contained within the file.
tags -> type property would say project vs item for corresponding template types. Below is sample file with comments on individual fields..cs file or a .fs file. Project file is require if you are creating a project template. This could be either a .csproj file or an .fsproj file.Here is a sample PR adding a dotnet item template.
This section covers information you need to add your template to the list of templates that show up within Visual studio and Visual studio code. VS and VS code only support templates for a single major version of a particular extension. That means there currently is no way to simultaneously include templates that target different major versions of the same extension within the same template list. The build system in this repository uses .nuspec files to manage different release trains. Add your template to the nuspec file corresponding to the target runtime release based on the table below.
| Nuspec File | Description |
|---|---|
| ProjectTemplates_v3.x.nuspec | Project templates for dotnet in-proc function app targeting runtime v3 |
| ItemTemplates_v3.x.nuspec | Item templates for dotnet in-proc function app targeting runtime v3 |
| ProjectTemplates-Isolated_v3.x.nuspec | Project templates for dotnet isolated (out of proc) function app targeting runtime v3 |
| ItemTemplates-Isolated_v3.x.nuspec | Item templates for dotnet isolated (out of proc) function app targeting runtime v3 |
| ProjectTemplates_v4.x.nuspec | Project templates for dotnet in-proc function app targeting runtime v4 |
| ItemTemplates_v4.x.nuspec | Item templates for dotnet in-proc function app targeting runtime v4 |
| ProjectTemplates-Isolated_v4.x.nuspec | Project templates for dotnet isolated (out of proc) function app targeting runtime v4 |
| ItemTemplates-Isolated_v4.x.nuspec | Item templates for dotnet isolated (out of proc) function app targeting runtime v4 |
Dotnet pre-compiled templates are currently hosted by the following clients. Please follow the instructions in this section to test the corresponding clients.
%userprofile%\AppData\Local\AzureFunctionsTools\Tagsv4 templates open directory v4LastKnownGood file in the directory for the runtime version you want to test and note the release version present in the file..\bin\VSMicrosoft.Azure.WebJobs.ItemTemplates.X.0.0.nupkg to ItemTemplates.nupkgMicrosoft.Azure.WebJobs.ProjectTemplates.X.0.0.nupkg to ProjectTemplates.nupkgTo test dotnet-isolated, rename
Microsoft.Azure.Functions.Worker.ItemTemplates.X.0.0andMicrosoft.Azure.Functions.Worker.ProjectTemplates.X.0.0in above step.
%userprofile%\AppData\Local\AzureFunctionsTools\Releases\templates folder for the framework you want to test:templates folder fould at the root of the templates cache directorynet7-isolated/templates folder (for isolated, you should see a folder for netfx, net6, net5 etc.)..\bin\VS%userprofile%\.templateengine directorywhere func from windows command prompttemplates directory relative to azure-functions-core-tools at install location..\bin\VS and rename Microsoft.Azure.WebJobs.ItemTemplates.X.0.0.nupkg to itemTemplates.[version].nupkg, Microsoft.Azure.WebJobs.ProjectTemplates.X.0.0.nupkg to projectTemplates.[version].nupkg. Use the version from templates found in step 3...\bin\VSMicrosoft.Azure.Functions.Worker.ItemTemplates.x and Microsoft.Azure.Functions.Worker.ProjectTemplates.x using the format itemTemplates.[version].nupkg and projectTemplates.[version].nupkg respectively. Use the version denoted in the contents of the folder net-isolated, then replace those packages with the renamed packages from ..\bin\VS of your local templates repo.%userprofile%\.templateengine directoryWe currently do not have a way to test templates in VS code without going to through extensive set up. Will update this section with instructions once we have the right set of hooks enabled.
Script type templates are templates for functions that do not require a compilation step. The templates includes metadata files in addition to the files required to execute a function. The metadata files help drive the user interface and development experience for creating a function using a template. In addition to the metadata file you would also need to add a code file for the corresponding language in the template. You can find information on the metadata files in the section below:
Code file: This is the file that contains the function execution code. This could be Python, JavaScript (Node JS), PowerShell, CSharp Script, FSharp Script. The only time this file is not needed is when you are creating a template for custom handlers.
Metadata.json: This file includes basic information that explains the purpose of the template. It also includes configuration properties that help drive the UI required to create a function using a template. Individual properties are explain inline.
…Resources.resx: This file contains all the localized resource strings referenced in the metadata files. The strings are used for description, help, error text and other display text for the UI elements of the development tools. Strings in resources.resx file are reference by adding $ before the corresponding string name. For example TimerTriggerCSharp_description is present in resources.resx file and is referenced in metadata.json file as $TimerTriggerCSharp_description
Bindings.json: This file contains metadata for all the configuration options available for all the bindings. This allows the development tools to provide the users with an option to configure additional settings for the bindings used by the template. It also drives to UI used to add / modify bindings of an existing functions. Here is a sample entry for timerTrigger binding. You only need to add a template for binding that does not exist in binding.json.
…Pretty much all non-dotnet templates do not require compilation. The only exception to this is java templates which are not part of this repository as of now. Non-dotnet templates, CSharp and FSharp script templates are deployed via Extension bundles. This means that a new version of these templat
暂无开放 Issues,或尚未同步最近议题。