共用方式為

在 Visual Studio Code 中，對 Azure APIM 原則進行偵錯

  • 發行項

適用於：開發人員

Azure APIM 中的原則提供功能強大的功能，可協助 API 發行者解決跨領域考量，例如驗證、授權、節流、快取和轉換。 原則是陳述式的集合，會因 API 的要求或回應循序執行。

本文說明如何使用適用於 Visual Studio Code 的 Azure API 管理延伸模組對 API 管理原則進行偵錯。

必要條件

限制事項

  • 此功能使用內建的 (服務層級) 所有存取訂用帳戶 (顯示名稱 “Built-in all-access subscription”) 進行偵錯。

重要

  • API 管理 不再支持追蹤或 的訂用帳戶Ocp-Apim-Trace 標頭。
  • 若要改善 API 安全性，您現在可以在個別 API 層級啟用追蹤，方法是使用 API 管理 REST API 取得限時令牌，並將令牌傳遞至網關。 如需詳細資料，請參閱啟用 API 的追蹤 (部分機器翻譯)。
  • 啟用追蹤時請小心，因為敏感性資訊可能會在追蹤資料中公開。 請確定您已採用適當的安全性措施來保護追蹤資料。

起始偵錯工作階段

  1. 啟動 Visual Studio Code
  2. 瀏覽至 Azure 延伸模組下的 APIM 延伸模組
  3. 尋找要偵錯的 APIM 執行個體
  4. 尋找要偵錯的 API 與作業
  5. 以滑鼠右鍵按一下 [作業]，然後選取 [開始原則偵錯]

此時，延伸模組會嘗試使用 APIM 網路閘道起始並建立偵錯工作階段。

起始偵錯

傳送測試要求

當建立偵錯會話時，延伸模組會開啟新的編輯器，該編輯器可允許我們利用 REST 用戶端擴充功能，建立並傳送測試 HTTP 要求給此作業。

您會發現 Ocp-Apim-Debug 標頭已新增至要求中。 此標頭是必要的，且該數值必須設定為服務層級、所有存取的訂用帳戶金鑰，以觸發 APIM 網路閘道中的偵錯功能。

根據您的測試情節，修改編輯器中的 HTTP 要求。 然後按一下 [傳送要求]，將測試要求傳送至 APIM 網路閘道。

傳送測試要求

偵錯原則

傳送測試 HTTP 要求之後，延伸模組會開啟偵錯視窗，以顯示此作業的有效原則，並會在第一個有效原則停止。

偵錯原則

若要遵循原則準銷售案源，您可以透過個別原則執行單一步驟，或在原則上設定中斷點，並直接逐步執行該原則。

在 [變數] 面板中，您可以檢查系統建立和使用者建立變數的數值。 在 [中斷點] 面板中，您可以看到已設定的所有中斷點清單。 在 [呼叫堆疊] 面板中 ，您可以看到目前的有效原則範圍。

如果在原則執行期間有發生錯誤，您會在發生錯誤的原則中，看到該錯誤的詳細資料。

例外狀況

提示

當您完成時，請記得按一下 [停止] 按鈕，以結束偵錯工作流程。

下一步