在 Azure API 管理中建立和管理工作區

  • 發行項

適用於：進階版

設定工作區，讓 API 小組能夠管理和將自己的 API 產品化，同時為 API 平台小組提供觀察、控管和維護 API 管理平台的工具。 建立工作區並指派權限之後，工作區共同作業者可以建立及管理自己的 API、產品、訂用帳戶和相關資源。

注意

  • API 管理 REST API 版本 2023-09-01-preview 或更新版本中支援最新的工作區功能。
  • 如需定價考量，請參閱 API 管理定價。

遵循此文章中的步驟，以便：

  • 使用 Azure 入口網站建立 API 管理工作區和工作區閘道
  • 選擇性地隔離 Azure 虛擬網路中的工作區閘道
  • 指派權限給工作區

注意

目前，建立工作區閘道是長時間執行的作業，最多可能需要 3 小時或更長時間才能完成。

必要條件

  • API 管理執行個體。 如果需要，請在支援的層中建立一個。
  • 部署 API 管理執行個體所在資源群組的擁有者或參與者角色，或在資源群組中建立資源的同等權限。
  • (選用) 現有或新的 Azure 虛擬網路和子網路，用來隔離工作區閘道的輸入和輸出流量。 如需設定選項和需求，請參閱工作區閘道的網路資源需求。

建立工作區 (入口網站)

  1. 登入 Azure 入口網站，然後瀏覽至您的 API 管理執行個體。

  2. 在左側功能表中的 [API] 下，選取 [工作區] > [+ 新增]。

  3. 在 [基本] 索引標籤上，輸入工作區的描述性 [顯示名稱]、資源 [名稱] 和選用的 [描述]。 選取 [下一步]。

  4. 在 [閘道] 索引標籤上，設定工作區閘道的設定：

    • 在 [閘道詳細資料] 中，輸入閘道名稱，然後選取縮放 [單位] 的數目。 閘道成本取決於您選取的單位數目。 如需詳細資訊，請參閱 API 管理價格。

    • 在 [網路] 中，選取工作區閘道的 [網路設定]。

      重要

      請仔細規劃工作區的網路設定。 建立工作區之後，您無法變更網路設定。

    • 如果您選取包含私人輸入或私人輸出網路存取的網路設定，請選取 [虛擬網路] 和 [子網路] 來隔離工作區閘道，或建立新的閘道。 如需網路需求，請參閱工作區閘道的網路資源需求。

  5. 選取 [下一步]。 驗證完成時，選取 [建立]。

建立工作區、工作區閘道和相關資源可能需要幾分鐘到數小時的時間。 若要追蹤 Azure 入口網站中的部署進度，請移至閘道的資源群組。 在左側功能表的 [設定] 下，選取 [部署]。

部署完成之後，新的工作區會出現在 [工作區] 頁面上的清單中。 請選取工作區以管理其設定和資源。

注意

  • 若要檢視閘道執行階段主機名稱和其他閘道詳細資料，請在入口網站中選取工作區。 在 [部署 + 基礎結構] 下，選取 [閘道]，然後選取工作區閘道的名稱。
  • 建立工作區閘道時，對工作區 API 的執行階段呼叫將不會成功。

將使用者指派給工作區 (入口網站)

建立工作區之後，請將權限指派給使用者以管理工作區的資源。 您必須為每個工作區使用者指派服務範圍的工作區 RBAC 角色和工作區範圍的 RBAC 角色，或使用自訂角色授與對等權限。

若要管理工作區閘道，我們也建議將 Azure 提供的 RBAC 角色指派給工作區閘道。

注意

為了更容易管理，請設定 Microsoft Entra 群組，將工作區權限指派給多個使用者。

指派服務範圍角色

  1. 登入 Azure 入口網站，然後瀏覽至您的 API 管理執行個體。

  2. 在左側功能表中，選取 [存取控制 (IAM)]>[+ 新增]。

  3. 將下列其中一個服務範圍角色指派給工作區的每個成員：

    • APIM 服務工作區 API 開發人員
    • APIM 服務工作區 API 產品管理員

指派工作區範圍角色

  1. 在 APIM 執行個體的功能表中，於 [API] 下選取 [工作區] > 您建立的工作區名稱。

  2. 在 [工作區] 視窗中，選取 [存取控制 (IAM)]>[+ 新增]。

  3. 將下列其中一個工作區範圍角色指派給工作區成員，使其可以管理工作區 API 和其他資源。

    • APIM 工作區讀者
    • APIM 工作區參與者
    • APIM 工作區 API 開發人員
    • APIM 工作區 API 產品管理員

指派閘道範圍角色

  1. 登入 Azure 入口網站，然後瀏覽至您的 API 管理執行個體。

  2. 在左側功能表中的 [API] 下，選取 [工作區] > 您工作區的名稱。

  3. 在工作區的左側功能表中，選取 [閘道]，然後選取工作區閘道。

  4. 在左側功能表中，選取 [存取控制 (IAM)]>[+ 新增]。

  5. 將下列其中一個角色指派給工作區的每個成員。 我們建議至少指派 [讀者] 角色來檢視閘道的設定。 [擁有者] 和 [參與者] 可以管理閘道的設定，包括調整閘道的大小。

    • 擁有者
    • 參與者
    • 讀取者

開始使用您的工作區

根據其在工作區中的角色而定，使用者可能有權建立 API、產品、訂用帳戶和其他資源，或者，他們可能具有存取其中部分或全部的唯讀權限。

若要開始在工作區中管理、保護及發佈 API，請參閱下列指導。

資源 指南
API 教學課程：匯入和發佈您的第一個 API
產品 教學課程：建立和發行產品
訂用帳戶 Azure APIM 中的訂用帳戶

在 APIM 中建立訂用帳戶
原則 教學課程：轉換及保護 API

Azure API 管理中的原則 \(部分機器翻譯\)

設定或編輯 APIM 原則
具名值 使用具名值管理祕密
後端 在 Azure API 管理中使用後端
原則片段 在 APIM 原則定義中重複使用原則設定
結構描述 驗證內容
群組 建立和使用群組管理開發人員帳戶
通知 如何設定通知和通知範本

相關內容