Автоматизация развертывания ресурсов приложения-функции для службы "Функции Azure"
Вы можете использовать файл Bicep или шаблон Azure Resource Manager для автоматизации процесса развертывания приложения-функции в новых или существующих ресурсах Azure. Такая автоматизация позволяет интегрировать развертывания ресурсов с исходным кодом в DevOps, восстановить приложение-функцию и связанные ресурсы из резервной копии или развернуть топологию приложений несколько раз.
В этой статье показано, как автоматизировать создание ресурсов и развертывание для Функции Azure. В зависимости от триггеров и привязок, используемых функциями, может потребоваться развернуть другие ресурсы, которые находятся вне область этой статьи.
Конкретный код шаблона зависит от того, как размещено приложение-функция, независимо от того, развертывается ли код или контейнерное приложение-функция, а также операционная система, используемая приложением. В этой статье поддерживаются следующие варианты размещения:
Вариант размещения | Тип развертывания | Дополнительные сведения см. в статье ... |
---|---|---|
План потребления службы "Функции Azure" | Только код | План потребления |
план Функции Azure Elastic Premium | Код | Контейнер | План категории "Премиум" |
план выделенных Функции Azure (Служба приложений) | Код | Контейнер | План ценовой категории "Выделенный" |
Приложения контейнеров Azure | Только контейнер | Размещение приложений контейнеров Функции Azure |
Azure Arc | Код | Контейнер | Служба приложений, Функции и Logic Apps в Azure Arc (предварительная версия) |
Необходимые ресурсы
Развертывание, размещенное Функции Azure, обычно состоит из следующих ресурсов:
Ресурс | Требование | Справочник по синтаксису и свойствам |
---|---|---|
Учетная запись хранения | Обязательное поле | Microsoft.Storage/storageAccounts |
Компонент Application Insights | Рекомендуемая конфигурация | Microsoft.Insights/components |
План размещения | Обязательный1 | Microsoft.Web/serverfarms |
Приложение-функция | Обязательное поле | Microsoft.Web/sites |
Развертывание Функции Azure для плана потребления обычно состоит из следующих ресурсов:
Ресурс | Требование | Справочник по синтаксису и свойствам |
---|---|---|
Учетная запись хранения | Обязательное поле | Microsoft.Storage/storageAccounts |
Компонент Application Insights | Рекомендуемая конфигурация | Microsoft.Insights/components |
Приложение-функция | Обязательное поле | Microsoft.Web/sites |
Развертывание, размещенное в контейнерных приложениях Azure, обычно состоит из следующих ресурсов:
Ресурс | Требование | Справочник по синтаксису и свойствам |
---|---|---|
Учетная запись хранения | Обязательное поле | Microsoft.Storage/storageAccounts |
Компонент Application Insights | Рекомендуемая конфигурация | Microsoft.Insights/components |
Управляемая среда | Обязательное поле | Microsoft.App/managedEnvironments |
Приложение-функция | Обязательное поле | Microsoft.Web/sites |
Развертывание, размещенное в Azure Arc, обычно состоит из следующих ресурсов:
Ресурс | Требование | Справочник по синтаксису и свойствам |
---|---|---|
Учетная запись хранения | Обязательное поле | Microsoft.Storage/storageAccounts |
Компонент Application Insights | Рекомендуемая конфигурация | Microsoft.Insights/components |
Среда Kubernetes Служба приложений | Обязательное поле | Microsoft.ExtendedLocation/customLocations |
Приложение-функция | Обязательное поле | Microsoft.Web/sites |
1Явный план размещения не требуется при выборе размещения приложения-функции в плане потребления.
При развертывании нескольких ресурсов в одном файле Bicep или шаблоне ARM важно указать порядок создания ресурсов. Это требование является результатом зависимостей между ресурсами. Для таких зависимостей обязательно используйте dependsOn
элемент для определения зависимости в зависимом ресурсе. Дополнительные сведения см. в разделе "Определение порядка развертывания ресурсов в шаблонах ARM" или зависимостях ресурсов в Bicep.
В этой статье предполагается, что у вас есть базовое представление о создании файлов Bicep или создании шаблонов Azure Resource Manager, а примеры показаны в виде отдельных разделов для определенных ресурсов. Полный набор примеров шаблонов Bicep и ARM см . в следующих примерах развертывания приложения-функции.
Необходимые компоненты
В этой статье предполагается, что вы уже создали управляемую среду в приложениях контейнеров Azure. Для создания приложения-функции, размещенного в контейнерных приложениях, необходимо имя и идентификатор управляемой среды.
В этой статье предполагается, что вы уже создали пользовательское расположение с поддержкой Служба приложений в кластере Kubernetes с поддержкой Azure Arc. Для создания приложения-функции, размещенного в пользовательском расположении Azure Arc, необходимо как идентификатор пользовательского расположения, так и идентификатор среды Kubernetes.
Создание учетной записи хранения
Для всех приложений-функций требуется учетная запись хранения Azure. Необходима учетная запись общего назначения, поддерживающая большие двоичные объекты, таблицы, очереди и файлы. Дополнительные сведения см. в разделе Требования к учетной записи хранения.
Внимание
Учетная запись хранения используется для хранения важных данных приложения, иногда включая сам код приложения. Необходимо ограничить доступ от других приложений и пользователей к учетной записи хранения.
В этом примере создается учетная запись хранения уровня "Стандартный" версии 2:
"resources": [
{
"type": "Microsoft.Storage/storageAccounts",
"apiVersion": "2022-05-01",
"name": "[parameters('storageAccountName')]",
"location": "[parameters('location')]",
"kind": "StorageV2",
"sku": {
"name": "[parameters('storageAccountType')]"
},
"properties": {
"supportsHttpsTrafficOnly": true,
"defaultToOAuthAuthentication": true
}
}
]
Дополнительные сведения см. в полном azuredeploy.json файле в репозитории шаблонов.
Необходимо задать строка подключения этой учетной записи хранения в качестве AzureWebJobsStorage
параметра приложения, для которого требуются функции. Шаблоны, приведенные в этой статье, создают это значение строка подключения на основе созданной учетной записи хранения, которая рекомендуется. Дополнительные сведения см. в разделе "Конфигурация приложения".
Включение журналов хранилища
Так как учетная запись хранения используется для важных данных приложения-функции, следует отслеживать учетную запись для изменения этого содержимого. Чтобы отслеживать учетную запись хранения, необходимо настроить журналы ресурсов Azure Monitor для служба хранилища Azure. В этом примере в myLogAnalytics
качестве назначения для этих журналов используется рабочая область Log Analytics.
"resources": [
{
"type": "Microsoft.Insights/diagnosticSettings",
"apiVersion": "2021-05-01-preview",
"scope": "[format('Microsoft.Storage/storageAccounts/{0}/blobServices/default', parameters('storageAccountName'))]",
"name": "[parameters('storageDataPlaneLogsName')]",
"properties": {
"workspaceId": "[resourceId('Microsoft.OperationalInsights/workspaces', parameters('myLogAnalytics'))]",
"logs": [
{
"category": "StorageWrite",
"enabled": true
}
],
"metrics": [
{
"category": "Transaction",
"enabled": true
}
]
}
}
]
Эту же рабочую область можно использовать для ресурса приложения Аналитика, определенного позже. Дополнительные сведения, включая работу с этими журналами, см. в разделе "Мониторинг служба хранилища Azure".
Создание Application Insights
Аналитика приложения рекомендуется отслеживать выполнение приложения-функции. В этом примере ресурс Application Аналитика определен с типом Microsoft.Insights/components
и типомweb
:
{
"type": "Microsoft.Insights/components",
"apiVersion": "2020-02-02",
"name": "[variables('applicationInsightsName')]",
"location": "[parameters('appInsightsLocation')]",
"tags": {
"[format('hidden-link:{0}', resourceId('Microsoft.Web/sites', parameters('functionAppName')))]": "Resource"
},
"properties": {
"Application_Type": "web"
},
"kind": "web"
},
Дополнительные сведения см. в полном azuredeploy.json файле в репозитории шаблонов.
Подключение должно быть предоставлено приложению-функции с помощью APPLICATIONINSIGHTS_CONNECTION_STRING
параметра приложения. Дополнительные сведения см. в разделе "Параметры приложения".
Примеры, приведенные в этой статье, получают значение строка подключения для созданного экземпляра. Старые версии могут вместо этого использовать APPINSIGHTS_INSTRUMENTATIONKEY
для задания ключа инструментирования, который больше не рекомендуется.
Создание плана размещения
Приложения, размещенные в плане Функции Azure Premium или выделенном (Служба приложений), должны иметь явно определенный план размещения.
План "Премиум" предлагает такие же возможности масштабирования, как и план потребления, предоставляя выделенные ресурсы и дополнительные возможности. См. статью План "Премиум" Функций Azure.
План "Премиум" — это специальный тип ресурса serverfarm
. Его можно указать с помощью EP1
, EP2
либо EP3
для Name
значения свойства в свойстве sku
. Способ определения плана размещения функций зависит от того, работает ли приложение-функция в Windows или Linux. В этом примере показано, как EP1
создать план:
"resources": [
{
"type": "Microsoft.Web/serverfarms",
"apiVersion": "2022-03-01",
"name": "[parameters('hostingPlanName')]",
"location": "[parameters('location')]",
"sku": {
"name": "EP1",
"tier": "ElasticPremium",
"family": "EP"
},
"kind": "elastic",
"properties": {
"maximumElasticWorkerCount": 20
}
}
]
Дополнительные сведения см. в полном azuredeploy.json файле в репозитории шаблонов.
Дополнительные сведения об объекте sku
см SkuDefinition
. в примерах шаблонов.
В плане выделенных (Служба приложений) приложение-функция работает на выделенных виртуальных машинах на базовых, стандартных и премиум номерах SKU в планах Служба приложений, аналогичных веб-приложениям. Дополнительные сведения см. в разделе "Выделенный план".
Пример файла Bicep или шаблона Azure Resource Manager см. в приложении-функции в плане службы приложение Azure
В Функциях выделенный план — это просто обычный план Службы приложений, который определяется ресурсом serverfarm
. Необходимо указать по крайней name
мере значение. Список поддерживаемых имен планов см --sku
. в az appservice plan create
параметре текущего списка поддерживаемых значений для выделенного плана.
Способ определения плана размещения зависит от того, работает ли ваше приложение-функция в Windows или Linux:
"resources": [
{
"type": "Microsoft.Web/serverfarms",
"apiVersion": "2022-03-01",
"name": "[parameters('hostingPlanName')]",
"location": "[parameters('location')]",
"sku": {
"tier": "Standard",
"name": "S1",
"size": "S1",
"family": "S",
"capacity": 1
}
}
]
Дополнительные сведения см. в полном azuredeploy.json файле в репозитории шаблонов.
Создание плана размещения
Вам не нужно явно определять ресурс плана размещения потребления. При пропуске этого определения ресурса план автоматически создается или выбирается на основе каждого региона при создании самого ресурса приложения-функции.
Вы можете явно определить план потребления в качестве специального serverfarm
типа ресурса, который вы указываете, используя значение Dynamic
для computeMode
свойств и sku
свойств. В этом примере показано, как явно определить план потребления. Способ определения плана размещения зависит от того, работает ли ваше приложение-функция в Windows или Linux.
"resources": [
{
"type": "Microsoft.Web/serverfarms",
"apiVersion": "2022-03-01",
"name": "[parameters('hostingPlanName')]",
"location": "[parameters('location')]",
"sku": {
"name": "Y1",
"tier": "Dynamic",
"size": "Y1",
"family": "Y",
"capacity": 0
},
"properties": {
"computeMode": "Dynamic"
}
}
]
Дополнительные сведения см. в полном azuredeploy.json файле в репозитории шаблонов.
Среда Kubernetes
Функции Azure можно развернуть в Kubernetes с поддержкой Azure Arc либо как проект кода, либо контейнерное приложение-функцию.
Чтобы создать приложение и ресурс плана, у вас должна быть созданная среда Kubernetes для Службы приложений с кластером Kubernetes с поддержкой Azure Arc. В примерах в этой статье предполагается, что у вас есть идентификатор ресурса настраиваемого расположения (customLocationId
) и Служба приложений среде Kubernetes (kubeEnvironmentId
), в которой выполняется развертывание, в этом примере.
"parameters": {
"kubeEnvironmentId" : {
"type": "string"
},
"customLocationId" : {
"type": "string"
}
}
И сайты, и планы должны ссылаться на пользовательское расположение с помощью поля extendedLocation
. Как показано в этом усеченном примере, extendedLocation
находится за пределами properties
однорангового kind
узла и location
:
{
"type": "Microsoft.Web/serverfarms",
...
{
"extendedLocation": {
"name": "[parameters('customLocationId')]"
},
}
}
Ресурс плана должен использовать значение Kubernetes (K1
) для SKU
, kind
поле должно быть, и reserved
свойство должно бытьlinux,kubernetes
true
, так как это развертывание Linux. Необходимо также задать extendedLocation
kubeEnvironmentProfile.id
идентификатор пользовательского расположения и идентификатор среды Kubernetes соответственно, который может выглядеть следующим образом:
"resources": [
{
"type": "Microsoft.Web/serverfarms",
"apiVersion": "2022-03-01",
"name": "[parameters('hostingPlanName')]",
"location": "[parameters('location')]",
"kind": "linux,kubernetes",
"sku": {
"name": "K1",
"tier": "Kubernetes"
},
"extendedLocation": {
"name": "[parameters('customLocationId')]"
},
"properties": {
"kubeEnvironmentProfile": {
"id": "[parameters('kubeEnvironmentId')]"
},
"reserved": true
}
}
]
Создание приложения-функции
Ресурс приложения-функции определяется ресурсом типа Microsoft.Web/sites
и kind
включает functionapp
как минимум.
Способ определения ресурса приложения-функции зависит от того, размещается ли вы в Linux или в Windows:
Список параметров приложения, необходимых при запуске в Windows, см. в разделе "Конфигурация приложения". Пример шаблона Bicep-файла или Azure Resource Manager см . в приложении-функции, размещенном в Windows в шаблоне плана потребления.
Список параметров приложения, необходимых при запуске в Windows, см. в разделе "Конфигурация приложения".
Примечание.
Если вы решили дополнительно определить план потребления, необходимо задать serverFarmId
свойство в приложении таким образом, чтобы он указывает на идентификатор ресурса плана. Убедитесь, что приложение-функция имеет dependsOn
параметр, который также ссылается на план. Если вы явно не определили план, он создается для вас.
serverFarmId
Задайте свойство в приложении таким образом, чтобы он указывает на идентификатор ресурса плана. Убедитесь, что приложение-функция имеет dependsOn
параметр, который также ссылается на план.
"resources": [
{
"type": "Microsoft.Web/sites",
"apiVersion": "2022-03-01",
"name": "[parameters('functionAppName')]",
"location": "[parameters('location')]",
"kind": "functionapp",
"dependsOn": [
"[resourceId('Microsoft.Insights/components', parameters('applicationInsightsName'))]",
"[resourceId('Microsoft.Web/serverfarms', parameters('hostingPlanName'))]",
"[resourceId('Microsoft.Storage/storageAccounts', parameters('storageAccountName'))]"
],
"properties": {
"serverFarmId": "[resourceId('Microsoft.Web/serverfarms', parameters('hostingPlanName'))]",
"siteConfig": {
"appSettings": [
{
"name": "APPLICATIONINSIGHTS_CONNECTION_STRING",
"value": "[reference(resourceId('Microsoft.Insights/components', parameters('applicationInsightsName')), '2020-02-02').ConnectionString]"
},
{
"name": "AzureWebJobsStorage",
"value": "[format('DefaultEndpointsProtocol=https;AccountName={0};EndpointSuffix={1};AccountKey={2}', parameters('storageAccountName'), environment().suffixes.storage, listKeys(resourceId('Microsoft.Storage/storageAccounts', parameters('storageAccountName')), '2021-09-01').keys[0].value)]"
},
{
"name": "WEBSITE_CONTENTAZUREFILECONNECTIONSTRING",
"value": "[format('DefaultEndpointsProtocol=https;AccountName={0};EndpointSuffix={1};AccountKey={2}', parameters('storageAccountName'), environment().suffixes.storage, listKeys(resourceId('Microsoft.Storage/storageAccounts', parameters('storageAccountName')), '2021-09-01').keys[0].value)]"
},
{
"name": "WEBSITE_CONTENTSHARE",
"value": "[toLower(parameters('functionAppName'))]"
},
{
"name": "FUNCTIONS_EXTENSION_VERSION",
"value": "~4"
},
{
"name": "FUNCTIONS_WORKER_RUNTIME",
"value": "node"
},
{
"name": "WEBSITE_NODE_DEFAULT_VERSION",
"value": "~14"
}
]
}
}
}
]
Полный пример см. в этом azuredeploy.json шаблоне.
"resources": [
{
"type": "Microsoft.Web/sites",
"apiVersion": "2022-03-01",
"name": "[parameters('functionAppName')]",
"location": "[parameters('location')]",
"kind": "functionapp",
"dependsOn": [
"[resourceId('Microsoft.Insights/components', parameters('applicationInsightsName'))]",
"[resourceId('Microsoft.Web/serverfarms', parameters('hostingPlanName'))]",
"[resourceId('Microsoft.Storage/storageAccounts', parameters('storageAccountName'))]"
],
"properties": {
"serverFarmId": "[resourceId('Microsoft.Web/serverfarms', parameters('hostingPlanName'))]",
"siteConfig": {
"alwaysOn": true,
"appSettings": [
{
"name": "APPLICATIONINSIGHTS_CONNECTION_STRING",
"value": "[reference(resourceId('Microsoft.Insights/components', parameters('applicationInsightsName')), '2020-02-02').ConnectionString]"
},
{
"name": "AzureWebJobsStorage",
"value": "[format('DefaultEndpointsProtocol=https;AccountName={0};EndpointSuffix={1};AccountKey={2}', parameters('storageAccountName'), environment().suffixes.storage, listKeys(resourceId('Microsoft.Storage/storageAccounts', parameters('storageAccountName')), '2021-09-01').keys[0].value)]"
},
{
"name": "FUNCTIONS_EXTENSION_VERSION",
"value": "~4"
},
{
"name": "FUNCTIONS_WORKER_RUNTIME",
"value": "node"
},
{
"name": "WEBSITE_NODE_DEFAULT_VERSION",
"value": "~14"
}
]
}
}
}
]
Полный пример см. в этом azuredeploy.json шаблоне.
Источники развертывания
Файл Bicep или шаблон ARM также может определить развертывание для кода функции, которое может включать следующие методы:
Источники развертывания
Файл Bicep или шаблон ARM также может определить развертывание кода функции с помощью пакета развертывания ZIP.
Чтобы с помощью Azure Resource Manager успешно развернуть приложение, важно понимать, каким образом ресурсы развертываются в Azure. В большинстве примеров конфигурации верхнего уровня применяются с помощью siteConfig
. Их важно задать на верхнем уровне, так как эти конфигурации передают сведения в среду выполнения функций и механизм развертывания. Сведения верхнего уровня требуются перед применением дочернего sourcecontrols/web
ресурса. Хотя эти параметры можно настроить в ресурсе дочернего уровня config/appSettings
, в некоторых случаях приложение-функцию необходимо развернуть передconfig/appSettings
применением.
Пакет развертывания ZIP
Развертывание ZIP-файла — это рекомендуемый способ развертывания кода приложения-функции. По умолчанию функции, использующие zip-развертывание, выполняются в самом пакете развертывания. Дополнительные сведения, включая требования к пакету развертывания, см. в статье о развертывании Zip для Функции Azure. При использовании автоматизации развертывания ресурсов можно ссылаться на пакет развертывания .zip в шаблоне Bicep или ARM.
Чтобы использовать zip-развертывание в шаблоне, задайте WEBSITE_RUN_FROM_PACKAGE
параметр в приложении 1
и включите /zipDeploy
определение ресурса.
Для плана потребления в Linux вместо этого задайте универсальный код ресурса (URI) пакета развертывания непосредственно в параметре WEBSITE_RUN_FROM_PACKAGE
, как показано в этом примере шаблона.
В этом примере в существующее приложение добавляется источник zip-развертывания:
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"functionAppName": {
"type": "string",
"metadata": {
"description": "The name of the Azure Function app."
}
},
"location": {
"type": "string",
"defaultValue": "[resourceGroup().location]",
"metadata": {
"description": "The location into which the resources should be deployed."
}
},
"packageUri": {
"type": "string",
"metadata": {
"description": "The zip content url."
}
}
},
"resources": [
{
"name": "[concat(parameters('functionAppName'), '/ZipDeploy')]",
"type": "Microsoft.Web/sites/extensions",
"apiVersion": "2021-02-01",
"location": "[parameters('location')]",
"properties": {
"packageUri": "[parameters('packageUri')]"
}
}
]
}
При включении ресурсов zip-развертывания в шаблон следует учитывать следующие моменты:
- Планы потребления в Linux не поддерживаются
WEBSITE_RUN_FROM_PACKAGE = 1
. Вместо этого необходимо задать универсальный код ресурса (URI) пакета развертывания непосредственно в параметреWEBSITE_RUN_FROM_PACKAGE
. Дополнительные сведения см. в WEBSITE_RUN_FROM_PACKAGE. Пример шаблона см. в разделе "Приложение-функция", размещенное в Linux в плане потребления.
Это
packageUri
должно быть расположение, к которому можно получить доступ с помощью Функций. Рекомендуется использовать хранилище BLOB-объектов Azure с подписанным URL-адресом (SAS). После истечения срока действия SAS функции больше не смогут получить доступ к общей папке для развертываний. При повторном создании SAS не забудьте обновитьWEBSITE_RUN_FROM_PACKAGE
параметр с новым значением URI.При настройке
WEBSITE_RUN_FROM_PACKAGE
URI необходимо вручную синхронизировать триггеры.Всегда устанавливайте все необходимые параметры приложения в
appSettings
коллекции при добавлении или обновлении параметров. Существующие параметры, не заданные явным образом, удаляются обновлением. Дополнительные сведения см. в разделе "Конфигурация приложения".Функции не поддерживают веб-развертывание (msdeploy) для развертываний пакетов. Вместо этого необходимо использовать zip-развертывание в конвейерах развертывания и автоматизации. Дополнительные сведения см. в статье о развертывании Zip для Функции Azure.
Удаленные сборки
В процессе развертывания предполагается, что используемый вами файл .zip или zip-развертывание содержит готовое к выполнению приложение. Это означает, что по умолчанию настройки не выполняются.
Однако существуют сценарии, которые требуют удаленного перестроения приложения, например при необходимости извлечения пакетов linux в Python или Node.js приложений, разработанных на компьютере Windows. В этом случае функции можно настроить для удаленной сборки кода после развертывания ZIP.
Способ запроса удаленной сборки зависит от операционной системы, в которой выполняется развертывание:
При развертывании приложения в Windows выполняются команды, относящиеся к языку (например dotnet restore
, для приложений C# или npm install
для приложений Node.js).
Чтобы включить те же процессы сборки, которые вы получаете с непрерывной интеграцией, добавьте SCM_DO_BUILD_DURING_DEPLOYMENT=true
параметры приложения в код развертывания и удалите WEBSITE_RUN_FROM_PACKAGE
полностью.
Контейнеры Linux
Если вы развертываете контейнерное приложение-функцию в Функции Azure ценовой категории "Премиум" или "Выделенный", необходимо:
linuxFxVersion
Задайте параметр сайта с идентификатором образа контейнера.- Задайте все необходимые
DOCKER_REGISTRY_SERVER_*
параметры при получении контейнера из частного реестра. - Задайте
WEBSITES_ENABLE_APP_SERVICE_STORAGE
для параметра приложения значениеfalse
.
Дополнительные сведения см. в разделе "Конфигурация приложения".
"resources": [
{
"type": "Microsoft.Web/sites",
"apiVersion": "2022-03-01",
"name": "[parameters('functionAppName')]",
"location": "[parameters('location')]",
"kind": "functionapp",
"dependsOn": [
"[resourceId('Microsoft.Web/serverfarms', parameters('hostingPlanName'))]",
"[resourceId('Microsoft.Storage/storageAccounts', parameters('storageAccountName'))]"
],
"properties": {
"serverFarmId": "[resourceId('Microsoft.Web/serverfarms', parameters('hostingPlanName'))]",
"siteConfig": {
"appSettings": [
{
"name": "AzureWebJobsStorage",
"value": "[format('DefaultEndpointsProtocol=https;AccountName={0};AccountKey={1}', parameters('storageAccountName'), listKeys(resourceId('Microsoft.Storage/storageAccounts', parameters('storageAccountName')), '2021-09-01').keys[0].value)]"
},
{
"name": "FUNCTIONS_WORKER_RUNTIME",
"value": "node"
},
{
"name": "WEBSITE_NODE_DEFAULT_VERSION",
"value": "~14"
},
{
"name": "FUNCTIONS_EXTENSION_VERSION",
"value": "~4"
},
{
"name": "DOCKER_REGISTRY_SERVER_URL",
"value": "[parameters('dockerRegistryUrl')]"
},
{
"name": "DOCKER_REGISTRY_SERVER_USERNAME",
"value": "[parameters('dockerRegistryUsername')]"
},
{
"name": "DOCKER_REGISTRY_SERVER_PASSWORD",
"value": "[parameters('dockerRegistryPassword')]"
},
{
"name": "WEBSITES_ENABLE_APP_SERVICE_STORAGE",
"value": "false"
}
],
"linuxFxVersion": "DOCKER|myacr.azurecr.io/myimage:mytag"
}
}
}
]
При развертывании контейнерных функций в приложениях контейнеров Azure шаблон должен:
kind
Задайте для поля значениеfunctionapp,linux,container,azurecontainerapps
.- Задайте свойству
managedEnvironmentId
сайта полный универсальный код ресурса (URI) среды "Приложения контейнеров". - Добавьте ссылку на ресурсы в коллекцию сайта
dependsOn
при созданииMicrosoft.App/managedEnvironments
ресурса одновременно с сайтом.
Определение контейнерного приложения-функции, развернутого из частного реестра контейнеров в существующей среде приложений контейнеров, может выглядеть следующим образом:
"resources": [
{
"type": "Microsoft.Web/sites",
"apiVersion": "2022-03-01",
"name": "[parameters('functionAppName')]",
"kind": "functionapp,linux,container,azurecontainerapps",
"location": "[parameters('location')]",
"dependsOn": [
"[resourceId('Microsoft.Insights/components', parameters('applicationInsightsName'))]",
"[resourceId('Microsoft.Storage/storageAccounts', parameters('storageAccountName'))]"
],
"properties": {
"serverFarmId": "[parameters('hostingPlanName')]",
"siteConfig": {
"linuxFxVersion": "DOCKER|myacr.azurecr.io/myimage:mytag",
"appSettings": [
{
"name": "FUNCTIONS_EXTENSION_VERSION",
"value": "~4"
},
{
"name": "AzureWebJobsStorage",
"value": "[format('DefaultEndpointsProtocol=https;AccountName={0};AccountKey={1}', parameters('storageAccountName'), listKeys(resourceId('Microsoft.Storage/storageAccounts', parameters('storageAccountName')), '2021-09-01').keys[0].value)]"
},
{
"name": "APPLICATIONINSIGHTS_CONNECTION_STRING",
"value": "[reference(resourceId('Microsoft.Insights/components', parameters('applicationInsightsName')), '2020-02-02').ConnectionString]"
}
],
},
"managedEnvironmentId": "[parameters('managedEnvironmentId')]"
}
}
]
При развертывании функций в Azure Arc значение, заданное для kind
поля ресурса приложения-функции, зависит от типа развертывания:
Тип развертывания | kind значение поля |
---|---|
Развертывание только для кода | functionapp,linux,kubernetes |
Контейнерное развертывание | functionapp,linux,kubernetes,container |
Кроме того, необходимо задать параметры customLocationId
, которые вы сделали для ресурса плана размещения.
Определение контейнерного приложения-функции с помощью образа краткого руководства .NET 6 может выглядеть следующим образом:
"resources": [
{
"type": "Microsoft.Web/sites",
"apiVersion": "2022-03-01",
"name": "[parameters('functionAppName')]",
"kind": "kubernetes,functionapp,linux,container",
"location": "[parameters('location')]",
"extendedLocation": {
"name": "[parameters('customLocationId')]"
},
"dependsOn": [
"[resourceId('Microsoft.Insights/components', parameters('applicationInsightsName'))]",
"[resourceId('Microsoft.Web/serverfarms', parameters('hostingPlanName'))]",
"[resourceId('Microsoft.Storage/storageAccounts', parameters('storageAccountName'))]"
],
"properties": {
"serverFarmId": "[parameters('hostingPlanName')]",
"siteConfig": {
"linuxFxVersion": "DOCKER|mcr.microsoft.com/azure-functions/4-dotnet-isolated6.0-appservice-quickstart",
"appSettings": [
{
"name": "FUNCTIONS_EXTENSION_VERSION",
"value": "~4"
},
{
"name": "AzureWebJobsStorage",
"value": "[format('DefaultEndpointsProtocol=https;AccountName={0};AccountKey={1}', parameters('storageAccountName'), listKeys(resourceId('Microsoft.Storage/storageAccounts', parameters('storageAccountName')), '2021-09-01').keys[0].value)]"
},
{
"name": "APPLICATIONINSIGHTS_CONNECTION_STRING",
"value": "[reference(resourceId('Microsoft.Insights/components', parameters('applicationInsightsName')), '2020-02-02').ConnectionString]"
}
],
"alwaysOn": true
}
}
}
]
Конфигурация приложений
Функции предоставляют следующие параметры настройки приложения-функции в Azure:
Настройка | Свойство Microsoft.Web/sites |
---|---|
Параметры сайта | siteConfig |
Параметры приложения | Коллекция siteConfig.appSettings |
Для свойства требуются siteConfig
следующие параметры сайта:
Эти параметры приложения являются обязательными (или рекомендуемыми) для определенной операционной системы и варианта размещения:
Эти параметры приложения необходимы для развертываний контейнеров:
Эти параметры требуются только при развертывании из частного реестра контейнеров:
Учитывайте эти рекомендации при работе с параметрами сайта и приложения с помощью файлов Bicep или шаблонов ARM:
- Существуют важные рекомендации по настройке
WEBSITE_CONTENTSHARE
в автоматическом развертывании. Подробные инструкции см. в справочникеWEBSITE_CONTENTSHARE
.
- Для развертываний контейнеров также задано
WEBSITES_ENABLE_APP_SERVICE_STORAGE
false
значение , так как содержимое приложения предоставляется в самом контейнере.
Вы всегда должны определять параметры приложения как
siteConfig/appSettings
коллекцию создаваемогоMicrosoft.Web/sites
ресурса, как показано в примерах в этой статье. Это гарантирует, что параметры, необходимые приложению-функции, доступны при первоначальном запуске.При добавлении или обновлении параметров приложения с помощью шаблонов убедитесь, что все существующие параметры включены в обновление. Это необходимо сделать, так как базовые вызовы REST API обновления заменяют весь
/config/appsettings
ресурс. Если удалить существующие параметры, приложение-функция не будет запускаться. Для программного обновления отдельных параметров приложения можно использовать Azure CLI, Azure PowerShell или портал Azure для внесения этих изменений. Дополнительные сведения см. в разделе Работа с параметрами приложения.
Развертывания слотов
Функции позволяют развертывать различные версии кода в уникальных конечных точках в приложении-функции. Это упрощает разработку, проверку и развертывание обновлений функций без влияния на функции, выполняемые в рабочей среде. Слоты развертывания — это функция службы приложение Azure. Количество доступных слотов зависит от плана размещения. Дополнительные сведения см. в разделе Функции Azure функции слотов развертывания.
Ресурс слота определяется так же, как ресурс приложения-функции (Microsoft.Web/sites
), но вместо этого используется Microsoft.Web/sites/slots
идентификатор ресурса. Пример развертывания (в шаблонах Bicep и ARM), создающих рабочий и промежуточный слот в плане Premium, см . в приложении-функции Azure с слотом развертывания.
Сведения о том, как выполнять переключение с помощью шаблонов, см. в статье "Автоматизация с помощью шаблонов Resource Manager".
При работе с развертываниями слотов следует учитывать следующие рекомендации.
Не устанавливайте
WEBSITE_CONTENTSHARE
явно параметр в определении слота развертывания. Этот параметр создается автоматически при создании приложения в слоте развертывания.При переключении слотов некоторые параметры приложения считаются "липкими", в том, что они остаются с слотом, а не с кодом, который переключается. Вы можете определить такой параметр слота, включив
"slotSetting":true
в определение конкретного параметра приложения в шаблоне. Дополнительные сведения см. в разделе "Управление параметрами".
Защищенные развертывания
Вы можете создать приложение-функцию в развертывании, где один или несколько ресурсов были защищены, интегрируя с виртуальными сетями. Интеграция виртуальной сети для приложения-функции определяется ресурсом Microsoft.Web/sites/networkConfig
. Эта интеграция зависит от указанных приложений-функций и ресурсов виртуальной сети. Приложение-функция может также зависеть от других ресурсов частной сети, таких как частные конечные точки и маршруты. Дополнительные сведения см. в статье Возможности работы с сетью в Функциях Azure.
При создании развертывания, использующего безопасную учетную запись хранения, необходимо явно задать WEBSITE_CONTENTSHARE
параметр и создать ресурс общей папки с именем этого параметра. Убедитесь, что вы создаете Microsoft.Storage/storageAccounts/fileServices/shares
ресурс с помощью значения WEBSITE_CONTENTSHARE
, как показано в этом примере (файл Bicep шаблона|ARM). Кроме того, необходимо задать для свойства vnetContentShareEnabled
сайта значение true.
Примечание.
Если эти параметры не являются частью развертывания, использующего защищенную учетную запись хранения, вы увидите эту ошибку во время проверки развертывания: Could not access storage account using provided connection string
Эти проекты предоставляют примеры шаблонов Bicep и ARM о том, как развертывать приложения-функции в виртуальной сети, в том числе с ограничениями доступа к сети:
Ограниченный сценарий | Description |
---|---|
Создание приложения-функции с интеграцией виртуальной сети | Приложение-функция создается в виртуальной сети с полным доступом к ресурсам в этой сети. Входящий и исходящий доступ к приложению-функции не ограничен. Дополнительные сведения см. в разделе Интеграция виртуальной сети. |
Создание приложения-функции, обращающееся к защищенной учетной записи хранения | Созданное приложение-функция использует безопасную учетную запись хранения, к которой функции обращаются с помощью частных конечных точек. Дополнительные сведения см. в разделе Ограничьте учетную запись хранения виртуальной сети. |
Создание приложения-функции и учетной записи хранения, которые используют частные конечные точки | Доступ к созданному приложению-функции можно получить только с помощью частных конечных точек, а для доступа к ресурсам хранилища используется частная конечная точка. Дополнительные сведения см. в разделе "Частные конечные точки". |
Параметры ограниченной сети
Возможно, вам также потребуется использовать эти параметры, если приложение-функция имеет ограничения сети:
Параметр | значение | Описание |
---|---|---|
WEBSITE_CONTENTOVERVNET |
1 |
Параметр приложения, позволяющий приложению-функции масштабироваться, если учетная запись хранения ограничена виртуальной сетью. Дополнительные сведения см. в разделе Ограничьте учетную запись хранения виртуальной сети. |
vnetrouteallenabled |
1 |
Параметр сайта, который заставляет весь трафик из приложения-функции использовать виртуальную сеть. Дополнительные сведения см. в разделе "Интеграция региональной виртуальной сети". Этот параметр сайта заменяет параметр WEBSITE_VNET_ROUTE_ALL приложения. |
Рекомендации по ограничениям сети
При ограничении доступа к учетной записи хранения через частные конечные точки вы не сможете получить доступ к учетной записи хранения через портал или любое устройство за пределами виртуальной сети. Вы можете предоставить доступ к защищенному IP-адресу или виртуальной сети в учетной записи хранения, управляя правилом доступа к сети по умолчанию.
Создание шаблона
Эксперты с шаблонами Bicep или ARM могут вручную закодирует развертывания с помощью простого текстового редактора. Для остальных нас существует несколько способов упростить процесс разработки:
Visual Studio Code: доступны расширения, которые помогут вам работать как с файлами Bicep, так и с шаблонами ARM. Вы можете использовать эти средства, чтобы убедиться, что ваш код правильный, и они предоставляют некоторую базовую проверку.
портал Azure. При создании приложения-функции и связанных ресурсов на портале окончательный просмотр и создание экрана содержит шаблон скачивания ссылки для автоматизации.
Эта ссылка показывает шаблон ARM, созданный на основе параметров, выбранных на портале. Хотя этот шаблон может быть немного сложным при создании приложения-функции с большим количеством новых ресурсов, он может предоставить хорошую ссылку на то, как может выглядеть шаблон ARM.
Проверка шаблона
При создании файла шаблона развертывания вручную важно проверить шаблон перед развертыванием. Все методы развертывания проверяют синтаксис шаблона и вызывают сообщение об ошибке validation failed
, как показано в следующем формате JSON:
{"error":{"code":"InvalidTemplate","message":"Deployment template validation failed: 'The resource 'Microsoft.Web/sites/func-xyz' is not defined in the template. Please see https://aka.ms/arm-template for usage details.'.","additionalInfo":[{"type":"TemplateViolation","info":{"lineNumber":0,"linePosition":0,"path":""}}]}}
Для проверки шаблона перед развертыванием можно использовать следующие методы:
Следующая задачаdeploymentMode: 'Validation'
развертывания группы ресурсов Azure версии 2 с указанием Azure Pipelines проверить шаблон.
- task: AzureResourceManagerTemplateDeployment@3
inputs:
deploymentScope: 'Resource Group'
subscriptionId: # Required subscription ID
action: 'Create Or Update Resource Group'
resourceGroupName: # Required resource group name
location: # Required when action == Create Or Update Resource Group
templateLocation: 'Linked artifact'
csmFile: # Required when TemplateLocation == Linked Artifact
csmParametersFile: # Optional
deploymentMode: 'Validation'
Вы также можете создать тестовую группу ресурсов для поиска ошибок предварительной проверки и развертывания .
Развертывание шаблона
Для развертывания файла Bicep и шаблона можно использовать любой из следующих способов:
Кнопка "Развертывание в Azure"
Примечание.
Этот метод сейчас не поддерживает развертывание файлов Bicep.
Замените <url-encoded-path-to-azuredeploy-json>
версией необработанного пути к файлу azuredeploy.json
на сайте GitHub, указав его в формате URL-адреса.
Ниже приведен пример использования разметки:
[![Deploy to Azure](https://azuredeploy.net/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/<url-encoded-path-to-azuredeploy-json>)
Ниже приведен пример использования HTML:
<a href="https://portal.azure.com/#create/Microsoft.Template/uri/<url-encoded-path-to-azuredeploy-json>" target="_blank"><img src="https://azuredeploy.net/deploybutton.png"></a>
Развертывание с помощью PowerShell
Следующие команды PowerShell создают группу ресурсов и развертывают файл Bicep или шаблон ARM, который создает приложение-функцию с необходимыми ресурсами. Для локального выполнения у вас должна быть установлена среда Azure PowerShell. Выполните Connect-AzAccount
, чтобы войти в систему.
# Register Resource Providers if they're not already registered
Register-AzResourceProvider -ProviderNamespace "microsoft.web"
Register-AzResourceProvider -ProviderNamespace "microsoft.storage"
# Create a resource group for the function app
New-AzResourceGroup -Name "MyResourceGroup" -Location 'West Europe'
# Deploy the template
New-AzResourceGroupDeployment -ResourceGroupName "MyResourceGroup" -TemplateFile azuredeploy.json -Verbose
Чтобы протестировать это развертывание, попробуйте применить шаблон такого вида, который создает приложение-функцию в Windows с планом потребления.
Следующие шаги
Дополнительные сведения о разработке и настройке Функций Azure: