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

2025-05-20

適用於：所有 APIM 層

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

注意

目前，此功能無法在工作區中使用。

本文說明如何將 Azure 函式應用程式匯入為 API 至 Azure API 管理，並測試 API。

您將瞭解如何：

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

必要條件

完成建立 Azure APIM 執行個體快速入門。
請確定您的訂用帳戶中有 Azure 函式應用程式。如需詳細資訊，請參閱開始使用 Azure Functions。函式必須具有 HTTP 觸發程式。授權層級必須設定為匿名或函式。

注意

您也可以使用適用於 Visual Studio Code 的 API 管理延伸模組來匯入和管理 API。完成 API 管理延伸模組教學課程以開始使用。

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

若要從 Azure 函式應用程式建立新的 API：

在 Azure 入口網站中瀏覽至您的 API 管理服務。
選取左窗格中的API>API。
在 [從 Azure 資源建立] 下，選取 [ 函式應用程式]：

顯示 Azure 入口網站中 [Function App] 磚塊的螢幕快照。
選取 [瀏覽] 按鈕：
按一下選取按鈕，位於設定必要設定下方，然後從可用的函式應用程式清單中選擇。
尋找您要匯入函式的來源函式應用程式，加以選取，然後按兩下 [ 選取]：
選取您要匯入的函式，然後按兩下 [ 選取]。您只能匯入具有 HTTP 觸發程式和匿名或函式授權層級的函式。
切換至 [完整 ] 檢視，並將產品指派給新的 API。
注意

產品是透過開發人員入口網站提供給開發人員的一或多個API的關聯。首先，開發人員必須訂閱產品，才能取得 API 的存取權。當他們訂閱時，他們會取得產品中任何 API 的訂用帳戶密鑰。如果您已建立 API 管理實例，您是系統管理員，且預設會訂閱每個產品。

在某些定價層中，API 管理實例隨附兩個預設範例產品：
- 入門
- 無限制
視需要指定其他設定。您也可以稍後透過 [ 設定 ] 索引標籤來指定設定。這些設定會在匯入和發佈您的第一個 API 教學課程中說明。
選取 ，創建。

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

若要將函式應用程式附加至現有的 API：

在您的 Azure API 管理服務實例中，選擇左窗格中的API>API。
選擇您要匯入函式應用程式的 API。選取 API 旁邊的省略號（...），然後選取 [ 匯入]：
選取 [ 函式應用程式 ] 圖格：
在 [從函式應用程式匯入視窗] 中，選取 [瀏覽]：
按一下選取按鈕，位於設定必要設定下方，然後從可用的函式應用程式清單中選擇。
尋找您要匯入函式的來源函式應用程式，加以選取，然後按兩下 [ 選取]：
選取您要匯入的函式，然後按兩下 [ 選取]：
選取匯入：

授權

當您匯入 Azure 函式應用程式時，會自動產生這些項目：

功能應用程式中的主機金鑰。關鍵名稱是 apim-<your API Management service instance name>。
在 API 管理實例中名稱為 <your Azure function app instance name>-key 的一個具名值。此值包含主機金鑰。

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

警告

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

如果您需要輪替主機密鑰，請務必也變更 API 管理中的具名值。

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

瀏覽至您的 Azure 函式應用程式實例：
在左窗格的 [ 函式 ] 區段中，選取 [應用程式密鑰]：
在 [ 主機金鑰 ] 區段中尋找金鑰：

在 API 管理中存取具名值

流覽至您的 API 管理實例，然後在左窗格中選取 API>具名值。 Azure 函式應用程式金鑰會儲存在那裡。

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

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

選取您在先前的小節中建立的 API。
選取 [測試] 索引標籤。
選取您要測試的作業。
- 頁面會顯示查詢參數和標頭的欄位。
- 其中一個標頭是 Ocp-Apim-Subscription-Key。此標頭適用於與 API 相關聯的產品訂用帳戶金鑰。
- 如果您已建立 API 管理實例，您就是系統管理員，因此會自動填入密鑰。
請選取傳送。

測試成功時，後端會以 200 OK 和部分數據回應。

共用方式為