Краткое руководство. Создание функции C# в Azure из командной строкиQuickstart: Create a C# function in Azure from the command line

Из этой статьи вы узнаете, как создать функцию класса C# на основе библиотеки, которая отвечает на HTTP-запросы, используя инструменты командной строки.In this article, you use command-line tools to create a C# class library-based function that responds to HTTP requests. После тестирования кода в локальной среде его необходимо развернуть в бессерверной среде Функций Azure.After testing the code locally, you deploy it to the serverless environment of Azure Functions.

Выполнение этого краткого руководства предполагает небольшую дополнительную плату в несколько центов США в учетной записи Azure.Completing this quickstart incurs a small cost of a few USD cents or less in your Azure account.

Существует также версия этой статьи для Visual Studio Code.There is also a Visual Studio Code-based version of this article.

Настройка локальной средыConfigure your local environment

Перед началом работы убедитесь, что у вас есть такие компоненты.Before you begin, you must have the following:

Проверка предварительных условийPrerequisite check

Убедитесь, что предварительные требования (зависят от того, используете ли вы Azure CLI или Azure PowerShell для создания ресурсов Azure) выполнены:Verify your prerequisites, which depend on whether you are using Azure CLI or Azure PowerShell for creating Azure resources:

  • В окне терминала или командном окне запустите func --version, чтобы убедиться, что используется версия Azure Functions Core Tools 3.x.In a terminal or command window, run func --version to check that the Azure Functions Core Tools are version 3.x.

  • Выполните команду az --version, чтобы убедиться, что используется версия Azure CLI 2.4 или более поздняя.Run az --version to check that the Azure CLI version is 2.4 or later.

  • Выполните команду az login, чтобы войти в Azure и проверить активную подписку.Run az login to sign in to Azure and verify an active subscription.

  • Выполните команду dotnet --list-sdks, чтобы проверить, установлен ли пакет SDK для .NET Core версии 3.1.x.Run dotnet --list-sdks to check that .NET Core SDK version 3.1.x is installed

Создание локального проекта службы "Функции"Create a local function project

В Функциях Azure проект функций представляет собой контейнер для одной или нескольких отдельных функций, каждая из которых реагирует на конкретный триггер.In Azure Functions, a function project is a container for one or more individual functions that each responds to a specific trigger. Все функции в проекте совместно используют те же локальные конфигурации и конфигурации размещения.All functions in a project share the same local and hosting configurations. В этом разделе вы создадите проект функций, содержащий одну функцию.In this section, you create a function project that contains a single function.

  1. Выполните команду func init, как показано ниже, чтобы создать проект функций в папке с именем LocalFunctionProj с указанной средой выполнения:Run the func init command, as follows, to create a functions project in a folder named LocalFunctionProj with the specified runtime:

    func init LocalFunctionProj --dotnet
    
  2. Перейдите в папку проекта:Navigate into the project folder:

    cd LocalFunctionProj
    

    Эта папка содержит различные файлы проекта, в том числе файлы конфигурации local.settings.json и host.json.This folder contains various files for the project, including configurations files named local.settings.json and host.json. Файл local.settings.json может содержать секреты, скачанные из Azure, поэтому файл по умолчанию исключен из системы управления версиями в GITIGNORE-файле.Because local.settings.json can contain secrets downloaded from Azure, the file is excluded from source control by default in the .gitignore file.

  3. Добавьте функцию в проект с помощью приведенной ниже команды, где аргумент --name — уникальное имя функции (HttpExample), а аргумент --template позволяет указать триггер функции (HTTP).Add a function to your project by using the following command, where the --name argument is the unique name of your function (HttpExample) and the --template argument specifies the function's trigger (HTTP).

    func new --name HttpExample --template "HTTP trigger" --authlevel "anonymous"
    

    Команда func new создает файл кода HttpExample.cs.func new creates a HttpExample.cs code file.

Проверка содержимого файла (дополнительно)(Optional) Examine the file contents

При необходимости можно сразу перейти к локальному запуску функции и просмотреть содержимое файла позже.If desired, you can skip to Run the function locally and examine the file contents later.

HttpExample.csHttpExample.cs

Файл HttpExample.cs содержит метод Run, получающий данные запроса в переменной req — это запрос HttpRequest, дополненный атрибутом HttpTriggerAttribute, который определяет поведение триггера.HttpExample.cs contains a Run method that receives request data in the req variable is an HttpRequest that's decorated with the HttpTriggerAttribute, which defines the trigger behavior.

using System;
using System.IO;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging;
using Newtonsoft.Json;

namespace LocalFunctionProj
{
    public static class HttpExample
    {
        [FunctionName("HttpExample")]
        public static async Task<IActionResult> Run(
            [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req,
            ILogger log)
        {
            log.LogInformation("C# HTTP trigger function processed a request.");

            string name = req.Query["name"];

            string requestBody = await new StreamReader(req.Body).ReadToEndAsync();
            dynamic data = JsonConvert.DeserializeObject(requestBody);
            name = name ?? data?.name;

            return name != null
                ? (ActionResult)new OkObjectResult($"Hello, {name}")
                : new BadRequestObjectResult("Please pass a name on the query string or in the request body");
        }
    }
}

Возвращаемый объект — это ActionResult, который возвращает ответное сообщение в виде OkObjectResult (200) или BadRequestObjectResult (400).The return object is an ActionResult that returns a response message as either an OkObjectResult (200) or a BadRequestObjectResult (400). Дополнительные сведения см. в статье Триггеры и привязки HTTP в службе "Функции Azure".To learn more, see Azure Functions HTTP triggers and bindings.

Локальное выполнение функцииRun the function locally

  1. Выполните функцию, запустив локальное хост-приложение среды выполнения Функций Azure из папки LocalFunctionProj:Run your function by starting the local Azure Functions runtime host from the LocalFunctionProj folder:

    func start
    

    Ближе к концу выходных данных появятся следующие строки:Toward the end of the output, the following lines should appear:

     ...
    
     Now listening on: http://0.0.0.0:7071
     Application started. Press Ctrl+C to shut down.
    
     Http Functions:
    
             HttpExample: [GET,POST] http://localhost:7071/api/HttpExample
     ...
    
     

    Примечание

    Если результат HttpExample не похож на пример ниже, скорее всего, вы запустили хост-приложение из папки, отличной от корневой папки проекта.If HttpExample doesn't appear as shown below, you likely started the host from outside the root folder of the project. В этом случае остановите хост-приложение клавишами CTRL+C, перейдите в корневую папку проекта и снова выполните указанную выше команду.In that case, use Ctrl+C to stop the host, navigate to the project's root folder, and run the previous command again.

  2. Скопируйте URL-адрес функции HttpExample из этих выходных данных в браузер и добавьте строку запроса ?name=<YOUR_NAME>, сформировав полный URL-адрес, например http://localhost:7071/api/HttpExample?name=Functions.Copy the URL of your HttpExample function from this output to a browser and append the query string ?name=<YOUR_NAME>, making the full URL like http://localhost:7071/api/HttpExample?name=Functions. В браузере должно отобразиться сообщение, например Hello Functions:The browser should display a message like Hello Functions:

    Получившаяся функция выполняется локально в браузере

  3. Терминал, в котором вы запустили проект, также выводит данные журнала при выполнении запросов.The terminal in which you started your project also shows log output as you make requests.

  4. Когда все будет готово, нажмите клавиши CTRL+C и выберите y, чтобы отключить хост-приложение функции.When you're done, use Ctrl+C and choose y to stop the functions host.

Создание вспомогательных ресурсов Azure для функцииCreate supporting Azure resources for your function

Прежде чем развернуть код функции в Azure, необходимо создать три ресурса:Before you can deploy your function code to Azure, you need to create three resources:

  • группу ресурсов — логический контейнер связанных ресурсов;A resource group, which is a logical container for related resources.
  • учетную запись хранения — для сохранения состояния и других сведений о проектах;A Storage account, which maintains state and other information about your projects.
  • приложение-функцию — среду для выполнения кода функции.A function app, which provides the environment for executing your function code. Оно сопоставляется с локальным проектом функций и позволяет группировать функции в логические единицы, чтобы упростить развертывание, масштабирование и совместное использование ресурсов, а также управление ими.A function app maps to your local function project and lets you group functions as a logical unit for easier management, deployment, and sharing of resources.

Чтобы создать эти элементы, выполните следующие команды:Use the following commands to create these items. Поддерживается Azure CLI и PowerShell.Both Azure CLI and PowerShell are supported.

  1. Войдите в Azure, если вы еще этого не сделали:If you haven't done so already, sign in to Azure:

    az login
    

    Чтобы войти в учетную запись Azure, выполните команду az login.The az login command signs you into your Azure account.

  2. Создайте группу ресурсов с именем AzureFunctionsQuickstart-rg в регионе westeurope:Create a resource group named AzureFunctionsQuickstart-rg in the westeurope region:

    az group create --name AzureFunctionsQuickstart-rg --location westeurope
    

    Чтобы создать группу ресурсов, выполните команду az group create.The az group create command creates a resource group. Группу ресурсов и ресурсы целесообразно создавать в ближайшем к вам регионе. Для этого используйте команду az account list-locations.You generally create your resource group and resources in a region near you, using an available region returned from the az account list-locations command.

  3. В группе ресурсов и регионе создайте учетную запись хранения общего назначения:Create a general-purpose storage account in your resource group and region:

    az storage account create --name <STORAGE_NAME> --location westeurope --resource-group AzureFunctionsQuickstart-rg --sku Standard_LRS
    

    Создайте учетную запись хранения с помощью команды az storage account create.The az storage account create command creates the storage account.

    В предыдущем примере замените <STORAGE_NAME> соответствующим именем, которое является уникальным в службе хранилища Azure.In the previous example, replace <STORAGE_NAME> with a name that is appropriate to you and unique in Azure Storage. Имена должны содержать от трех до 24 символов и только в нижнем регистре.Names must contain three to 24 characters numbers and lowercase letters only. Standard_LRS указывает учетную запись общего назначения, которая поддерживается Функциями.Standard_LRS specifies a general-purpose account, which is supported by Functions.

  1. Создайте приложение-функцию в Azure:Create the function app in Azure:

    az functionapp create --resource-group AzureFunctionsQuickstart-rg --consumption-plan-location westeurope --runtime dotnet --functions-version 3 --name <APP_NAME> --storage-account <STORAGE_NAME>
    

    Чтобы создать приложение-функцию в Azure, выполните команду az functionapp create.The az functionapp create command creates the function app in Azure.

    В предыдущем примере замените <STORAGE_NAME> именем учетной записи, использованной на предыдущем шаге, и измените <APP_NAME> на глобально уникальное имя, подходящее вам.In the previous example, replace <STORAGE_NAME> with the name of the account you used in the previous step, and replace <APP_NAME> with a globally unique name appropriate to you. <APP_NAME> также является доменом DNS по умолчанию для приложения-функции.The <APP_NAME> is also the default DNS domain for the function app.

    Эта команда создает приложение-функцию, работающее в указанной языковой среде выполнения в рамках плана использования Функций Azure, который не предусматривает плату за объем, используемый здесь.This command creates a function app running in your specified language runtime under the Azure Functions Consumption Plan, which is free for the amount of usage you incur here. Эта команда также подготавливает связанный экземпляр Application Insights Azure в той же группе ресурсов. Его можно использовать для мониторинга приложения-функции и просмотра журналов.The command also provisions an associated Azure Application Insights instance in the same resource group, with which you can monitor your function app and view logs. Дополнительные сведения см. в разделе Мониторинг функций Azure.For more information, see Monitor Azure Functions. Этот экземпляр не создает затраты, пока вы не активируете его.The instance incurs no costs until you activate it.

Развертывание проекта функций в AzureDeploy the function project to Azure

После того как вы успешно создадите приложение-функцию в Azure, вы сможете развернуть локальный проект функций с помощью команды func azure functionapp publish.After you've successfully created your function app in Azure, you're now ready to deploy your local functions project by using the func azure functionapp publish command.

В следующем примере замените <APP_NAME> на имя своего приложения.In the following example, replace <APP_NAME> with the name of your app.

func azure functionapp publish <APP_NAME>

Команда publish показывает результаты, аналогичные приведенным ниже (усечены для простоты):The publish command shows results similar to the following output (truncated for simplicity):

...

Getting site publishing info...
Creating archive for current directory...
Performing remote build for functions project.

...

Deployment successful.
Remote build succeeded!
Syncing triggers...
Functions in msdocs-azurefunctions-qs:
    HttpExample - [httpTrigger]
        Invoke url: https://msdocs-azurefunctions-qs.azurewebsites.net/api/httpexample

Вызов функции в AzureInvoke the function on Azure

Функция использует триггер HTTP, поэтому ее необходимо вызывать через HTTP-запрос по URL-адресу в браузере или с помощью такого средства, как cURL.Because your function uses an HTTP trigger, you invoke it by making an HTTP request to its URL in the browser or with a tool like curl.

Скопируйте полный URL-адрес вызова Invoke URL , показанный в выходных данных команды publish, в адресную строку браузера, добавив параметр запроса &name=Functions.Copy the complete Invoke URL shown in the output of the publish command into a browser address bar, appending the query parameter &name=Functions. В браузере должны отображаться выходные данные, аналогичные данным при локальном запуске функции.The browser should display similar output as when you ran the function locally.

Выходные данные функции, выполняемой в Azure в браузере

Выполните следующую команду, чтобы просмотреть журналы потоковой передачи в режиме, близком к реальному времени:Run the following command to view near real-time streaming logs:

func azure functionapp logstream <APP_NAME> 

В отдельном окне терминала или в браузере снова вызовите удаленную функцию.In a separate terminal window or in the browser, call the remote function again. В окне терминала отображается подробный журнал выполнения функции в Azure.A verbose log of the function execution in Azure is shown in the terminal.

Очистка ресурсовClean up resources

Если вы намерены перейти к следующему шагу и добавить выходную привязку очереди службы хранилища Azure, можете сохранить все ресурсы, которые пригодятся на этом этапе.If you continue to the next step and add an Azure Storage queue output binding, keep all your resources in place as you'll build on what you've already done.

В противном случае используйте следующую команду, чтобы удалить группу ресурсов и все содержащиеся в ней ресурсы и избежать дополнительных расходов.Otherwise, use the following command to delete the resource group and all its contained resources to avoid incurring further costs.

az group delete --name AzureFunctionsQuickstart-rg

Дальнейшие действияNext steps