Azure API Management でグループを作成および使用して開発者アカウントを管理する方法How to create and use groups to manage developer accounts in Azure API Management

API Management では、開発者に成果物の表示を許可するかどうかが、グループを使用して管理されます。In API Management, groups are used to manage the visibility of products to developers. グループに対して成果物の表示が許可されると、そのグループに属する開発者は、グループに関連付けられた成果物を表示してサブスクライブできるようになります。Products are first made visible to groups, and then developers in those groups can view and subscribe to the products that are associated with the groups.

API Management には、次に示すシステム グループが用意されています。これらのシステム グループを変更することはできません。API Management has the following immutable system groups:

  • 管理者 - Azure サブスクリプション管理者は、このグループのメンバーです。Administrators - Azure subscription administrators are members of this group. 管理者は、API Management サービス インスタンスを管理します。開発者が使用する API とその操作、成果物は、管理者が作成します。Administrators manage API Management service instances, creating the APIs, operations, and products that are used by developers.
  • 開発者 - 認証された開発者ポータル ユーザーは、このグループに分類されます。Developers - Authenticated developer portal users fall into this group. 開発者は、API の利用者です。管理者によって作成された API を使用してアプリケーションを構築します。Developers are the customers that build applications using your APIs. 開発者は、開発者ポータルへのアクセスが認められており、API の操作を呼び出すアプリケーションを構築します。Developers are granted access to the developer portal and build applications that call the operations of an API.
  • ゲスト - API Management インスタンスの開発者ポータルに訪れる開発者ポータル ユーザーのうち、認証を受けていないもの (利用予定者など) がこのグループに該当します。Guests - Unauthenticated developer portal users, such as prospective customers visiting the developer portal of an API Management instance fall into this group. 特定の読み取り専用アクセスを許可することができます (API の閲覧はできるが、呼び出すことはできないなど)。They can be granted certain read-only access, such as the ability to view APIs but not call them.

管理者は、これらのシステム グループに加えてカスタム グループを作成できるほか、関連付けられている Azure Active Directory テナントの外部グループを活用することもできます。In addition to these system groups, administrators can create custom groups or leverage external groups in associated Azure Active Directory tenants. カスタム グループと外部グループをシステム グループと共に使用することにより、開発者には API 成果物の可視性とアクセスが提供されます。Custom and external groups can be used alongside system groups in giving developers visibility and access to API products. たとえば、特定のパートナー企業に所属する開発者向けにカスタム グループを 1 つ作成し、関連する API のみが含まれている成果物の API に対してアクセスを許可することができます。For example, you could create one custom group for developers affiliated with a specific partner organization and allow them access to the APIs from a product containing relevant APIs only. ユーザーは 複数のグループのメンバーになることができます。A user can be a member of more than one group.

このガイドでは、API Management インスタンスの管理者が新しいグループを追加して成果物および開発者に関連付ける方法について説明します。This guide shows how administrators of an API Management instance can add new groups and associate them with products and developers.

発行者ポータルでグループを作成および管理するだけでなく、API Management REST API グループ エンティティを使用してグループを作成および管理することができます。In addition to creating and managing groups in the publisher portal, you can create and manage your groups using the API Management REST API Group entity.

可用性Availability

重要

この機能は、API Management の PremiumStandardBasicDeveloper レベルで使用できます。This feature is available in the Premium, Standard, Basic and Developer tiers of API Management.

前提条件Prerequisites

次の記事のタスクを済ませておいてください: Azure API Management インスタンスを作成するComplete tasks in this article: Create an Azure API Management instance.

API Management インスタンスに移動します。Go to your API Management instance

API Management インスタンスに移動

  1. Azure Portal にサインインします。Sign in to the Azure portal.

  2. [すべてのサービス] を選択します。Select All services.

  3. 検索ボックスに「 api management」と入力します。In the search box, enter api management.

  4. 検索結果で、 [API Management サービス] を選択します。In the search results, select API Management services.

  5. お使いの API Management サービス インスタンスを選択します。Select your API Management service instance.

ヒント

Azure portal で API Management をお気に入りに追加するには、星を選択します。To add API Management to your favorites in the Azure portal, select the star.

API Management アイコン (The API Management icon (API Management アイコン) が、ポータルの左側のメニューに表示されます。) now appears in the left menu in the portal.

グループの作成 Create a group

このセクションでは、API Management アカウントに新しいグループを追加する方法を示します。This section shows how to add a new group to your API Management account.

  1. 画面の左にある [グループ] タブを選択します。Select the Groups tab to the left of the screen.

  2. [+ 追加] をクリックします。Click +Add.

  3. グループの一意の名前とオプションの説明を入力します。Enter a unique name for the group and an optional description.

  4. [作成] をクリックします。Press Create.

    新しいグループを追加する

グループが作成されると、それが [グループ] リストに追加されます。Once the group is created, it is added to the Groups list.
グループの [名前] または [説明] を編集するには、そのグループの名前と [設定] をクリックします。To edit the Name or Description of the group, click the name of the group and Settings.
グループを削除するには、そのグループの名前をクリックし、 [削除] を押します。To delete the group, click the name of the group and press Delete.

グループが作成されます。このグループは、成果物および開発者と関連付けることができます。Now that the group is created, it can be associated with products and developers.

グループと成果物の関連付け Associate a group with a product

  1. 左にある [成果物] タブを選択します。Select the Products tab to the left.

  2. 目的の成果物の名前をクリックします。Click the name of the desired product.

  3. [アクセス制御] を押します。Press Access control.

  4. [+ グループの追加] をクリックします。Click + Add group.

    グループと成果物を関連付ける

  5. 追加するグループを選択します。Select the group you want to add.

    グループと成果物を関連付ける

    成果物からグループを削除するには、 [削除] をクリックします。To remove a group from the product, click Delete.

    グループを削除する

成果物をグループに関連付けると、そのグループに属する開発者は、成果物を表示してサブスクライブすることができます。Once a product is associated with a group, developers in that group can view and subscribe to the product.

注意

Azure Active Directory グループを追加するには、「 Azure API Management で Azure Active Directory を使用して開発者アカウントを認証する方法」をご覧ください。To add Azure Active Directory groups, see How to authorize developer accounts using Azure Active Directory in Azure API Management.

グループと開発者の関連付け Associate groups with developers

このセクションでは、グループをメンバーに関連付ける方法を示します。This section shows how to associate groups with members.

  1. 画面の左にある [グループ] タブを選択します。Select the Groups tab to the left of the screen.

  2. [メンバー] を選択します。Select Members.

    メンバーを追加する

  3. [+ 追加] を押し、メンバーを選択します。Press +Add and select a member.

    メンバーを追加する

  4. [選択] を選択します。Press Select.

開発者とグループの間に関連付けを追加すると、 [ユーザー] タブにその関連付けが表示されるようになります。Once the association is added between the developer and the group, you can view it in the Users tab.

次のステップ Next steps

  • 開発者をグループに関連付けると、開発者は、グループに関連付けられた成果物を表示してサブスクライブすることができます。Once a developer is added to a group, they can view and subscribe to the products associated with that group. 詳細については、「Azure API Management で成果物を作成して発行する方法」をご覧ください。For more information, see How create and publish a product in Azure API Management,
  • 発行者ポータルでグループを作成および管理するだけでなく、API Management REST API グループ エンティティを使用してグループを作成および管理することができます。In addition to creating and managing groups in the publisher portal, you can create and manage your groups using the API Management REST API Group entity.