AzureFunctionApp@2 - Azure Functions 部署 v2 工作

使用 .NET、Python、JavaScript、PowerShell、Java 型 Web 應用程式更新函式應用程式。

Syntax

# Azure Functions Deploy v2
# Update a function app with .NET, Python, JavaScript, PowerShell, Java based web applications.
- task: AzureFunctionApp@2
  inputs:
    connectedServiceNameARM: # string. Alias: azureSubscription. Required. Azure Resource Manager connection. 
    appType: # 'functionApp' | 'functionAppLinux'. Required. App type. 
    appName: # string. Required. Azure Functions App name. 
    #deployToSlotOrASE: false # boolean. Optional. Use when appType != "". Deploy to Slot or App Service Environment. Default: false.
    #resourceGroupName: # string. Required when deployToSlotOrASE = true. Resource group. 
    #slotName: 'production' # string. Required when deployToSlotOrASE = true. Slot. Default: production.
    package: '$(System.DefaultWorkingDirectory)/**/*.zip' # string. Required. Package or folder. Default: $(System.DefaultWorkingDirectory)/**/*.zip.
    #runtimeStack: # 'DOTNET|6.0' | 'DOTNET-ISOLATED|6.0' | 'DOTNET-ISOLATED|7.0' | 'DOTNET-ISOLATED|8.0' | 'JAVA|8' | 'JAVA|11' | 'JAVA|17' | 'JAVA|21' | 'NODE|14' | 'NODE|16' | 'NODE|18' | 'NODE|20' | 'PYTHON|3.8' | 'PYTHON|3.9' | 'PYTHON|3.10' | 'PYTHON|3.11'. Optional. Use when appType = functionAppLinux. Runtime stack. 
  # Application and Configuration Settings
    #appSettings: # string. App settings. 
  # Additional Deployment Options
    #deploymentMethod: 'auto' # 'auto' | 'zipDeploy' | 'runFromPackage'. Required when appType != "" && package NotEndsWith .war && Package NotEndsWith .jar. Deployment method. Default: auto.

輸入

connectedServiceNameARM - Azure Resource Manager 連線
輸入別名： azureSubscription。 string. 必要。

選取部署的 Azure Resource Manager 訂用帳戶。

appType - 應用程式類型
string. 必要。 允許的值： functionApp (Windows) 上的函式應用程式， functionAppLinux (Linux 上的函式應用程式) 。

選取部署的 Azure 函式應用程式類型。

appName - Azure Functions 應用程式名稱
string. 必要。

指定現有 Azure Functions 應用程式的名稱。 列出的函式應用程式將會根據選取的應用程式類型。

deployToSlotOrASE - 部署至位置或 App Service 環境
boolean. 選擇性。 使用 時 appType != ""。 預設值：false。

部署至現有的部署位置或 Azure App 服務 環境。 針對這兩個目標，工作需要資源組名。

如果部署目標是位置，則會預設為 生產 位置。 您也可以提供任何其他現有的位置名稱。

如果部署目標是 Azure App 服務 環境，請將位置名稱保留為生產環境，並指定資源組名。

resourceGroupName - 資源群組
string. 當 deployToSlotOrASE = true 時為必要。

當部署目標為部署位置或 App Service 環境 時，需要資源組名。

輸入或選取包含上面指定之 Azure App 服務的 Azure 資源群組。

slotName - 槽
string. 當 deployToSlotOrASE = true 時為必要。 預設值：production。

輸入或選取現有的位置，不包括生產位置。

package - 封裝或資料夾
string. 必要。 預設值：$(System.DefaultWorkingDirectory)/**/*.zip。

封裝或資料夾的檔案路徑，其中包含 MSBuild 或壓縮 zip 檔案所產生的 App Service 內容。 支援 ( 組建 | 發行) 和通配符的變數。 例如： $(System.DefaultWorkingDirectory)/**/*.zip 。

runtimeStack - 運行時間堆疊
string. 選擇性。 使用 時 appType = functionAppLinux。 允許的值：DOTNET|6.0、DOTNET-ISOLATED|6.0、 PYTHON|3.10NODE|20DOTNET-ISOLATED|8.0JAVA|21JAVA|11DOTNET-ISOLATED|7.0JAVA|8JAVA|17NODE|16PYTHON|3.8NODE|14PYTHON|3.11PYTHON|3.9NODE|18。

指定函式應用程式將執行的架構和版本。 您可以使用任何 支援的執行時間版本。 之類的 DOCKER|microsoft/azure-functions-* 舊值已被取代。 新值會列在工作 助理 的下拉式清單中。 如果 支援的運行時間版本中 有較新版本的架構，即使它不在清單中，您也可以指定它。

appSettings - 應用程式設定
string.

使用語法 -key value 輸入應用程式設定 (，例如： -Port 5000-RequestTimeout 5000-WEBSITE_TIME_ZONE) 。 以雙引弧括住包含空格的值 (，例如： "Eastern Standard Time") 。

deploymentMethod - 部署方法
string. 當 appType != "" && package NotEndsWith .war && Package NotEndsWith .jar 時為必要。 允許的值： auto (自動偵測) 、 zipDeploy (Zip Deploy) ， runFromPackage (Zip Deploy with Run From Package) 。 預設值：auto。

指定應用程式的 部署方法 。 Linux 取用應用程式不支援此設定。

工作控制選項

除了工作輸入之外，所有工作都有控制選項。 如需詳細資訊，請參閱 控制選項和一般工作屬性。

輸出變數

此工作會定義下列 輸出變數，您可以在下游步驟、作業和階段中使用。

AppServiceApplicationUrl
所選 Azure 函式應用程式的應用程式 URL。

備註

Azure 函式部署工作可用來更新 Azure Functions，以將 Functions 部署至 Azure。 工作適用於跨平臺執行 Windows、Linux 或 Mac 的 Azure Pipelines 代理程式，並使用 RunFromPackage、Zip Deploy 和 Kudu REST API 的基礎部署技術。

工作適用於支持的語言 Azure Functions。

工作的必要條件

下列必要條件必須在目標計算機中設定， (s) ，工作才能正常運作。

Azure Function

工作是用來將 Azure Functions 專案部署到現有的 Azure 函式。 執行工作之前，應該先存在 Azure 函式應用程式。 您可以從 Azure 入口網站 建立 Azure 函式應用程式。 或者，Azure PowerShell 工作可用來執行 AzureRM PowerShell 腳本來布建和設定 Azure 函式應用程式。

工作可用來部署 windows/Linux) (Azure Functions。

Azure 訂用帳戶

若要部署至 Azure，Azure 訂用帳戶必須使用 [帳戶管理] 區段中的 [服務] 索引卷標連結至 Azure Pipelines。 在 [建置或 Release Management 定義] 中新增 Azure 訂用帳戶，方法是開啟 [帳戶管理] 畫面 (畫面右上方的齒輪圖示，) 然後按兩下 [服務] 索引標籤。

Create ARM 服務端點，並使用 Azure Resource Manager 端點類型。 如需詳細資訊，請遵循 此處連結中列出的步驟。

工作無法與 Azure 傳統服務端點搭配使用，也不會在工作中的參數中列出這些連線。

部署方法

此工作提供數種部署方法。

若要變更設計工具工作中以封裝為基礎的部署選項，請展開 [其他部署選項 ]，然後啟用 [選取部署方法]。

根據 Azure App 服務 和 Azure Pipelines 代理程式的類型，工作會使用適當的部署技術。 工作所使用的部署技術如下所示：

• Kudu REST API
• ZIP 部署
• 從套件執行

根據預設，工作會根據輸入套件、App Service 類型和代理程式OS來嘗試選取適當的部署技術。

• 如果提供部署後腳本，請使用 Zip Deploy。
• 如果 App Service 類型是 Linux 上的 Web 應用程式，請使用 Zip Deploy。
• 如果提供 .war 檔案，請使用 War Deploy。
• 如果提供.jar檔案，請使用 Run-From-Zip。
• 針對所有其他工作，請使用透過 Zip Deploy) 執行 From Package (。

在任何 App Service 類型) 的非 Windows 代理程式 (上，工作依賴 Kudu REST API 來部署 Web 應用程式。

Kudu REST API

當目標為 Windows 上的 Web 應用程式、Linux 上的 Web 應用程式 (內建來源) 或函式應用程式時， Kudu REST API 可在 Windows 和 Linux 自動化代理程式上運作。 工作會使用 Kudu 將檔案複製到 Azure App 服務。

Zip 部署

Zip Deploy 會從所選的套件或資料夾建立 .zip 部署套件。 然後，它會將檔案內容部署到 Azure 中 App Service 名稱函式應用程式的 wwwroot 資料夾。 此選項會覆寫 wwwroot 資料夾中的所有現有內容。 如需詳細資訊，請參閱適用於 Azure Functions 的 Zip 部署。

從套件執行

[從封裝執行] 會建立與 Zip Deploy 相同的部署套件。 Functions 運行時間不會將檔案部署到 wwwroot 資料夾，而是掛接整個套件。 當您使用此選項時，wwwroot 資料夾中的檔案會變成唯讀的。 如需詳細資訊，請參閱從套件檔案執行 Azure Functions。

疑難排解

錯誤：無法擷取 Azure 的存取權杖。 確認使用的服務主體是否有效且未過期。

工作會使用服務連線中的服務主體向 Azure 進行驗證。 如果服務主體已過期或沒有 App Service 的許可權，工作就會失敗，並出現此錯誤。 請確認使用的服務主體是否有效，以及是否存在於應用程式註冊中。 如需詳細資訊，請參閱使用角色型存取控制來管理 Azure 訂用帳戶資源的存取。 此部落格文章 也包含使用服務主體驗證的詳細資訊。

SSL 錯誤

如果您想要在 App Service 中使用憑證，則必須由受信任的證書頒發機構單位簽署憑證。 如果您的 web 應用程式出現憑證驗證錯誤，您可能使用了自我簽署憑證。 將名為 VSTS_ARM_REST_IGNORE_SSL_ERRORS 的變數設定為組建或發行管線中的值 true ，以解決錯誤。

發行長時間停止回應，然後失敗

此問題可能是 App Service 方案中容量不足的結果。 若要解決此問題，您可以相應增加 App Service 實例，以提高可用的CPU、RAM和磁碟空間，或嘗試使用不同的App Service方案。

5xx 錯誤碼

如果您看到 5xx 錯誤， 請檢查 Azure 服務的狀態。

Azure 函式突然停止運作

如果自上次部署以來超過一年，Azure Functions 可能會突然停止運作。 如果您在 「deploymentMethod」 中使用 「RunFromPackage」 進行部署，會產生到期日為 1 年的 SAS，並在應用程式組態中設定為 「WEBSITE_RUN_FROM_PACKAGE」。 Azure Functions 使用此 SAS 來參考套件檔案來執行函式，因此如果 SAS 已過期，將不會執行函式。 若要解決此問題，請再次部署，以產生到期日為一年的SAS。

錯誤：找不到具指定模式的套件

請確認工作中所提及的套件已在組建或上一個階段中發行為成品，並已在目前的作業中下載。

錯誤：msBuild 套件類型不支援使用 zip 部署發佈選項

透過 MSBuild 工作所建立的 Web 套件 (具有預設自變數) 具有巢狀資料夾結構，只能由 Web Deploy 正確部署。 發佈至 zip 部署選項無法用來部署這些套件。 若要轉換封裝結構，請執行下列步驟：

1. 在建置方案工作中，將 MSBuild 自變數 變更為 /p:DeployOnBuild=true /p:DeployDefaultTarget=WebPublish /p:WebPublishMethod=FileSystem /p:DeleteExistingFiles=True /p:publishUrl="$(System.DefaultWorkingDirectory)\\WebAppContent"：

   

2. 新增封存工作並變更值，如下所示：

   1. 將根資料夾或檔案變更為封存。$(System.DefaultWorkingDirectory)\\WebAppContent

   2. 清除 [封 存路徑前的根資料夾名稱 ] 複選框：

      

Windows 上的函式應用程式部署成功，但應用程式無法運作

如果應用程式中沒有 web.config 檔案，就會發生此問題。 您可以將 web.config 檔案新增至來源，或使用工作的 [應用程式和組態設定 ] 自動產生檔案。

1. 選取工作，然後移至 為 Python、Node.js、Go 和 Java 應用程式產生 web.config 參數：

   

2. 選取 [為 Python 產生 web.config 參数]、[Node.js]、[Go] 和 [Java 應用程式 ] 底下的 [更多] 按鈕 (...) ，以編輯參數：

   

3. 在 [應用程式架構 ] 列表中選取您的應用程式類型。

4. 選取 [確定]。 這麼做會填入產生 web.config 檔案所需的 web.config 參數。

常見問題集

如何設定服務連線？

這項工作需要 Azure Resource Manager 服務連線。

如何使用 Application Insights 設定 Web 作業部署？

當您部署至 App Service 時，如果您已設定 Application Insights 且已啟用 Remove additional files at destination，則也需要啟用 Exclude files from the App_Data folder。 啟用此選項可讓 Application Insights 延伸模組保持安全狀態。 此步驟是必要的，因為 Application Insights 連續 WebJob 會安裝到 App_Data 資料夾中。

當我部署至 App Service 時，應該如何設定代理程式位於 Proxy 後方？

如果您的自我裝載代理程式需要 Web Proxy，您可以在設定期間通知代理程式有關 Proxy。 這樣做可讓您的代理程式透過 Proxy 連線到 Azure Pipelines 或 Azure DevOps Server。 深入瞭解在 Web Proxy 後方執行自我裝載代理程式。

我無法使用 Azure Resource Manager 服務連線和 Microsoft 裝載的代理程式，部署至內部 App Service 環境

根據設計，Microsoft 裝載的代理程式將無法與 App Service 環境 搭配使用。 相反地，您必須在與 App Service 環境 位於相同虛擬網路的虛擬機上設定私人代理程式。 此外，設定私人 DNS 區域以啟用資源之間的通訊。

範例

以下是在 Windows 上部署 Azure 函式的範例 YAML 代碼段：

variables:
  azureSubscription: Contoso
  # To ignore SSL error, uncomment the below variable
  # VSTS_ARM_REST_IGNORE_SSL_ERRORS: true

steps:
- task: AzureFunctionApp@2
  displayName: Azure Function App Deploy
  inputs:
    azureSubscription: $(azureSubscription)
    appName: samplefunctionapp
    appType: functionApp
    package: $(System.DefaultWorkingDirectory)/**/*.zip

若要在 Linux 上部署函式，請新增 appType 參數並將其設定為 appType: functionAppLinux。 如果您未指定值， functionApp 則為預設值。

若要將部署方法明確指定為 Zip Deploy，請新增 參數 deploymentMethod: zipDeploy。 這個參數的另一個支援值是 runFromPackage。 如果您未指定值， auto 則為預設值。

如需示範如何建立 CI/CD 管線的逐步解說，請參閱建置 Java 並將其部署至 Azure Functions。

規格需求

需求	描述
管線類型	YAML、傳統組建、傳統版本
執行於	Agent、DeploymentGroup
要求	無
Capabilities	此工作不符合作業中後續工作的任何需求。
命令限制	任何
Settable 變數	任何
代理程式版本	2.104.1 或更新版本
工作類別	部署