如何在 Azure API 管理中建立和使用群組來管理開發人員帳戶

適用於:開發人員 |基本 |基本 v2 |標準 |標準 v2 |進階版

在 API 管理中,群組的作用是管理產品對於開發人員的可見度。 產品是先設為可讓群組看見,然後群組中的開發人員就能檢視和訂閱與群組相關聯的產品。

API 管理具有下列不可變的系統群組:

  • 管理員 - Azure 訂閱管理員是此群組的成員。 管理員可管理 API 管理服務執行個體、建立開發人員所使用的 API、作業和產品。 您無法在此群組中新增使用者。

    注意

    您可以變更管理員的電子郵件設定,以用於從 API 管理執行個體傳送給開發人員的通知。

  • 開發人員 - 已驗證的開發人員入口網站使用者屬於此群組。 開發人員是使用您的 API 建置應用程式的客戶。 開發人員獲授與開發人員入口網站的存取權,並建置呼叫 API 作業的應用程式。

  • 來賓 - 未經驗證的開發人員入口網站使用者 (例如,造訪 API 管理執行個體之開發人員入口網站的潛在客戶) 屬於此群組。 他們可獲得特定唯讀存取權限,例如他們可檢視 API 但無法進行呼叫。

除了這些系統群組以外,管理員還可以建立自訂群組,或在相關聯的 Microsoft Entra 租用戶中使用外部群組。 自訂群組和外部群組可以與系統群組一起使用,提供開發人員 API 產品的能見度及存取權。 例如,您可以為與特定夥伴組織有關的開發人員建立一個自訂群組,並只允許他們存取來自含相關 API 之產品的 API。 使用者可以是多個群組的成員。

本指南說明 API 管理執行個體的管理員如何加入新的群組,並將這些群組與產品和開發人員建立關聯。

除了在 Azure 入口網站中建立和管理群組,您還可以使用 API 管理 REST API 群組實體來建立和管理您的群組。

必要條件

完成本文中的工作:建立 Azure API 管理執行個體

移至您的 API 管理執行個體

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

    選取 API 管理 服務

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

    選取您的 API 管理 實例

建立群組

本節說明如何將新的群組新增至 API 管理帳戶。

  1. 選取畫面左側的 [群組] 索引標籤。

  2. 按一下 [+新增]

  3. 輸入群組的唯一名稱和選用的描述。

  4. 按下 [建立]

    在入口網站中建立群組的螢幕快照。 一旦建立群組之後,就會將其新增至 [群組] 清單。

    • 若要編輯群組的 [名稱] 或 [描述],按一下群組名稱,然後選取 [設定]

    • 若要刪除群組,按一下群組名稱,然後按下 [刪除]

現在已建立群組,它可以與產品和開發人員建立關聯。

將群組與產品建立關聯

  1. 選取左側的 [產品] 索引標籤。

  2. 按一下所需產品的名稱。

  3. 按下 [存取控制]>[+ 新增群組]

  4. 選取您想要新增的群組。

    在入口網站中將群組新增至產品的螢幕快照。

當產品與群組建立關聯之後,該群組中的開發人員就可以檢視和訂閱產品。

注意

若要新增 Microsoft Entra 群組,請參閱如何在 Azure APIM 中使用 Microsoft Entra ID 授權開發人員帳戶

若要從產品中移除群組,按一下 [刪除]

從入口網站中的產品移除群組的螢幕快照。

將群組與開發人員建立關聯

本節說明如何讓群組與成員產生關聯。

  1. 選取畫面左側的 [群組] 索引標籤,然後選取群組。

  2. 選取 [成員]>[+ 新增]

  3. 選取成員。

    在入口網站中將成員新增至群組的螢幕快照。

  4. 按 [選取]

在開發人員與群組之間加入關聯之後,您可以在 [ 使用者 ] 索引標籤中檢視此關聯。

後續步驟

  • 當開發人員加入至群組之後,他們就可以檢視和訂閱與該群組相關聯的產品。 如需詳細資訊,請參閱如何在 Azure API 管理 中建立和發佈產品。
  • 您可以控制如何為您設定的不同使用者和群組顯示開發人員入口網站內容。 深入了解 開發人員入口網站中的可見性和訪問控制。
  • 了解如何管理用於從「API 管理」執行個體傳送給開發人員之通知的系統管理員電子郵件設定