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

Visual Studio предоставляет способ разработки, тестирования и развертывания функций библиотеки классов C# в Azure. Если это первый опыт работы с Функциями Azure, ознакомьтесь с общими сведениями о функциях Azure.

В этой статье содержатся подробные сведения об использовании Visual Studio для разработки функций библиотеки классов C# и их публикации в Azure. Существует две модели для разработки функций библиотеки классов C#: изолированной рабочей модели и модели внутрипроцессной.

Если не указано иное, приведенные процедуры и примеры относятся к Visual Studio 2022. Дополнительные сведения о выпусках Visual Studio 2022 см. в заметках о выпуске или заметках о предварительной версии.

Предварительные требования

• Visual Studio 2022, включая компонент разработки Azure.

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

• Если у вас нет аккаунта Azure, создайте бесплатную учетную запись перед началом.

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

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

1. В строке меню Visual Studio выберите Файл>Создать>Проект.

2. В диалоговом окне "Создание проекта " введите функции в поле поиска, выберите шаблон "Функции Azure " и нажмите кнопку "Далее".

3. В диалоговом окне "Настройка нового проекта " введите имя проекта и нажмите кнопку "Далее". Имя приложения-функции должно быть допустимым в качестве пространства имен C#, поэтому не используйте символы подчеркивания, дефисы и другие символы, не являющиеся буквенно-цифровыми.

4. В диалоговом окне "Дополнительные сведения" выполните действия, перечисленные в следующей таблице:

   Настройка	Действие	Описание
   Рабочая роль Функций	Выберите .NET 8.0 (изолированное, долгосрочная поддержка).	Visual Studio создает проект функции, который выполняется в изолированном рабочем процессе. Изолированный рабочий процесс также поддерживает другие версии .NET и .NET Framework, которые не предоставляют долгосрочной поддержки (LTS). Дополнительные сведения см. в обзоре версий среды выполнения Функций Azure.
   Function	Выберите триггер HTTP.	Visual Studio создает функцию, активированную HTTP-запросом.
   Использование Azurite для учетной записи хранения среды выполнения (AzureWebJobsStorage)	Установите этот флажок.	Поскольку для приложения-функции в Azure требуется учетная запись хранения, она назначается или создается при публикации проекта в Azure. Триггер HTTP не использует строку подключения учетной записи хранилища. Для всех других типов триггеров требуется допустимая строка подключения учетной записи хранения.
   Уровень авторизации	Выберите "Анонимный".	При использовании этого параметра авторизации любой клиент может активировать созданную функцию без предоставления ключа. Эта конфигурация упрощает тестирование новой функции. Для получения дополнительной информации см. Уровень авторизации.

   

   Настройка	Действие	Описание
   Рабочая роль Функций	Выберите .NET 8.0 внутри процесса (долгосрочная поддержка).	Visual Studio создает проект функции, который выполняется в процессе с версией 4.x среды выполнения Функций. Дополнительные сведения см. в обзоре версий среды выполнения Функций Azure.
   Function	Выберите триггер HTTP.	Visual Studio создает функцию, активированную HTTP-запросом.
   Использование Azurite для учетной записи хранения среды выполнения (AzureWebJobsStorage)	Установите этот флажок.	Поскольку для приложения-функции в Azure требуется учетная запись хранения, она назначается или создается при публикации проекта в Azure. Триггер HTTP не использует строку подключения учетной записи хранилища. Для всех других типов триггеров требуется допустимая строка подключения учетной записи хранения.
   Уровень авторизации	Выберите "Анонимный"	При использовании этого параметра авторизации любой клиент может активировать созданную функцию без предоставления ключа. Эта конфигурация упрощает тестирование новой функции. Для получения дополнительной информации см. Уровень авторизации.

   

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

5. Нажмите кнопку Создать, чтобы создать проект функции и функцию, активируемую с помощью HTTP.

Новый проект содержит следующие файлы:

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

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

  Внимание

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

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

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

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

Visual Studio не автоматически отправляет параметры в local.settings.json при публикации проекта. Чтобы эти параметры гарантировано существовали и в приложении-функции в Azure, отправьте их после публикации проекта. Подробнее см. в разделе Параметры приложения-функции. Значения в ConnectionStrings коллекции не публикуются.

Код также может считывать значения параметров приложения-функции как переменные среды. Дополнительную информацию см. в разделе Переменные среды.

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

Среда выполнения Функций использует учетную запись хранения внутри организации. Во время разработки можно использовать действительную учетную запись хранилища для этой внутренней учетной записи или использовать эмулятор Azurite.

Для всех типов триггеров, отличных от HTTP и веб-перехватчиков, необходимо задать значение Values.AzureWebJobsStorage ключа в файлеlocal.settings.json :

• Для учетной записи хранения установите в качестве значения строку подключения вашей учетной записи хранения.
• Для эмулятора задайте для параметра значение UseDevelopmentStorage=true.

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

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

1. Войдите на портал Azure и перейдите к учетной записи хранения.

2. Выберите Безопасность + сеть>Ключи доступа. В разделе key1 скопируйте значение строки подключения .

3. В проекте Visual Studio откройте файл local.settings.json . Задайте значение AzureWebJobsStorage ключа скопированной строке подключения.

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

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

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

1. В Обозреватель решений щелкните правой кнопкой мыши узел проекта и выберите > Azure".

2. В диалоговом окне "Добавить новый элемент" выберите функцию Azure и нажмите кнопку "Добавить".

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

   

4. Нажмите кнопку "Добавить". Если установить флажок для настройки подключения к хранилищу на предыдущем шаге, откроется страница "Подключение к зависимости ". Выберите эмулятор хранилища Azurite или службу хранилища Azure, а затем нажмите кнопку "Далее".

   • Если выбрать эмулятор хранилища Azurite, откроется страница Подключение к эмулятору хранилища Azurite. Выполните следующие действия.
     1. Нажмите кнопку Далее.
     2. На странице "Сводка изменений" нажмите кнопку "Готово". Visual Studio настраивает зависимость и создает класс триггера.
   • Если выбрать службу хранилища Azure, откроется страница "Подключение к службе хранилища Azure ". Выполните следующие действия.
     1. Выберите учетную запись хранения и нажмите кнопку "Далее". Visual Studio пытается подключиться к учетной записи Azure и получить конечную точку.
     2. Нажмите кнопку Далее.
     3. На странице "Сводка изменений" нажмите кнопку "Готово". Visual Studio настраивает зависимость и создает класс триггера.

   В этом примере триггера используется параметр приложения с ключом, именованным QueueStorage, для подключения к хранилищу. Этот ключ, хранящийся в файлеlocal.settings.json, ссылается на эмулятор Azurite или учетную запись хранения.

5. Проверьте добавленный класс. Например, следующий класс C# представляет простую функцию триггера хранилища очередей:

   Метод Run() обладает атрибутом Function. Этот атрибут указывает, что метод является точкой входа для функции.

   using System;
   using Azure.Storage.Queues.Models;
   using Microsoft.Azure.Functions.Worker;
   using Microsoft.Extensions.Logging;
   
   namespace Company.Function;
   
   public class QueueTriggerCSharp
   {
       private readonly ILogger<QueueTriggerCSharp> _logger;
   
       public QueueTriggerCSharp(ILogger<QueueTriggerCSharp> logger)
       {
           _logger = logger;
       }
   
       [Function(nameof(QueueTriggerCSharp))]
       public void Run([QueueTrigger("PathValue", Connection = "ConnectionValue")] QueueMessage message)
       {
           _logger.LogInformation("C# Queue trigger function processed: {messageText}", message.MessageText);
       }
   }
   

   Статический Run() метод ассоциируется с FunctionName. Этот атрибут указывает, что метод является точкой входа для функции.

   using System;
   using Microsoft.Azure.WebJobs;
   using Microsoft.Azure.WebJobs.Host;
   using Microsoft.Extensions.Logging;
   
   namespace Company.Function
   {
       public class QueueTriggerCSharp
       {
           [FunctionName("QueueTriggerCSharp")]
           public void Run([QueueTrigger("PathValue", Connection = "ConnectionValue")]string myQueueItem, ILogger log)
           {
               log.LogInformation($"C# Queue trigger function processed: {myQueueItem}");
           }
       }
   }
   

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

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

• Параметр имени очереди должен соответствовать имени очереди, используемой на предыдущем шаге для создания триггера, например myqueue-items.
• Имя параметра строки подключения должно совпадать с именем, используемым на предыдущем шаге для создания триггера, например QueueStorage.

Дополнительные сведения см. в триггере Azure Queue Storage для Azure Functions.

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

Добавление привязок

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

1. Убедитесь, что проект настроен для локальной разработки.

2. Добавьте соответствующий пакет расширения NuGet для каждой конкретной привязки. Чтобы ознакомиться с требованиями к пакету NuGet для конкретного биндинга, смотрите справочную статью по биндингу. Например, требования к пакету для триггера Event Hubs Azure см. в разделе триггера Event Hubs Azure и биндинги для функций Azure.

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

   Install-Package Microsoft.Azure.Functions.Worker.Extensions.<BINDING_TYPE> -Version <TARGET_VERSION>
   

   Install-Package Microsoft.Azure.WebJobs.Extensions.<BINDING_TYPE> -Version <TARGET_VERSION>
   

   В этом коде замените <BINDING_TYPE> определенное имя расширения привязки и замените <TARGET_VERSION> определенной версией пакета, например 4.0.0. Допустимые версии перечислены на страницах отдельных пакетов на сайте NuGet.org.

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

   Функция использует эти значения при локальном запуске. Если же функция выполняется в приложении-функции в Azure, используются параметры приложения-функции. Visual Studio упрощает публикацию локальных параметров в Azure.

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

    public class QueueTrigger
   {
       private readonly ILogger _logger;
   
       public QueueTrigger(ILoggerFactory loggerFactory)
       {
           _logger = loggerFactory.CreateLogger<QueueTrigger>();
       }
   
       [Function("CopyQueueMessage")]
       [QueueOutput("myqueue-items-destination", Connection = "QueueStorage")]
       public string Run([QueueTrigger("myqueue-items-source", Connection = "QueueStorage")] string myQueueItem)
       {
           _logger.LogInformation($"C# Queue trigger function processed: {myQueueItem}");
           return myQueueItem;
       }
   }
   

   Атрибут QueueOutput определяет привязку метода. Для нескольких выходных привязок вместо этого поместите этот атрибут в строковое свойство возвращаемого объекта. Дополнительные сведения см. в разделе "Несколько выходных привязок".

   public static class SimpleExampleWithOutput
   {
       [FunctionName("CopyQueueMessage")]
       public static void Run(
           [QueueTrigger("myqueue-items-source", Connection = "QueueStorage")] string myQueueItem, 
           [Queue("myqueue-items-destination", Connection = "QueueStorage")] out string myQueueItemCopy,
           ILogger log)
       {
           log.LogInformation($"CopyQueueMessage function processed: {myQueueItem}");
           myQueueItemCopy = myQueueItem;
       }
   }
   

   Атрибут Queue параметра out определяет выходную привязку.

   Подключение к хранилищу очередей получается из настройки QueueStorage. Дополнительные сведения см. в справочной статье об определённой привязке.

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

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

Вы можете использовать Core-инструменты Azure Functions для запуска проектов Functions на вашем локальном компьютере разработки. При выборе F5 для отладки проекта функций локальный узел функций (func.exe) начинает прослушивание локального порта (обычно 7071). Любые конечные точки вызываемых функций записываются в выходные данные, и вы можете использовать эти конечные точки для тестирования своих функций. Дополнительные сведения см. в статье "Разработка функций Azure локально с помощью основных средств". Вам будет предложено установить эти инструменты при первом запуске функции из Visual Studio.

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

1. Выберите F5. При появлении запроса примите запрос из Visual Studio на скачивание и установку Azure Functions Core Tools. Кроме того, может потребоваться включить исключение брандмауэра, чтобы средства могли обрабатывать HTTP-запросы.

2. При запуске проекта проверьте код так же, как и развернутую функцию.

   Если Visual Studio работает в режиме отладки, точки останова срабатывают, как ожидалось.

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

При публикации проекта Функций в Azure Visual Studio использует zip-развертывание для развертывания файлов проекта. По возможности следует также выбрать запуск из файла пакета , чтобы проект выполнялся в пакете развертывания (.zip) . Дополнительные сведения см. в статье "Запуск функций из файла пакета в Azure".

Не развертывайте в Функциях с помощью веб-развертывания (msdeploy).

Чтобы опубликовать проект в приложении-функции в Azure, выполните следующие действия.

1. В обозревателе решений щелкните проект правой кнопкой мыши и выберите "Опубликовать".

2. На странице публикации сделайте следующее:

   • В целевом объекте выберите Azure и нажмите кнопку "Далее".
   • В определенном целевом объекте выберите приложение-функцию Azure и нажмите кнопку "Далее".
   • На экземпляре Функций выберите Создать новый.

   

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

   Настройка	значение	Описание
   Имя	Глобально уникальное имя	Имя должно однозначно идентифицировать ваше новое функциональное приложение. Примите предлагаемое имя или введите новое имя. Допустимы следующие символы: a-z, 0-9и -.
   Имя подписки	Имя подписки	Приложение-функция создается в подписке Azure. Примите подписку по умолчанию или выберите другую из списка.
   Группа ресурсов	Имя группы ресурсов	Функциональное приложение создается в группе ресурсов. Выберите "Создать" , чтобы создать новую группу ресурсов. Вы также можете выбрать существующую группу ресурсов из списка.
   Тип плана	Использование Flex	При публикации проекта в функциональное приложение, работающее в плане потребления Flex, вы можете платить только за выполнение функций приложения. Другие планы размещения могут нести более высокие затраты. ВАЖНО! При создании плана потребления Flex необходимо сначала выбрать план службы приложений , а затем повторно выбрать Flex Consumption , чтобы устранить проблему с диалоговым окном.
   Операционная система	Линукс	План потребления Flex в настоящее время требует Linux.
   Местонахождение	Расположение службы приложений	Выберите расположение в регионе Azure, поддерживаемом планом потребления Flex. Если выбран неподдерживаемый регион, кнопка "Создать " неактивна.
   Размер памяти экземпляра	2048	Размер памяти экземпляров виртуальных машин, в которых выполняется приложение, является уникальным для плана потребления Flex.
   Хранилище Azure	Учетная запись хранения общего назначения	Для среды выполнения функций требуется учетная запись хранения. Выберите Создать, чтобы настроить учетную запись хранения общего назначения. Вы также можете использовать существующую учетную запись, которая соответствует требованиям учетной записи хранения.
   Application Insights	Экземпляр Application Insights	Необходимо включить интеграцию Application Insights для функционального приложения. Выберите "Создать ", чтобы создать новый экземпляр в новой или существующей рабочей области Log Analytics. Можно также использовать существующий экземпляр.

   

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

5. Нажмите Готово. Появится окно создания профиля публикации. После создания профиля нажмите кнопку "Закрыть".

6. На странице профиля публикации выберите "Опубликовать ", чтобы развернуть пакет, содержащий файлы проекта, в новом приложении-функции в Azure.

   По завершении развертывания корневой URL-адрес приложения-функции в Azure отображается на странице профиля публикации.

7. На странице профиля публикации перейдите в раздел Хостинг. Выберите многоточие (...), а затем нажмите кнопку "Открыть" на портале Azure. Новый ресурс приложения-функции Azure открывается в портале Azure.

   

Параметры функционального приложения

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

Самый простой способ передать необходимые параметры в приложение-функцию в Azure — управлять ими в Visual Studio. На странице профиля публикации перейдите в раздел Хостинг. Выберите многоточие (...), а затем выберите "Управление параметрами службы приложений Azure".

При выборе откроется диалоговое окно параметров приложения для приложения-функции. Это диалоговое окно можно использовать для добавления параметров приложения или изменения существующих.

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

• Чтобы создать параметр приложения, нажмите кнопку "Добавить".
• Чтобы скопировать значение параметра из локального поля в удаленное поле, выберите "Вставить значение" из "Локальный".

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

Управление параметрами приложения также можно осуществлять с помощью одного из способов ниже.

• Используйте портал Azure.
• Используйте параметр публикации--publish-local-settings в основных средствах Функций Azure.
• Используйте Azure CLI.

Удаленная отладка

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

В этом разделе предполагается, что конфигурация отладки опубликована для вашего приложения-функции.

Рекомендации по удаленной отладке

• Удаленная отладка не рекомендуется для рабочей службы.
• Чтобы использовать удаленную отладку, необходимо разместить приложение-функцию в плане "Премиум" или "Служба приложений".
• Удаленная отладка в настоящее время поддерживается только при запуске приложения C# в Windows.
• Если вы включили функцию Just My Code в Visual Studio, отключите ее. См. инструкции в разделе Включение или отключение функции Just My Code.
• Избегайте длительных остановов в точках останова при использовании удаленной отладки. Когда процесс останавливается дольше нескольких минут, Azure обрабатывает его как неответственный процесс и завершает работу.
• При отладке сервер отправляет данные в Visual Studio, что может повлиять на расходы на пропускную способность. Сведения о тарифах пропускной способности см. в калькуляторе цен.
• Удаленная отладка автоматически отключается в приложении-функции через 48 часов. После этого необходимо включить удаленную отладку.

Подключение отладчика

После завершения отладки необходимо отключить удаленную отладку.

Отключение удаленной отладки

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

1. На странице профиля публикации перейдите в раздел Хостинг. Выберите многоточие (...), а затем нажмите кнопку "Открыть" на портале Azure. Портал Azure открывается на функциональном приложении, в которое развернут ваш проект.

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

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

Функции мониторинга

Рекомендуемый способ мониторинга функций — интеграция приложения-функции с Application Insights. Эту интеграцию следует включить при создании приложения-функции во время публикации Visual Studio.

Если интеграция не настроена во время публикации по какой-либо причине, необходимо включить интеграцию Application Insights для приложения-функции в Azure.

Дополнительные сведения об использовании Application Insights для мониторинга см. в статье "Мониторинг выполнения" в Функциях Azure.

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

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