你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。

在 Azure 容器应用的自定义容器中创建函数应用

在本文中,你将创建一个在 Linux 容器中运行的 Azure Functions 应用,并从容器注册表将其部署到 Azure 容器应用环境。 通过部署到容器应用,可以将函数应用集成到云原生微服务中。 有关详细信息,请参阅 Azure Functions 的 Azure 容器应用托管。

完成本快速入门会在你的 Azure 帐户中产生一小笔费用,但在您完成后通过清理资源可以将成本降到最低。

选择开发语言

首先,使用 Azure Functions 工具通过特定于语言的 Linux 基础映像在 Docker 容器中创建项目代码作为函数应用。 确保在文章顶部选择所需语言。

Core Tools 会自动为项目生成一个 Dockerfile,它将针对你的函数语言使用最新版本的正确基础映像。 你应该定期从最新的基础映像更新容器,并从更新后的容器版本进行重新部署。 有关详细信息,请参阅 创建容器化函数应用。

先决条件

在开始之前,必须满足以下要求:

如果没有 Azure 订阅,请在开始之前创建一个免费帐户。

若要将创建的容器化函数应用映像发布到容器注册表,需要在本地计算机上运行的 Docker ID 和 Docker Desktop 。 如果你没有 Docker ID,可以创建一个 Docker 帐户。

还需要完成容器注册表快速入门的 “创建容器注册表 ”部分。 记下完全限定的登录服务器名称。

创建并激活虚拟环境

在适当的文件夹中,运行以下命令以创建并激活一个名为 .venv 的虚拟环境。 确保使用 Azure Functions 支持的 Python 版本之一。

python -m venv .venv
source .venv/bin/activate

如果 Python 未在 Linux 分发版中安装 venv 包,请运行以下命令:

sudo apt-get install python3-venv

所有后续命令将在这个已激活的虚拟环境中运行。

创建并测试本地 Functions 项目

在终端或命令提示符下,根据所选的语言运行以下命令,以便在当前文件夹中创建一个函数应用项目:

func init --worker-runtime dotnet-isolated --docker
func init --worker-runtime node --language javascript --docker
func init --worker-runtime powershell --docker
func init --worker-runtime python --docker
func init --worker-runtime node --language typescript --docker

在空文件夹中,运行以下命令,从 Maven 原型生成 Functions 项目:

mvn archetype:generate -DarchetypeGroupId=com.microsoft.azure -DarchetypeArtifactId=azure-functions-archetype -DjavaVersion=8 -Ddocker

-DjavaVersion 参数告诉 Functions 运行时要使用哪个 Java 版本。 如果希望函数在 Java 11 上运行,请使用 -DjavaVersion=11。 如果不指定 -DjavaVersion,则 Maven 默认使用 Java 8。 有关详细信息,请参阅 Java 版本。

重要

要完成本文中的步骤,JAVA_HOME 环境变量必须设置为正确版本的 JDK 的安装位置。

Maven 会请求你提供所需的值,以在部署上完成项目的生成。 按照提示提供以下信息:

Prompt 价值 Description
groupId com.fabrikam 一个值,用于按照 Java 的包命名规则在所有项目中标识你的项目。
artifactId fabrikam-functions 一个值,该值是 jar 的名称,没有版本号。
版本 1.0-SNAPSHOT 选择默认值。
package com.fabrikam.functions 一个值,该值是所生成函数代码的 Java 包。 使用默认值。

键入 Y 或按 Enter 进行确认。

Maven 在一个名为artifactId的新文件夹中创建工程文件,在此示例中为fabrikam-functions。

该 --docker 选项为项目生成 Dockerfile ,该项目定义适合用于 Azure Functions 和所选运行时的容器。

导航到项目文件夹:

cd fabrikam-functions

使用以下命令将一个函数添加到项目,其中,--name 参数是该函数的唯一名称,--template 参数指定该函数的触发器。 func new 将在项目中创建一个 C# 代码文件。

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

使用以下命令将一个函数添加到项目,其中,--name 参数是该函数的唯一名称,--template 参数指定该函数的触发器。 func new 创建一个与函数名称匹配的子文件夹,其中包含名为 function.json的配置文件。

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

若要在本地测试函数,请启动项目文件夹的根目录中的本地 Azure Functions 运行时主机。 若要确保在 Docker 中托管后可以调用该函数,请检查授权级别是否已设置为 AuthorizationLevel.Anonymous,或设置它(如果尚未配置)。

func start  
func start  
npm install
npm start
mvn clean package  
mvn azure-functions:run

看到 HttpExample 终结点写入输出后,导航到该终结点。 响应输出中应该可看到欢迎消息。

看到 HttpExample 终结点写入输出后,导航到 http://localhost:7071/api/HttpExample?name=Functions。 浏览器一定会显示一条“hello”消息,该消息回显 Functions(提供给 name 查询参数的值)。

按 Ctrl+C (macOS 上的命令+C )停止主机。

生成容器映像并在本地验证

(可选)检查项目文件夹根目录中的 Dockerfile 。 Dockerfile 介绍了在 Linux 上运行函数应用所需的环境。 Azure Functions 支持的基础映像的完整列表可以在 Azure Functions 基础映像页中找到。

在根项目文件夹中,运行 docker build 命令,提供一个名称azurefunctionsimage,并以v1.0.0作为标签。 将 <DOCKER-ID> 替换为 Docker 中心帐户 ID。 此命令为容器生成 Docker 映像。

docker build --tag <DOCKER-ID>/azurefunctionsimage:v1.0.0 .

该命令完成后,可在本地运行新容器。

若要验证生成,请使用 docker run 命令在本地容器中运行映像,再次替换为 <DOCKER-ID> Docker 中心帐户 ID,并将端口参数添加为 -p 8080:80:

docker run -p 8080:80 -it <DOCKER-ID>/azurefunctionsimage:v1.0.0

映像在本地容器中启动后,请浏览到 http://localhost:8080/api/HttpExample,其中一定会显示与先前相同的问候消息。 由于你创建的 HTTP 触发函数使用匿名授权,因此你无需获取访问密钥即可调用容器中运行的函数。 有关详细信息,请参阅 授权密钥。

映像在本地容器中启动后,请浏览到 http://localhost:8080/api/HttpExample?name=Functions,其中一定会显示与先前相同的“hello”消息。 由于你创建的 HTTP 触发函数使用匿名授权,因此你无需获取访问密钥即可调用容器中运行的函数。 有关详细信息,请参阅 授权密钥。

验证容器中的函数应用后,按 Ctrl+C (macOS 上的命令+C )停止执行。

将容器映像发布到注册表

若要使容器映像可用于部署到托管环境,必须将其推送到容器注册表。 作为安全最佳做法,应使用 Azure 容器注册表实例并强制实施基于托管标识的连接。 Docker Hub 要求你使用共享机密进行身份验证,这使得部署更容易受到攻击。

Azure 容器注册表是一项专用注册表服务,用于生成、存储和管理容器映像和相关项目。 应使用专用注册表服务将容器发布到 Azure 服务。

  1. 使用此命令使用当前的 Azure 凭据登录到注册表实例。 将 <REGISTRY-NAME> 替换为您的容器注册表实例名称。

    az acr login --name <REGISTRY-NAME>
    
  2. 使用此命令用注册表登录服务器的完全限定名称标记映像。 将 <LOGIN-SERVER> 替换为注册表登录服务器的完全限定名称,并将 <DOCKER-ID> 替换为 Docker ID。

    docker tag <DOCKER-ID>/azurefunctionsimage:v1.0.0 <LOGIN-SERVER>/azurefunctionsimage:v1.0.0 
    
  3. 使用以下命令将容器推送到注册表实例:

    docker push <LOGIN-SERVER>/azurefunctionsimage:v1.0.0
    

创建函数的支持性 Azure 资源

需要先创建三个资源,然后才可将容器部署到 Azure:

  • 一个资源组:相关资源的逻辑容器。

  • 一个 Azure 存储帐户,用于维护有关函数的状态和其他信息。

  • 创建具有 Log Analytics 工作区的 Azure 容器应用环境。

  • 用户分配的托管标识,使函数应用能够在不使用共享密钥的情况下安全地连接到 Azure 资源。 与 Azure 存储帐户和 Azure 容器注册表实例的连接都是使用 Microsoft Entra 身份验证和标识进行的,这是针对此方案建议的。

    注释

    Docker Hub 不支持托管标识。

使用以下命令创建所需的 Azure 资源:

  1. 如有必要,请登录到 Azure:

    使用 az login 命令登录到 Azure 帐户。 如果你有多个订阅与帐户相关联,请使用 az account set。

  2. 运行以下命令,将 Azure CLI 更新到最新版本:

    az upgrade
    

    如果 Azure CLI 版本不是最新版本,则开始安装。 升级方式取决于操作系统。 升级完成后,可以继续。

  3. 运行以下命令以升级 Azure 容器应用扩展并注册容器应用所需的命名空间:

    az extension add --name containerapp --upgrade -y
    az provider register --namespace Microsoft.Web 
    az provider register --namespace Microsoft.App 
    az provider register --namespace Microsoft.OperationalInsights 
    
  4. 创建名为 AzureFunctionsContainers-rg 的资源组。

    az group create --name AzureFunctionsContainers-rg --location eastus
    

    此 az group create 命令在美国东部区域创建一个资源组。 如果想要使用附近的区域,请使用从 az account list-locations 命令返回的可用区域代码。 必须将后续命令修改为使用自定义区域而不是 eastus。

  5. 创建 Azure 容器应用环境。

    az containerapp env create --name MyContainerappEnvironment --resource-group AzureFunctionsContainers-rg --location eastus
    

    此命令可能需要花费几分钟时间完成。

  6. 在资源组和区域中创建常规用途存储帐户,而无需共享密钥访问。 在命令中,将 <STORAGE-NAME> 替换为适合你且在 Azure 存储中唯一的名称。 存储名称只能包含 3 到 24 个数字和小写字母字符。

    az storage account create --name <STORAGE-NAME> --location eastus --resource-group AzureFunctionsContainers-rg --sku Standard_LRS --allow-blob-public-access false --allow-shared-key-access false
    

    该 az storage account create 命令创建一个仅可通过使用Microsoft Entra 身份验证的标识访问的存储帐户,这些标识授予了对特定资源的权限。

    Standard_LRS 指定 Functions 支持的常规用途帐户。

  7. 创建一个托管标识,并使用返回的 principalId 为其授予对存储帐户的访问权限以及在注册表实例中的拉取权限。 将 <REGISTRY-NAME>、<USER-IDENTITY-NAME> 和 <STORAGE-NAME> 分别替换为现有容器注册表的名称、托管标识名称和存储帐户名称。

    principalId=$(az identity create --name <USER-IDENTITY-NAME> --resource-group AzureFunctionsContainers-rg --location eastus --query principalId -o tsv) 
    acrId=$(az acr show --name <REGISTRY-NAME> --query id --output tsv)
    az role assignment create --assignee-object-id $principalId --assignee-principal-type ServicePrincipal --role acrpull --scope $acrId
    storageId=$(az storage account show --resource-group AzureFunctionsContainers-rg --name <STORAGE-NAME> --query 'id' -o tsv)
    az role assignment create --assignee-object-id $principalId --assignee-principal-type ServicePrincipal --role "Storage Blob Data Owner" --scope $storageId
    

    az identity create 命令创建用户自己分配的托管标识,而 az role assignment create 命令会将你的标识添加到所需的角色中。

    托管标识现在可供应用使用,无需使用共享机密即可访问存储帐户和 Azure 容器注册表。

使用映像在 Azure 上创建并配置函数应用

Azure 上的函数应用将管理函数在 Azure 容器应用环境中的执行。 在本部分,你将使用上一部分所述的 Azure 资源,基于容器应用环境中容器注册表内的某个映像创建一个函数应用。 还可以使用所需 Azure 存储帐户的连接字符串配置新环境。

使用 az containerapp create --kind=functionapp 命令在 Azure 容器应用支持的新托管环境中创建函数应用。 在 az containerapp create --kind-functionapp 中,参数 --environment 指定容器应用环境。

小窍门

为确保你的函数应用使用基于托管标识的连接访问注册表实例,请不要在 --image 中设置 az containerapp create --kind=functionapp 参数。 在存储库中为 --image 设置映像的完全限定名称时,系统将从注册表获取共享密钥凭据,并存储在应用设置中。

首先,你必须获取对注册表具有拉取访问权限的用户分配托管标识的完全限定 ID 值,然后使用 az containerapp create --kind=functionapp 命令创建使用默认映像并分配此标识的函数应用。

UAMI_RESOURCE_ID=$(az identity show --name $uami_name --resource-group $group --query id -o tsv)

az containerapp create --name <APP-NAME> --storage-account <STORAGE-NAME> --environment MyContainerappEnvironment --workload-profile-name "Consumption" --resource-group AzureFunctionsContainers-rg --functions-version 4 --assign-identity $UAMI_RESOURCE_ID

在 az containerapp create --kind=functionapp 中,将 --assign-identity 托管标识分配给新应用。 由于未在 --image 中设置 az functionapp create 参数,因此系统将使用占位符映像创建应用程序。

在此示例中,将 <APP-NAME> 替换为新函数应用的名称,并将 <STORAGE-NAME> 替换为存储帐户的名称。

最后,你必须将 linuxFxVersion 站点设置更新为存储库中映像的完全限定名称。 还必须更新acrUseManagedIdentityCreds 和 acrUserManagedIdentityID 的站点设置,以便在从注册表获取映像时启用托管标识。

UAMI_RESOURCE_ID=$(az identity show --name <USER-IDENTITY-NAME> --resource-group AzureFunctionsContainers-rg --query id -o tsv)
az resource patch --resource-group AzureFunctionsContainers-rg --name <APP-NAME> --resource-type "Microsoft.Web/sites" --properties "{ \"siteConfig\": { \"linuxFxVersion\": \"DOCKER|<REGISTRY-NAME>.azurecr.io/azurefunctionsimage:v1.0.0\", \"acrUseManagedIdentityCreds\": true, \"acrUserManagedIdentityID\":\"$UAMI_RESOURCE_ID\", \"appSettings\": [{\"name\": \"DOCKER_REGISTRY_SERVER_URL\", \"value\": \"<REGISTRY-NAME>.azurecr.io\"}]}}"

除了所需的站点设置,az resource patch 命令还会将 DOCKER_REGISTRY_SERVER_URL 应用设置更新为注册表服务器的 URL。

在此示例中,分别替换 <APP-NAME><REGISTRY-NAME>函数 <USER-IDENTITY-NAME> 应用、容器注册表和标识的名称。

指定 --workload-profile-name "Consumption" 会在一个使用默认 Consumption 工作负荷配置文件的环境中创建应用,其成本与在容器应用消耗计划中运行的成本相同。 首次创建函数应用时,它会从注册表中拉取初始映像。

更新应用程序设置

若要使 Functions 主机能够使用共享密钥连接到默认存储帐户,你必须将 AzureWebJobsStorage 连接字符串设置替换为使用用户分配的托管标识的等效设置,以连接到存储帐户。

  1. 删除现有的 AzureWebJobsStorage 连接字符串设置:

    az containerapp config appsettings delete --name <APP-NAME> --resource-group AzureFunctionsContainers-rg --setting-names AzureWebJobsStorage 
    

    该 az containerapp config appsettings delete 命令从应用中删除此设置。 将 <APP-NAME> 替换为你的函数应用的名称。

  2. 添加包含 AzureWebJobsStorage__ 前缀的等效设置,用于定义默认存储帐户的用户分配的托管标识连接:

    clientId=$(az identity show --name <USER-IDENTITY-NAME> --resource-group AzureFunctionsContainers-rg --query 'clientId' -o tsv)
    az containerapp config appsettings set --name <APP-NAME> --resource-group AzureFunctionsContainers-rg --settings AzureWebJobsStorage__accountName=<STORAGE-NAME> AzureWebJobsStorage__credential=managedidentity AzureWebJobsStorage__clientId=$clientId
    

    在此示例中,将<APP-NAME>、<USER-IDENTITY-NAME> 和 <STORAGE-NAME> 分别替换为函数应用名称、标识名称和存储帐户名称。

此时,你的函数正在容器应用环境中运行,其中已添加所需的应用程序设置。 如果需要,可以使用 Functions 的标准方式在函数应用中添加其他设置。 有关详细信息,请参阅使用应用程序设置。

小窍门

对函数代码进行后续更改时,需要重新生成容器,将映像重新发布到注册表,并使用新的映像版本更新函数应用。

在 Azure 上验证函数

将映像部署到 Azure 中的函数应用后,现在可以通过 HTTP 请求调用函数。 获取有关特定函数的详细信息:

    az containerapp function show \
    --resource-group AzureFunctionsContainers-rg \
    --name <APP-NAME> \
    --function-name HttpExample 

将 <APP-NAME> 替换为你的函数应用的名称。 使用刚刚获取的 URL 并追加查询字符串 HttpExample 来调用 ?name=Functions 函数终结点。

请求 URL 应如下所示:

https://myacafunctionapp.kindtree-796af82b.eastus.azurecontainerapps.io/api/httpexample?name=functions

https://myacafunctionapp.kindtree-796af82b.eastus.azurecontainerapps.io/api/httpexample

目前 Go 不支持此功能。

清理资源

若要继续借助在本文中创建的资源来使用 Azure Functions,可以保留所有这些资源。

此函数应用部署完成后,请删除 AzureFunctionsContainers-rg 资源组以清理该组中的所有资源:

az group delete --name AzureFunctionsContainers-rg

后续步骤