Разработка Функций Azure с помощью Visual Studio Code

Расширение "Функции Azure" для Visual Studio Code позволяет разрабатывать функции локально и развертывать их в Azure. Если вы впервые сталкиваетесь с функциями Azure, дополнительные сведения см. в статье Общие сведения о Функциях Azure.

Расширение "Функции Azure" представляет следующие полезные возможности:

• Создание, редактирование и выполнение функций на локальном компьютере для разработки.
• Публикация проектов Функций Azure непосредственно в Azure.
• Написание функций на различных языках с использованием преимуществ Visual Studio Code.

Необходимые компоненты

• Приложение Visual Studio Code, установленное на одной из поддерживаемых платформ.

• Расширение "Функции Azure". Вы также можете установить пакет расширений Azure Tools, который рекомендуется для работы с ресурсами Azure.

• Активная подписка Azure. Если у вас еще нет учетной записи, ее можно создать в расширении в Visual Studio Code.

Для локального запуска и отладки функций требуются эти предварительные требования. Они не требуются только для создания или публикации проектов в Функции Azure.

• Средство Функции Azure Core Tools, которое обеспечивает интегрированную локальную отладку. Если у вас установлено расширение Функции Azure, проще всего установить или обновить основные средства, выполнив Azure Functions: Install or Update Azure Functions Core Tools команду из палитры команд.

Создание проекта Функций Azure

Расширение "Функции" позволяет создавать необходимый проект приложения-функции одновременно при создании первой функции. Используйте эти действия, чтобы создать функцию, активированную HTTP, в новом проекте. Триггер HTTP — это самый простой шаблон триггера функции для демонстрации.

1. В Visual Studio Code нажмите клавишу F1 , чтобы открыть палитру команд и выполнить поиск и выполнить команду Azure Functions: Create New Project.... Выберите расположение каталога для рабочей области проекта и нажмите кнопку "Выбрать".

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

   Вместо этого можно запустить команду Azure Functions: Create New Containerized Project... , чтобы также получить файл Dockerfile, созданный для проекта.

2. При появлении запроса выберите язык для проекта. При необходимости выберите определенную языковую версию.

3. Выберите шаблон функции HTTP trigger (HTTP-триггер) или нажмите кнопку Skip for now (Пока пропустить), чтобы создать проект без функции. Вы всегда можете добавить функцию в проект позже.

   Совет

   Дополнительные шаблоны можно просмотреть, выбрав параметр фильтра " Изменить шаблон" и установив значение Core или All.

4. В поле "Имя функции" введите HttpExample, нажмите клавишу ВВОД и выберите авторизацию функции.

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

5. В раскрывающемся списке выберите "Добавить в рабочую область".

6. В окне "Доверять авторам файлов в этой папке?", нажмите кнопку "Да".

Visual Studio Code создает функцию на выбранном языке и в шаблоне для функции, активируемого HTTP.

Созданные файлы проекта

Шаблон проекта создает проект на выбранном языке и устанавливает необходимые зависимости. Новый проект на любом языке содержит следующие файлы:

• host.json: позволяет настроить узел Функций. Эти параметры действуют как при локальном запуске функций, так и при их запуске в Azure. Дополнительные сведения см. в справочной статье о host.json.

• local.settings.json. Поддерживает параметры, используемые при локальном выполнении функций. Эти параметры действуют только при локальном запуске функций. Подробнее см. в разделе Файл локальных параметров.

  Внимание

  Так как файл local.settings.json может содержать секреты, обязательно исключите файл из системы управления версиями проекта.

• Dockerfile (необязательно): позволяет создать контейнерное приложение-функцию из проекта с помощью утвержденного базового образа для проекта. Этот файл получается только при выполнении команды Azure Functions: Create New Containerized Project.... Файл Dockerfile можно добавить в существующий проект с помощью func init --docker-only команды в Core Tools.

В зависимости от языка создаются также следующие файлы:

На этом этапе вы можете локально запустить функцию триггера HTTP.

Добавление функции в проект

Вы можете добавить новую функцию в существующий проект на основе одного из стандартных шаблонов триггеров функций. Чтобы добавить триггер новой функции, выберите F1, чтобы открыть палитру команд, а затем найдите и выполните команду Функции Azure: Создать функцию. Выберите тип триггера и задайте для него необходимые атрибуты, следуя инструкциям на экране. Если триггеру требуется ключ доступа или строка подключения для подключения к службе, получите этот элемент перед созданием триггера функции.

Подключение к службам

Созданную функцию можно подключить к другим службам Azure, добавив входные и выходные привязки. Привязки подключают вашу функцию к другим службам без необходимости писать код для такого подключения.

{
    "type": "queue",
    "direction": "out",
    "name": "msg",
    "queueName": "outqueue",
    "connection": "MyStorageConnection"
}

{
    "type": "queue",
    "direction": "out",
    "name": "msg",
    "queueName": "outqueue",
    "connection": "MyStorageConnection"
}

{
    "type": "queue",
    "direction": "out",
    "name": "msg",
    "queueName": "outqueue",
    "connection": "MyStorageConnection"
}

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

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

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.Anonymous, "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) {

{
  "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"
    }
  ]
}

{
  "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"
    }
  ]
}

Вход в Azure

Прежде чем создавать ресурсы Azure или публиковать приложение, необходимо войти в Azure.

1. Если вы еще не вошли, на панели действий выберите значок Azure. Затем в разделе "Ресурсы" выберите вход в Azure.

   

   Если вы уже выполнили вход и видите существующие подписки, перейдите к следующему разделу. Если у вас еще нет учетной записи Azure, выберите "Создать учетную запись Azure". Учащиеся могут выбрать "Создать учетную запись Azure для учащихся".

2. При появлении запроса в браузере выберите свою учетную запись Azure и войдите с помощью учетных данных учетной записи Azure. Если вы создаете новую учетную запись, вы можете выполнить вход после ее создания.

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

Создание ресурсов Azure

Перед публикацией проекта Функций в Azure убедитесь, что в вашей подписке Azure есть приложение-функция и связанные ресурсы для выполнения кода. Приложение-функция обеспечивает контекст выполнения функций. При публикации из Visual Studio Code в приложение-функцию в Azure проект упаковается и развертывается в выбранном приложении-функции в подписке Azure.

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

Создание развертывания приложений контейнеров Azure

Вы используете Visual Studio Code для создания ресурсов Azure для контейнерного проекта кода. Когда расширение обнаруживает наличие Dockerfile во время создания ресурса, он спрашивает, нужно ли развертывать образ контейнера вместо просто кода. Visual Studio Code создает среду приложений контейнеров Azure для проекта контейнерного кода, интегрированного с Функции Azure. Дополнительные сведения см. в статье "Приложения контейнеров Azure" для размещения Функции Azure.

Процесс создания зависит от выбора быстрого создания или использования дополнительных параметров:

Дополнительные сведения о ресурсах, необходимых для запуска контейнерных функций в приложениях контейнеров, см. в разделе "Обязательные ресурсы".

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

Рекомендуется настроить непрерывное развертывание , чтобы приложение-функция в Azure обновлялось при обновлении исходных файлов в подключенном исходном расположении. Вы также можете развернуть файлы проекта с помощью Visual Studio Code. При публикации из Visual Studio Code вы можете воспользоваться технологией zip-развертывания.

1. В палитре команд введите и выберите Функции Azure: Развернуть в приложении-функции.

2. Выберите только что созданное приложение-функцию. При появлении запроса на перезапись предыдущих развертываний выберите "Развернуть ", чтобы развернуть код функции в новом ресурсе приложения-функции.

3. После завершения развертывания выберите "Просмотреть выходные данные ", чтобы просмотреть результаты создания и развертывания, включая созданные ресурсы Azure. Если вы пропустили уведомление, выберите значок колокольчика в правом нижнем углу, чтобы увидеть его снова.

   

Получение URL-адреса функции, активируемой HTTP-запросом, в Azure

Чтобы вызвать функцию с триггером HTTP из клиента, вам потребуется URL-адрес функции, который доступен после развертывания в приложении-функции. Все необходимые ключи функций входят в состав этого URL-адреса. Чтобы получить URL-адреса для развернутых вами функций, вы можете воспользоваться расширением. Если вам требуется просто запустить удаленную функцию в Azure, используйте команду расширения Execute function now (Выполнить функцию).

1. Выберите F1, чтобы открыть палитру команд, а затем найдите и выполните команду Функции Azure: Копировать URL-адрес функции.

2. Следуйте инструкциям, чтобы выбрать свое приложение-функцию в Azure, а затем конкретный HTTP-триггер, который требуется вызвать.

URL-адрес функции будет скопирован в буфер обмена вместе со всеми необходимыми ключами, которые передаются в параметре запроса code. Используйте средство HTTP для отправки запросов POST или браузера для отправки запросов GET в удаленную функцию.

Когда расширение получает URL-адрес функции в Azure, расширение использует учетную запись Azure для автоматического получения ключей, необходимых для запуска функции. Дополнительные сведения о ключах доступа к функциям. Для запуска функций, активируемых чем-либо другим, кроме HTTP-запроса, необходим ключ администратора.

Запуск функций

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

Для HTTP-триггеров расширение вызывает конечную точку HTTP, Для других типов триггеров расширение вызывает API-интерфейсы администратора, чтобы запустить функцию. Текст сообщения, отправляемого функции, зависит от типа триггера. Если для триггера требуются тестовые данные, вам будет предложено ввести данные в определенном формате JSON.

Запуск функций в Azure

Чтобы выполнить функцию в Azure из Visual Studio Code, выполните следующие действия.

1. В палитре команд введите Функции Azure: выполните функцию сейчас и выберите подписку Azure.

2. В списке выберите приложение-функцию в Azure. Если вы не видите своего приложения-функции, убедитесь, что вы вошли в нужную подписку.

3. В списке выберите функцию, которую вы хотите запустить. В тексте запроса ВВОД введите текст сообщения запроса и нажмите клавишу ВВОД, чтобы отправить это сообщение в функцию.

   Текст по умолчанию в тексте запроса ВВОД указывает формат текста. Если ваше приложение-функция не содержит функций, отобразится соответствующее уведомление об ошибке.

   Когда функция выполняется в Azure и возвращает ответ, Visual Studio Code отображает уведомление.

Вы также можете запустить функцию из области "Azure: функции ", открыв контекстное меню для функции, которую вы хотите запустить из приложения-функции в подписке Azure, а затем выбрав "Выполнить функцию сейчас...".

При запуске функций в Azure из Visual Studio Code расширение использует учетную запись Azure для автоматического получения ключей, необходимых для запуска функции. Дополнительные сведения о ключах доступа к функциям. Для запуска функций, активируемых чем-либо другим, кроме HTTP-запроса, необходим ключ администратора.

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

Локальная среда выполнения — это та же среда выполнения, в которой размещается приложение-функция в Azure. Локальные параметры считываются из файла local.settings.json. Чтобы запустить проект Функций локально, необходимо выполнить дополнительные требования.

Настройка проекта для локального запуска

Технически для всех типов триггеров, кроме HTTP-триггеров и веб-перехватчиков, в среде выполнения Функций Azure используется учетная запись хранения Azure. Поэтому необходимо записать в ключ Values.AzureWebJobsStorage допустимую строку подключения к учетной записи хранения Azure.

В этом разделе для подключения и получения строки подключения к хранилищу используется расширение службы хранилища Azure для Visual Studio Code с Обозревателем службы хранилища Azure.

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

1. В Visual Studio откройте Cloud Explorer, разверните узел Storage Account (Учетная запись хранения) >Your Storage Account (Ваша учетная запись хранения), а затем выберите Properties (Свойства) и скопируйте значение параметра Primary Connection String (Основная строка подключения).

2. В своем проекте откройте файл local.settings.json и задайте в качестве значения ключа AzureWebJobsStorage скопированную вами строку подключения.

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

Подробнее см. в разделе Файл локальных параметров.

Локальная отладка функций

Для отладки функций нажмите клавишу F5. Если основные инструменты недоступны, вам будет предложено установить его. После установки и запуска Core Tools в окне терминала отображается вывод. Это равносильно запуску команды Core Tools func start из терминала, но с дополнительными задачами сборки и подключенным отладчиком.

Когда проект запущен, вы можете активировать свои функции командой расширения Execute Function Now... (Выполнить функцию...), как в случае развертывания проекта в Azure. Когда проект выполняется в режиме отладки, в нем, как и следует ожидать, срабатывают точки останова Visual Studio Code.

1. В палитре команд введите Функции Azure: выполните функцию сейчас и выберите локальный проект.

2. Выберите из списка функцию, которую нужно выполнить, и введите текст сообщения запроса в поле Enter request body (Введите текст запроса). Нажмите клавишу ВВОД, чтобы отправить это сообщение запроса в свою функцию. Текст, заданный по умолчанию в поле Enter request body (Введите текст запроса), должен указывать требуемый формат текста. Если ваше приложение-функция не содержит функций, отобразится соответствующее уведомление об ошибке.

3. При локальном выполнении функции после получения отклика в Visual Studio Code отобразится соответствующее уведомление. Сведения о выполнении функции отображаются на панели Терминал.

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

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

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

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

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

Значения ConnectionStrings никогда не публикуются.

Параметры приложения в Azure

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

Публикация параметров приложения

Простейший способ опубликовать необходимые параметры в приложении-функции Azure — воспользоваться ссылкой Upload settings (Отправить параметры), которая появляется после публикации проекта:

Опубликовать параметры можно также с помощью команды Azure Functions: Upload Local Settings (Функции Azure: отправить локальные параметры) в палитре команд. Команда Azure Functions: Add New Setting (Функции Azure: добавить новый параметр) позволяет добавлять отдельные параметры в набор параметров приложения в Azure.

Если локальный файл зашифрован, он расшифровывается, публикуется, а затем шифруется снова. Если значения каких-то параметров в двух расположениях конфликтуют, вам будет предложено выбрать, как поступить.

Просмотреть существующие параметры приложения можно в области Azure: Functions (Azure: Функции), развернув подписку, приложение-функцию и раздел Application Settings (Параметры приложения).

Скачивание параметров из Azure

Если вы создали параметры приложения в Azure, их можно скачать в локальный файл local.settings.json командой Azure Functions: Download Remote Settings (Функции Azure: скачать удаленные параметры).

Как и при отправке, если локальный файл зашифрован, он расшифровывается, обновляется и шифруется снова. Если значения каких-то параметров в двух расположениях конфликтуют, вам будет предложено выбрать, как поступить.

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

За исключением HTTP-триггеров и таймерных триггеров, привязки реализованы в виде пакетов расширений.

dotnet add package Microsoft.Azure.Functions.Worker.Extensions.<BINDING_TYPE_NAME> --version <TARGET_VERSION>

dotnet add package Microsoft.Azure.WebJobs.Extensions.<BINDING_TYPE_NAME> --version <TARGET_VERSION>

{
    "version": "2.0",
    "extensionBundle": {
        "id": "Microsoft.Azure.Functions.ExtensionBundle",
        "version": "[3.*, 4.0.0)"
    }
}

Monitor Azure Functions (Мониторинг Функций Azure)

При локальном запуске функций данные журнала передаются в консоль терминала. Можно также получать данные журнала при выполнении проекта Функций как приложения-функции в Azure. Вы можете подключаться к журналам потоковой передачи в Azure для просмотра данных журнала практически в реальном времени. Вам потребуется включить Application Insights, чтобы получать более полное представление о том, как работает приложение-функция.

Application Insights

Необходимо отслеживать выполнение функций, интегрируя приложение-функцию с Application Insights. Когда вы создаете приложение-функцию на портале Azure, такая интеграция выполняется по умолчанию. Если же приложение-функция создается путем публикации из Visual Studio, его необходимо самостоятельно интегрировать с Application Insights. О том, как это сделать, см. в разделе "Включение интеграции с Application Insights".

Дополнительные сведения о мониторинге с помощью Application Insights см. в статье Мониторинг функций Azure.

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

Расширение "Функции Azure" предоставляет полезный графический интерфейс для взаимодействия с приложениями-функциями в Azure. Те же функциональные возможности доступны и в виде команд в палитре команд (клавиша F1). Доступны следующие команды Функций Azure:

Следующие шаги

Дополнительные сведения об Azure Functions Core Tools см. в статье "Работа с Azure Functions Core Tools".

Дополнительные сведения о разработке функций, таких как библиотеки класса .NET, см. в статье Справочник разработчика C# по функциям Azure. В статье приведены также ссылки на примеры того, как использовать атрибуты для объявления разных типов привязок, поддерживаемых в Функциях Azure.