在 Azure API 管理中匯入 Azure 函數應用程式作為 API

  • 發行項

適用於：所有 API 管理 層

Azure API 管理支援將 Azure 函數應用程式匯入為新的 API，或將它們附加至現有的 API。 此程序會在 Azure 函數應用程式中自動產生主機金鑰，而此金鑰接著會指派給 Azure API 管理中的具名值。

本文將逐步說明如何在 Azure API 管理中匯入及測試 Azure 函式應用程式作為 API。

您將了解如何：

  • 匯入 Azure 函式應用程式作為 API
  • 將 Azure 函式應用程式附加至 API
  • 檢視新的 Azure 函式應用程式主機金鑰與 Azure API 管理的具名值
  • 在 Azure 入口網站中測試 API

必要條件

注意

您可以使用適用於 Visual Studio Code 的 API 管理延伸模組來匯入和管理 API。 請遵循 API 管理延伸模組教學課程來安裝和開始使用。

移至您的 API 管理執行個體

  1. 在 Azure 入口網站中，搜尋並選取 [API 管理服務]。

    選取 API 管理 服務

  2. 在 [API 管理服務] 頁面中，選取您的 API 管理執行個體。

    選取您的 API 管理 實例

匯入 Azure 函式應用程式作為新的 API

請依照下列步驟從 Azure 函式應用程式建立新的 API。

  1. 在 Azure 入口網站中，瀏覽至您的 APIM 服務，然後從功能表中選取 [API]。

  2. 在 [新增 API] 清單中，選取 [函式應用程式]。

    顯示 [函式應用程式] 圖格的螢幕快照。

  3. 按一下 [瀏覽] 以選取要匯入的函式。

    醒目提示 [瀏覽] 按鈕的螢幕快照。

  4. 按一下 [函式應用程式] 區段，從可用的函式應用程式清單中選擇。

    醒目提示 [函式應用程式] 區段的螢幕快照。

  5. 找出您要從中匯入函式的函式應用程式並按一下，然後按 [選取]。

    醒目提示您要匯入函式的螢幕快照，以及 [選取] 按鈕。

  6. 選取您要匯入的函式，然後按一下 [選取]。

    • 您只能匯入基於 HTTP 觸程序且具有 [匿名] 或 [函式] 授權層級的 Functions。

    醒目提示要匯入的函式和 [選取] 按鈕的螢幕快照。

  7. 切換至 [完整] 檢視，然後將 [產品] 指派給您的新 API。

  8. 如有需要，請在建立期間指定其他欄位，或稍後透過 [設定] 索引標籤進行設定。

    注意

    產品是透過開發人員入口網站提供給開發人員的一或多個 API 關聯。 首先，開發人員必須訂閱產品，才能取得 API 的存取權。 訂閱後，開發人員就能取得適用於該產品中所有 API 的訂用帳戶金鑰。 身為 API 管理執行個體的建立者，您就是系統管理員，且會依預設訂閱每個產品。

    每個 API 管理執行個體會隨附兩個預設範例產品：

    • 入門
    • 無限制

  9. 按一下 [建立]。

將 Azure 函式應用程式附加至現有的 API

請依照下列步驟，將 Azure 函式應用程式附加至現有的 API。

  1. 在您的 Azure API 管理服務執行個體中，從左側的功能表中選取 [API]。

  2. 選擇要在其中匯入 Azure 函式應用程式的 API。 按一下 ...，然後從內容功能表中選取 [匯入]。

    醒目提示 [匯入] 功能表選項的螢幕快照。

  3. 按一下 [函式應用程式] 圖格。

    醒目提示 [函式應用程式] 圖格的螢幕快照。

  4. 在快顯視窗中，按一下 [瀏覽]。

    顯示 [瀏覽] 按鈕的螢幕快照。

  5. 按一下 [函式應用程式] 區段，從可用的函式應用程式清單中選擇。

    醒目提示函式應用程式的螢幕快照。

  6. 找出您要從中匯入函式的函式應用程式並按一下，然後按 [選取]。

    醒目提示您要匯入函式的螢幕快照。

  7. 選取您要匯入的函式，然後按一下 [選取]。

    醒目提示您想要匯入之函式的螢幕快照。

  8. 按一下 [匯入]。

    從函式應用程式附加

授權

匯入 Azure 函式應用程式後會自動產生：

  • 位於函式應用程式內、名為 apim-{您的 Azure API 管理服務執行個體名稱} 的主機金鑰、
  • 位於 Azure API 管理執行個體內、名稱為 {您的 Azure 函式應用程式執行個體名稱}-key 的具名值，其中包含建立的主機金鑰。

對於在 2019 年 4 月 4 日之後建立的 API，主機金鑰會從 API 管理隨著 HTTP 要求傳至標頭中的函式應用程式。 舊版的 API 會以查詢參數的形式傳遞主機金鑰。 您可透過與函式應用程式相關聯的後端實體上的 PATCH BackendREST API 呼叫來變更此行為。

警告

移除或變更 Azure 函式應用程式主機金鑰值或 Azure API 管理具名值，將會中斷服務之間的通訊。 這些值不會自動同步。

如果需要輪替主機金鑰，請確定 Azure API 管理中的具名值也須一併修改。

存取 Azure 函式應用程式主機金鑰

  1. 瀏覽至 Azure 函式應用程式執行個體。

    醒目提示選取函式應用程式實例的螢幕快照。

  2. 在側邊導覽功能表的 [函式] 區段中，選取 [應用程式金鑰]。

    醒目提示 [函式應用程式] 設定選項的螢幕快照。

  3. 在 [主機金鑰] 區段下尋找金鑰。

    醒目提示 [主機金鑰] 區段的螢幕快照。

存取 Azure API 管理中的具名值

瀏覽至您的 Azure API 管理執行個體，然後從左側的功能表中選取 [具名值]。 Azure 函式應用程式金鑰儲存於此處。

從函式應用程式新增

在 Azure 入口網站中測試新的 API

您可以直接從 Azure 入口網站呼叫作業。 使用 Azure 入口網站可方便您檢視和測試 API 的作業。

醒目提示測試程序的螢幕快照。

  1. 選取您在先前的小節中建立的 API。

  2. 選取 [測試] 索引標籤。

  3. 選取您要測試的作業。

    • 頁面會顯示查詢參數和標頭的欄位。
    • 其中一個標頭是 “Ocp-Apim-Subscription-Key”，其適用於與此 API 相關聯的產品訂用帳戶金鑰。
    • 身為 API 管理執行個體的建立者，您已經是系統管理員，因此會自動填入此金鑰。

  4. 請選取傳送。

    • 測試成功時，後端會回應 200 OK 與部分資料。

下一步

轉換及保護已發佈的 API