Разработка Функции Azure локально с помощью основных средств

Функции Azure Core Tools позволяет разрабатывать и тестировать функции на локальном компьютере. Когда вы будете готовы, вы также можете использовать основные средства для развертывания проекта кода для Azure и работы с параметрами приложения.

Установка основных средств Функции Azure

Рекомендуемый способ установки основных средств зависит от операционной системы локального компьютера разработки.

Сведения о проблемах, связанных с версиями, см. в разделе "Основные инструменты".

Создание локального проекта

В окне терминала или из командной строки выполните следующую команду, чтобы создать проект в новой папке MyProjFolder:

func init MyProjFolder --worker-runtime dotnet-isolated 

func init MyProjFolder --worker-runtime dotnet 

func init MyProjFolder --worker-runtime javascript --model V4

func init MyProjFolder --worker-runtime javascript --model V3

func init MyProjFolder --worker-runtime typescript --model V4

func init MyProjFolder --worker-runtime typescript --model V3

func init MyProjFolder --worker-runtime powershell

func init MyProjFolder --worker-runtime python --model V2

func init MyProjFolder --worker-runtime python

При запуске func init без --worker-runtime параметра вам будет предложено выбрать язык проекта. Дополнительные сведения о доступных параметрах команды func init см. справочник func init.

Создание функции

Чтобы добавить функцию в проект, выполните func new команду с помощью --template параметра, чтобы выбрать шаблон триггера. В следующем примере создается триггер HTTP с именем MyHttpTrigger:

func new --template "Http Trigger" --name MyHttpTrigger

В этом примере создается триггер хранилища очередей с именем MyQueueTrigger:

func new --template "Azure Queue Storage Trigger" --name MyQueueTrigger

При добавлении функций применяются следующие рекомендации.

• При запуске func new без --template параметра вам будет предложено выбрать шаблон.

• func templates list Используйте команду, чтобы просмотреть полный список доступных шаблонов для вашего языка.

• При добавлении триггера, подключающегося к службе, также необходимо добавить параметр приложения, ссылающийся на строка подключения или управляемое удостоверение в файл local.settings.json. Использование параметров приложения таким образом предотвращает внедрение учетных данных в код. Дополнительные сведения см. в разделе "Работа с параметрами приложения" локально.

Дополнительные сведения о доступных параметрах команды func new см. справочник func new.

Добавьте привязку к функции

Функции предоставляют набор входных и выходных привязок для конкретной службы, что упрощает подключение функции к другим службам Azure без использования клиентских пакетов SDK для конкретной службы. Дополнительные сведения см. в разделе Функции Azure триггеры и привязки.

Чтобы добавить входную или выходную привязку к существующей функции, необходимо вручную обновить определение функции.

В следующем примере показано определение функции после добавления привязки выходных данных для хранилища очередей к функции с HTTP-триггером:

[Function("HttpExample")]
public MultiResponse Run([HttpTrigger(AuthorizationLevel.Function, "get", "post")] HttpRequest req)

public class MultiResponse
{
    [QueueOutput("outqueue",Connection = "AzureWebJobsStorage")]
    public string[] Messages { get; set; }
    public IActionResult HttpResponse { get; set; }
}

[FunctionName("HttpExample")]
public static async Task<IActionResult> Run(
    [HttpTrigger(AuthorizationLevel.Function, "get", "post", Route = null)] HttpRequest req, 
    [Queue("outqueue"),StorageAccount("AzureWebJobsStorage")] ICollector<string> msg, 
    ILogger log)

@FunctionName("HttpExample")
public HttpResponseMessage run(
        @HttpTrigger(name = "req", methods = {HttpMethod.GET, HttpMethod.POST}, authLevel = AuthorizationLevel.ANONYMOUS) 
        HttpRequestMessage<Optional<String>> request, 
        @QueueOutput(name = "msg", queueName = "outqueue", 
        connection = "AzureWebJobsStorage") OutputBinding<String> msg, 
        final ExecutionContext context) {

const { app, output } = require('@azure/functions');

const sendToQueue = output.storageQueue({
  queueName: 'outqueue',
  connection: 'AzureWebJobsStorage',
});

app.http('HttpExample', {
  methods: ['GET', 'POST'],
  authLevel: 'anonymous',
  extraOutputs: [sendToQueue],
  handler: async (request, context) => {
    try {
      context.log(`Http function processed request for url "${request.url}"`);

      const name = request.query.get('name') || (await request.text());
      context.log(`Name: ${name}`);

      if (name) {
        const msg = `Name passed to the function ${name}`;
        context.extraOutputs.set(sendToQueue, [msg]);
        return { body: msg };
      } else {
        context.log('Missing required data');
        return { status: 404, body: 'Missing required data' };
      }
    } catch (error) {
      context.log(`Error: ${error}`);
      return { status: 500, body: 'Internal Server Error' };
    }
  },
});

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

$outputMsg = $name
Push-OutputBinding -name msg -Value $outputMsg

@app.route(route="HttpExample")
@app.queue_output(arg_name="msg", queue_name="outqueue", connection="AzureWebJobsStorage")
def HttpExample(req: func.HttpRequest, msg: func.Out [func.QueueMessage]) -> func.HttpResponse:
    logging.info('Python HTTP trigger function processed a request.')

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

import {
  app,
  output,
  HttpRequest,
  HttpResponseInit,
  InvocationContext,
  StorageQueueOutput,
} from '@azure/functions';

const sendToQueue: StorageQueueOutput = output.storageQueue({
  queueName: 'outqueue',
  connection: 'AzureWebJobsStorage',
});

export async function HttpExample(
  request: HttpRequest,
  context: InvocationContext,
): Promise<HttpResponseInit> {
  try {
    context.log(`Http function processed request for url "${request.url}"`);

    const name = request.query.get('name') || (await request.text());
    context.log(`Name: ${name}`);

    if (name) {
      const msg = `Name passed to the function ${name}`;
      context.extraOutputs.set(sendToQueue, [msg]);
      return { body: msg };
    } else {
      context.log('Missing required data');
      return { status: 404, body: 'Missing required data' };
    }
  } catch (error) {
    context.log(`Error: ${error}`);
    return { status: 500, body: 'Internal Server Error' };
  }
}

app.http('HttpExample', {
  methods: ['GET', 'POST'],
  authLevel: 'anonymous',
  handler: HttpExample,
});

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

При добавлении привязок в функцию применяются следующие рекомендации.

• При добавлении привязок, подключающихся к службе, необходимо также добавить параметр приложения, ссылающийся на строка подключения или управляемое удостоверение в файл local.settings.json. Дополнительные сведения см. в разделе "Работа с параметрами приложения" локально.

Запуск среды выполнения функций

Перед тем как запустить или отладить функции в вашем проекте, необходимо запустить узел функций из корневого каталога проекта. Хост включает триггеры для всех функций в проекте. Используйте эту команду для запуска локальной среды выполнения:

mvn clean package 
mvn azure-functions:run

func start

func start

func start

npm install
npm start     

При запуске узла Функций выводится список функций в проекте, включая URL-адреса всех функций, активируемых HTTP, например в этом примере:

Found the following functions:
Host.Functions.MyHttpTrigger

Job host started
Http Function MyHttpTrigger: http://localhost:7071/api/MyHttpTrigger

Помните, что при локальном выполнении функций следует учитывать следующие рекомендации.

• По умолчанию авторизация не применяется локально для конечных точек HTTP. Это означает, что все локальные HTTP-запросы будут обрабатываться как authLevel = "anonymous". Для получения дополнительной информации см. Уровень авторизации. Вы можете использовать --enableAuth параметр, чтобы требовать авторизацию при локальном запуске. Дополнительные сведения см. в разделе func start.

• Локальный эмулятор Azurite можно использовать при локальном выполнении функций, требующих доступа к службам служба хранилища Azure (хранилище очередей, Хранилище BLOB-объектов и хранилищу таблиц) без необходимости подключаться к этим службам в Azure. При использовании локальной эмуляции перед запуском локального узла (func.exe) обязательно запустите Azurite. Дополнительные сведения см. в статье эмуляции локального хранилища.

• Функции, отличные от HTTP, можно запускать локально, не подключаясь к динамической службе. Дополнительные сведения см. в разделе "Запуск локальной функции".

• При включении сведений о подключении Application Insights в файл local.settings.json локальные данные журнала записываются в конкретный экземпляр Application Insights. Чтобы сохранить данные локальной телеметрии отдельно от рабочих данных, рассмотрите возможность использования отдельного экземпляра Application Insights для разработки и тестирования.

Запуск локальной функции

При запуске локального узла функций (func.exe) теперь можно активировать функции, чтобы выполнять и отлаживать их код. Способ выполнения отдельной функции зависит от типа триггера.

http://localhost:<PORT>/api/<FUNCTION_NAME>

curl --get http://localhost:7071/api/MyHttpTrigger?name=Azure%20Rocks

curl --request POST http://localhost:7071/api/MyHttpTrigger --data '{"name":"Azure Rocks"}'

curl --request POST http://localhost:7071/api/MyHttpTrigger --data "{'name':'Azure Rocks'}"

http://localhost:<PORT>/admin/functions/<FUNCTION_NAME>

{
    "input": "<TRIGGER_INPUT>"
}

curl --request POST -H "Content-Type:application/json" --data '{"input":"sample queue data"}' http://localhost:7071/admin/functions/QueueTrigger

curl --request POST -H "Content-Type:application/json" --data "{'input':'sample queue data'}" http://localhost:7071/admin/functions/QueueTrigger

Публикация в Azure

Основные средства Функции Azure поддерживают три типа развертывания:

Для публикации в Azure из Core Tools необходимо установить локально Azure CLI или Azure PowerShell. По умолчанию Core Tools использует эти средства для проверки подлинности с помощью учетной записи Azure.

Если у вас нет этих средств, необходимо вместо этого получить действительный маркер доступа для использования во время развертывания. Маркер доступа можно представить с помощью --access-token параметра в командах развертывания.

Развертывание файлов проекта

func azure functionapp publish <FunctionAppName>

mvn azure-functions:deploy

Развертывание контейнеров

Основные средства позволяют развертывать контейнеризированное функциональное приложение как в средах Контейнеры приложений Azure под управлением, так и в управляемых вами кластерах Kubernetes.

func azurecontainerapps deploy --name <APP_NAME> --environment <ENVIRONMENT_NAME> --storage-account <STORAGE_CONNECTION> --resource-group <RESOURCE_GROUP> --image-name <IMAGE_NAME> [--registry-password] [--registry-server] [--registry-username]

func kubernetes deploy --name <DEPLOYMENT_NAME> --registry <REGISTRY_USERNAME> 

Работа с параметрами приложения локально

Когда приложение-функция работает в Azure, параметры, необходимые вашим функциям, хранятся в параметрах приложения. Во время локальной разработки эти параметры добавляются в коллекцию Values вместо этого в файлеlocal.settings.json. Файл local.settings.json также сохраняет параметры, используемые локальными средствами разработки.

Элементы в коллекции Values в файле local.settings.json предназначены для отражения элементов в параметрах приложения application settings в Azure.

При работе с локальным файлом параметров применяются следующие рекомендации.

• Так как local.settings.json могут содержать секреты, такие как строки подключения, никогда не следует хранить его в удаленном репозитории. Основные инструменты помогают шифровать этот локальный файл параметров для повышения безопасности. Подробнее см. в разделе Файл локальных параметров. Вы также можете зашифровать файл local.settings.json для дополнительной безопасности.

• По умолчанию локальные параметры не переносятся автоматически при публикации проекта в Azure. Используйте параметр --publish-local-settings при публикации файлов проекта, чтобы убедиться, что эти параметры добавлены в приложение-функцию в Azure. Значения из раздела ConnectionStrings никогда не публикуются. Вы также можете отправлять параметры из файлаlocal.settings.json в любое время.

• Вы можете скачать и перезаписать параметры в файле local.settings.json с параметрами из приложения-функции в Azure. Дополнительные сведения см. в разделе "Скачать параметры приложения".

• Если для AzureWebJobsStorage не задана допустимая строка подключения хранилища, а локальный эмулятор хранилища не используется, отображается ошибка. Вы можете использовать Core Tools для загрузки определенной строки подключения из любой вашей учетной записи служба хранилища Azure.

Скачивание параметров приложения

В корневом каталоге проекта используйте следующую команду, чтобы скачать все параметры приложения из приложения myfunctionapp12345 в Azure:

func azure functionapp fetch-app-settings myfunctionapp12345

Эта команда перезаписывает все существующие параметры в файле local.settings.json значениями из Azure. Если они еще не присутствуют, новые элементы добавляются в коллекцию. Дополнительные сведения см. в команде func azure functionapp fetch-app-settings .

Скачивание строки подключения к хранилищу

Основные инструменты также упрощают получение строки подключения любой учетной записи хранения, к которой у вас есть доступ. В корневом каталоге проекта используйте следующую команду, чтобы скачать строку подключения из учетной записи хранения с именем mystorage12345.

func azure storage fetch-connection-string mystorage12345

Эта команда добавляет параметр с именем mystorage12345_STORAGE в файл local.settings.json, содержащий строка подключения для учетной записи mystorage12345. Дополнительные сведения см. в команде func azure storage fetch-connection-string .

Для повышения безопасности во время разработки рекомендуется зашифровать файл local.settings.json.

Отправка локальных параметров в Azure

При публикации файлов проекта в Azure без использования параметра --publish-local-settings параметры в файле local.settings.json не задаются в приложении-функции. Вы всегда можете повторно запустить func azure functionapp publish с параметром --publish-settings-only для загрузки только настроек без повторной публикации файлов проекта.

В следующем примере передаются только параметры из коллекции Values в файле local.settings.json в приложение-функцию в Azure с именем myfunctionapp12345:

func azure functionapp publish myfunctionapp12345 --publish-settings-only

Шифрование локального файла параметров

Чтобы повысить безопасность строк подключения и других ценных данных в локальных параметрах, core Tools позволяет зашифровать файл local.settings.json . При шифровании этого файла среда выполнения автоматически расшифровывает параметры при необходимости так же, как и параметр приложения в Azure. Вы также можете расшифровать локально зашифрованный файл для работы с параметрами.

Используйте следующую команду, чтобы зашифровать локальный файл параметров для проекта:

func settings encrypt

Используйте следующую команду, чтобы расшифровать зашифрованный локальный параметр, чтобы с ним можно было работать:

func settings decrypt

Когда файл параметров зашифрован и расшифровывается, параметр файла IsEncrypted также обновляется.

Настройте расширения привязки

триггеры и привязки Functions реализованы как пакеты расширения .NET (NuGet). Чтобы использовать определенное расширение привязки, это расширение должно быть установлено в проекте.

Версии Core Tools

Основные версии Функции Azure Core Tools связаны с определенными основными версиями среды выполнения Функции Azure. Например, версия 4.x Core Tools поддерживает версию 4.x среды выполнения функций. Эта версия является рекомендуемой основной версией среды выполнения функций и основных инструментов. Последнюю версию core Tools можно определить в репозитории Функции Azure Core Tools.

Выполните следующую команду, чтобы определить версию текущей установки Core Tools:

func --version

Если иное не указано, примеры, приведенные в этой статье, предназначены для версии 4.x.

Следующие рекомендации относятся к установкам Core Tools:

• На каждом компьютере можно установить только одну версию Core Tools.

• При обновлении до последней версии Core Tools следует использовать тот же метод, который использовался для первоначальной установки для выполнения обновления. Например, если вы использовали MSI в Windows, удалите текущий MSI и установите последнюю версию. Или, если вы использовали npm, повторно запустите npm install commandфайл .

• Версии 2.x и 3.x Core Tools использовались с версиями 2.x и 3.x среды выполнения функций, которые достигли окончания срока поддержки. Для получения дополнительной информации см. обзор версий среды выполнения Функции Azure.

Связанный контент

• Создайте и разверните код функции в Azure с помощью Visual Studio Code
• Функции Azure Core Tools на GitHub
• Отправить запрос об ошибке или предложении функции