在 Azure Logic Apps 中建立工作流程輸入的跨環境參數

發行項
08/08/2024

適用於：Azure Logic Apps (使用量 + 標準)

在 Azure Logic Apps 中，您可以藉由定義參數來抽象化在整個開發、測試和生產環境的工作流程中可能會變更的值。使用參數而非環境特定變數時，您可以一開始更專注於設計工作流程，並在稍後插入您的環境特定變數。

本文介紹如何建立、使用和編輯多租用戶取用邏輯應用程式工作流程的參數，以及針對單一租用戶標準邏輯應用程式工作流程。您也將了解如何管理環境變數。

如需多租使用者和單一租使用者 Azure Logic Apps 的詳細資訊，請檢閱單一租使用者與 Azure Logic Apps 中的多租使用者。

必要條件

Azure 帳戶和訂用帳戶。如果您沒有訂用帳戶，請註冊一個免費的 Azure 帳戶。
取用或標準邏輯應用程式工作流程

如果您還沒有邏輯應用程式工作流程，請參閱使用 Azure 入口網站建立範例使用量邏輯應用程式工作流程或使用 Azure 入口網站建立您的範例標準邏輯應用程式工作流程。

注意

目前，您只能使用 Azure 入口網站來建立取用邏輯應用程式工作流程的參數。您只能使用 Azure 入口網站或 Visual Studio Code，來建立標準邏輯應用程式工作流程的參數。

取用與標準邏輯應用程式工作流程的參數

針對取用和標準邏輯應用程式工作流程，您可以使用設計工具定義參數。定義參數之後，您可以從相同邏輯應用程式資源中的任何工作流程或連線參考該參數。

在多租用戶取用邏輯應用程式工作流程中，在設計工具中建立和使用參數之後，您會在 Azure Resource Manager 範本（ARM 範本）和範本參數檔案中定義及設定環境變數。在此案例中，您必須在部署時定義和設定參數，這表示即使您只需要變更一個變數，您仍必須重新部署邏輯應用程式的 ARM 範本。

在單一租用戶標準邏輯應用程式工作流程中，您可以使用參數和應用程式設定，在執行階段和部署中使用環境變數。應用程式設定包含相同邏輯應用程式資源中所有工作流程的全域設定選項。如需詳細資訊，請參閱編輯單一租用戶型邏輯應用程式的主機和應用程式設定。

重要

當您有敏感性資訊時，例如包含使用者名稱和密碼的連接字串，請務必使用可取得的最安全驗證流程。例如，在標準邏輯應用程式工作流程中，不支援安全資料類型，例如 securestring 和 secureobject。 Microsoft 建議您盡可能使用受控識別驗證 Azure 資源的存取權，並指派具有最低必要權限的角色。

如果無法使用這項功能，請務必透過其他方法 (例如可與應用程式設定搭配使用的 Azure Key Vault) 來保護連接字串。然後您可以直接參考安全字串，例如連接字串和金鑰。類似於您可以於部署期間定義環境變數的 ARM 範本，您可以在邏輯應用程式工作流程定義中定義應用程式設定。然後，您可以擷取動態產生的基礎結構值，例如連線端點、儲存體字串等等。如需詳細資訊，請參閱 Microsoft 身分識別平台的應用程式類型。

不過，應用程式設定有大小限制，而且無法從 Azure Logic Apps 中的特定區域參考。參數提供比應用程式設定更廣泛的使用案例，例如支援大型值大小和複雜物件。

例如，如果您使用 Visual Studio Code 作為本機開發工具在本機執行工作流程，請在邏輯應用程式專案中，使用 parameters.json 檔案來定義參數。然後，您可以從專案 workflow.json 檔案中的任何工作流程，或從您專案 connections.json 檔案中的任何連線物件來參考此參數檔案中的任何參數。下列清單描述幾個常見的使用案例：

擁有測試參數檔案，其中包含您在測試期間使用的所有值。部署時，您可以以您的生產參數檔案來取代測試參數檔案。
將 connections.json 檔案的不同部分參數化。接著，您可以將 connections.json 檔案簽入原始檔控制，然後透過 parameters.json 檔案管理任何連線。
將複雜物件 (例如 authentication JSON 物件)參數化。例如，您可以將 authentication 物件值取代為保存單一參數運算式的字串，例如 @parameters('api-auth')。
檢閱和編輯您專案的 local.settings.json 檔案中的應用程式設定。然後，您可以在參數中參考這些應用程式設定。

注意

作為一般建議，請考量使用參數作為將值參數化的預設方式，而不是應用程式設定。如此一來，當您需要儲存安全金鑰或字串時，您可以遵循建議透過參數參考應用程式設定。如有需要，您可以使用參數來參考應用程式設定，在解決方案中同時使用這兩個選項。

Azure 入口網站

在 Azure 入口網站中，開啟您的邏輯應用程式工作流程。在 [工作流程] 下，於設計工具中選取並開啟您的工作流程。
從設計工具的工具列，選取 [參數]。
在 [參數] 窗格上，選取 [新增參數]。

提供關於要建立的參數的下列資訊：

屬性	必要	描述
名稱	Yes	要建立的參數名稱。
類型	Yes	參數的資料類型，例如 Array、Bool、Float、Int、Object、Secure Object、Secure String 和 String。
預設值	Yes	參數的預設值。您必須指定預設參數值，因為工作流程邏輯、連接資訊和參數值不存在於單一位置。設計工具必須先能夠解析參數值，才能載入。重要事項：針對 Secure Object 和 Secure String 資料類型，請避免設定預設值，因為該值會儲存為純文字。
實際值	No	參數的實際值。

下列範例顯示字串參數的定義：

此螢幕擷取畫面呈現 Azure 入口網站、取用工作流程設計工具，以及具有參數定義範例的 [參數] 窗格。

如果您有更多要新增的參數，請選取 [新增參數]。否則，請關閉參數窗格，但請務必儲存工作流程以儲存您的新參數定義。
若要從相同工作流程中的觸發或動作參考參數，請遵循下列步驟：
1. 在設計工具中，開啟您想要的工作流程，然後展開觸發或動作。
2. 在您想要使用該參數的屬性中，於該屬性的編輯方塊內按一下。
3. 從開啟的動態內容清單中，於 [參數] 底下選取您先前建立的參數，例如：
若要在邏輯應用程式工作流程中檢視或編輯參數，請遵循下列步驟：
1. 在設計工具中開啟邏輯應用程式工作流程。在設計工具的工具列上，選取 [參數]。
  
  [參數] 窗格會隨即開啟，並顯示您為該工作流程定義的所有參數。
2. 進行編輯、關閉參數窗格，並儲存您的邏輯應用程式工作流程。

Azure 入口網站

在 Azure 入口網站中，開啟您的邏輯應用程式資源。在 [工作流程] 下，於設計工具中開啟您的工作流程。
從設計工具的工具列，選取 [參數]。
在 [參數] 窗格上，選取 [建立參數]。

提供關於要建立的參數的下列資訊：

屬性	必要	描述
名稱	Yes	要建立的參數名稱。
類型	Yes	參數的資料類型，例如 Array、Bool、Float、Int、Object 和 String。注意：在標準邏輯應用程式工作流程中，不支援安全資料類型，例如 `securestring` 和 `secureobject`。
值	Yes	參數的值。在標準邏輯應用程式工作流程中，您必須指定參數值，因為工作流程邏輯、連接資訊和參數值不存在於單一位置。設計工具必須先能夠解析參數值，才能載入。

下列範例顯示字串參數的定義：

此螢幕擷取畫面呈現 Azure 入口網站、標準工作流程的設計工具，以及參數定義範例的 [參數] 窗格。

完成時，請關閉 [參數] 窗格，但請務必儲存工作流程以儲存您的新參數定義。
若要從相同邏輯應用程式內任何工作流程中的觸發或動作參考參數，請遵循下列步驟：
1. 在設計工具中，開啟您想要的工作流程，然後展開觸發或動作。
2. 在您想要使用該參數的屬性中，於該屬性的編輯方塊內按一下。
3. 從開啟的動態內容清單中，於 [參數] 底下選取您先前建立的參數，例如：
若要在相同的邏輯應用程式中檢視或編輯參數，請遵循任一步驟：
- 在該邏輯應用程式中開啟任何工作流程。在工作流程功能表上，選取 [設計工具]。在設計工具的工具列上，選取 [參數]。
  
  [參數] 窗格會隨即開啟，並顯示您在該邏輯應用程式中從工作流程定義的所有參數。
- 若要以大量 JSON 檢視或編輯，請在邏輯應用程式的主功能表上，選取 [參數]。
  
  [參數] JSON 檢視窗格會隨即開啟，並顯示您在該邏輯應用程式中從工作流程定義的所有參數。

Visual Studio Code

在名為 parameters.json 的專案根層級 JSON 檔案中，定義所有參數及其值。此檔案具有物件，其包含機碼值組。每個機碼是每個參數的名稱，而每個值都是每個參數的結構。每個結構都必須同時包含 type 和 value 宣告。

重要

您的 parameters.json 檔案必須定義並包含您參考或在專案中其他位置 (例如工作流程定義或連線) 中使用的所有參數及其值。

下列範例顯示基本參數檔案：
```
{
    "responseString": { 
        "type": "string", 
        "value": "hello" 
    },
    "functionAuth": { 
        "type": "object", 
        "value": { 
            "type": "QueryString", 
            "name": "Code", 
            "value": "@appsetting('<AzureFunctionsOperation-FunctionAppKey>')" 
        }
    }
 }
```
注意

在 parameters.json 檔案中，@appsetting 是唯一有效的運算式類型。
若要參考觸發或動作輸入中的參數，請使用運算式 @parameters('<parameter-name>')。

參數化連線檔案

若要將 connections.json 檔案參數化，請將常值的值 ConnectionRuntimeUrl 以單一 parameters() 運算式取代，例如 @parameters('api-runtimeUrl')。在 connections.json 檔案中，唯一有效的運算式類型是 @parameters 和 @appsetting。

重要

如果您在開發期間將 connections.json 檔案參數化，設計工具體驗會在本機和Azure 入口網站中受到限制。如果您需要使用設計工具進行開發，請改用非參數化的 connections.json 檔案。然後，在您的部署管線中，將其取代為參數化檔案。執行階段仍可搭配參數化使用。設計工具改進功能開發中。

下列範例示範使用應用程式設定和參數的參數化 connections.json 檔案。雖然您想要盡可能使用參數，但此案例是您相較於參數更偏好使用應用程式設定的例外狀況或邊緣案例，因為應用程式設定是在部署期間產生，而且更容易在開發管線中動態填入。此範例檔案會對複雜 blob_auth 驗證物件使用參數，以及對其他值使用應用程式設定。在此情況下，您可以對驗證物件使用參數，因為您不太可能在工作流程中參考參數：

{
   "serviceProviderConnections": {
      "serviceBus": {
         "parameterValues": {
            "connectionString": "@appsetting('serviceBus_connectionString')"
        },
        "serviceProvider": {
           "id": "/serviceProviders/serviceBus"
        },
        "displayName": "servicebus"
     }
   },
   "managedApiConnections": {
      "azureblob": {
         "api": {
            "id": "/subscriptions/@{appsetting('WORKFLOWS_SUBSCRIPTION_ID')}/providers/Microsoft.Web/locations/@{appsetting('WORKFLOWS_LOCATION_NAME')}/managedApis/azureblob"
         },
         "connection": {
            "id": "/subscriptions/@{appsetting('WORKFLOWS_SUBSCRIPTION_ID')}/resourceGroups/@{appsetting('WORKFLOWS_RESOURCE_GROUP_NAME')}/providers/Microsoft.Web/connections/azureblob"
         },
         "connectionRuntimeUrl": "@appsetting('BLOB_CONNECTION_RUNTIMEURL')",
         "authentication": "@parameters('blob_auth')"
      }
   }
}

注意

當您有使用純文字內嵌的運算式，請務必針對該運算式使用內插格式，以大括弧 ({}) 括住該運算式的插補格式。此格式有助於避免剖析問題。

例如，如果您有 "<text>/@<function-name>('<parameter-name>')/<text>"，請改用下列版本："<text>/@{<function-name>('<parameter-name>')}/<text>"。

如需詳細資訊，請檢閱使用函式的考量。

管理參數檔案

一般而言，您需要管理多個版本的參數檔案。您可能會有用於不同部署環境，例如開發、測試和生產環境的目標值。管理這些參數檔案的運作方式往往類似管理 ARM 範本參數檔案。部署至特定環境時，通常會透過 DevOps 的管線升級對應的參數檔案。

若要使用 Azure CLI 動態取代參數檔案，請執行下列命令：

az functionapp deploy --resource-group MyResourceGroup --name MyLogicApp --src-path C:\parameters.json --type static --target-path parameters.json

如果您有以 NuGet 為基礎的邏輯應用程式專案，則必須更新專案檔案 (<logic-app-name>.csproj)，以在建置輸出中包含參數檔案，例如：

<ItemGroup>
  <None Update="parameters.json">
    <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
  </None>
</ItemGroup>

注意

目前，Azure 入口網站或工作流程設計工具尚未提供動態取代參數檔案的功能。

如需針對 DevOps 部署設定邏輯應用程式的詳細資訊，請檢閱下列文件：

管理應用程式設定

在單一租用戶 Azure Logic Apps 中，應用程式設定包含相同邏輯應用程式中所有工作流程的全域設定選項。當您在本機 Visual Studio Code 中執行工作流程時，可以在 local.settings.json 檔案中以本機環境變數的形式存取這些應用程式設定。然後，您可以在參數中參考這些應用程式設定。

若要新增、更新或刪除應用程式設定，請選取並檢閱適用於 Visual Studio Code、Azure 入口網站、Azure CLI 或 ARM (Bicep) 範本的下列各節。

Azure 入口網站

若要在 Azure 入口網站中檢閱邏輯應用程式資源的應用程式設定，請遵循下列步驟：

在 Azure 入口網站中，開啟您的邏輯應用程式資源。
在邏輯應用程式功能表上，於 [設定] 底下選取 [設定]。
在 [設定] 頁面的 [應用程式設定] 索引標籤上，檢閱邏輯應用程式的應用程式設定。
若要檢視所有值，請選取 [顯示值]。或者，若要檢視單一值，請選取該值。

若要新增設定，請遵循下列步驟：

在 [應用程式設定] 索引標籤的 [應用程式設定] 底下，選取 [新增應用程式設定]。
針對 [名稱]，輸入新設定的機碼或名稱。
針對 [值]，輸入新設定的值。
準備好建立新的機碼值組時，請選取 [確定]。
完成時，請在 [設定] 工具列上，選取 [儲存]。

Azure CLI

若要使用 Azure CLI 檢閱您目前的應用程式設定，請執行命令 az logicapp config appsettings list。確定您的命令包含 --name -n 和 --resource-group -g 參數，例如：

az logicapp config appsettings list --name MyLogicApp --resource-group MyResourceGroup

若要使用 Azure CLI 新增或更新應用程式設定，請執行命令 az logicapp config appsettings set。確定您的命令包含 --name n 和 --resource-group -g 參數。例如，下列命令會使用機碼名稱 CUSTOM_LOGIC_APP_SETTING 且值 12345 來建立設定：

az logicapp config appsettings set --name MyLogicApp --resource-group MyResourceGroup --settings CUSTOM_LOGIC_APP_SETTING=12345

Resource Manager 或 Bicep 範本

若要在 ARM 範本或 Bicep 範本中檢閱並定義應用程式設定，請尋找邏輯應用程式的資源定義，並更新 appSettings JSON 物件。如需完整的資源定義，請參閱 ARM 範本參考。

此範例顯示 ARM 範本或 Bicep 範本的檔案設定：

"appSettings": [
    {
        "name": "string",
        "value": "string"
    },
    {
        "name": "string",
        "value": "string"
    },
    <...>
],

Azure Logic Apps 中的單一租使用者與多租使用者

共用方式為

在 Azure Logic Apps 中建立工作流程輸入的跨環境參數

必要條件

取用與標準邏輯應用程式工作流程的參數

定義、使用和編輯參數

Azure 入口網站

Azure 入口網站

Visual Studio Code

參數化連線檔案

管理參數檔案

管理應用程式設定

Azure 入口網站

Azure CLI

Resource Manager 或 Bicep 範本

意見反應

其他資源

共用方式為

在 Azure Logic Apps 中建立工作流程輸入的跨環境參數

必要條件

取用與標準邏輯應用程式工作流程的參數

定義、使用和編輯參數

Azure 入口網站

相關內容

意見反應

其他資源