Azure API Management でワークスペースを作成および管理する

適用対象: Premium

ワークスペースを設定して、API チームが独自の API を管理および製品化できるようにします。一方、API プラットフォーム チームに API Management プラットフォームを監視、管理、保守するためのツールを提供します。 ワークスペースを作成してアクセス許可を割り当てると、ワークスペース コラボレーターは独自の API、製品、サブスクリプション、および関連リソースを作成および管理することができます。

この記事の手順に従って、次のことを行います。

• Azure portal を使用して API Management ワークスペースとワークスペース ゲートウェイを作成する
• 必要に応じて、Azure 仮想ネットワーク内のワークスペース ゲートウェイを分離する
• ワークスペースにアクセス許可を割り当てる

前提条件

• API Management インスタンス。 必要に応じて、サポートされているレベルにそれを作成します。
• API Management インスタンスがデプロイされているリソース グループの所有者または共同作成者ロール、あるいはリソース グループにリソースを作成するための同等のアクセス許可。
• (省略可能) ワークスペース ゲートウェイの受信と送信のトラフィックを分離するための既存または新しい Azure 仮想ネットワークとサブネット。 構成オプションと要件については、「ワークスペース ゲートウェイのネットワーク リソース要件」を参照してください。

ワークスペースを作成する - ポータル

1. Azure portal にサインインし、API Management インスタンスに移動します。

2. 左側のメニューの [API] で、[ワークスペース]>[+ 追加] を選択します。

3. [基本] タブで、ワークスペースのわかりやすい表示名、リソースの名前、省略可能な説明を入力します。 [次へ] を選択します。

4. [ゲートウェイ] タブで、ワークスペース ゲートウェイの設定を構成します。

   • [ゲートウェイの詳細] で、ゲートウェイ名を入力し、スケール ユニットの数を選択します。 ゲートウェイのコストは、選択したユニット数に基づきます。 詳細については、「API Management の価格」を参照してください。

   • [ネットワーク] で、ワークスペース ゲートウェイの [ネットワーク構成] を選択します。

     重要

     ワークスペースのネットワーク構成は慎重に計画してください。 ワークスペースの作成後にネットワーク構成を変更することはできません。

   • プライベート受信またはプライベート送信ネットワーク アクセスを含むネットワーク構成を選択する場合は、[仮想ネットワーク] と [サブネット] を選択してワークスペース ゲートウェイを分離するか、新しいものを作成します。 ネットワーク要件については、「ワークスペース ゲートウェイのネットワーク リソース要件」を参照してください。

5. [次へ] を選択します。 検証が完了した後、 [作成] を選択します。

ワークスペース、ワークスペース ゲートウェイ、関連リソースの作成には、数分から数時間かかる場合があります。 Azure portal でデプロイの進行状況を追跡するには、ゲートウェイのリソース グループに移動します。 左側のメニューで、[設定] の下の [デプロイ] を選択します。

デプロイが完了すると、新しいワークスペースが [ワークスペース] ページの一覧に表示されます。 ワークスペースを選択して、その設定とリソースを管理します。

ワークスペースにユーザーを割り当てる - ポータル

ワークスペースを作成したら、ワークスペースのリソースを管理するためのアクセス許可をユーザーに割り当てます。 各ワークスペース ユーザーには、サービス スコープのワークスペース RBAC ロールとワークスペース スコープの RBAC ロールの両方を割り当てるか、カスタム ロールを使用して同等のアクセス許可を付与する必要があります。

ワークスペース ゲートウェイを管理するために、ワークスペース ユーザーには、ワークスペース ゲートウェイをスコープにした Azure 提供の RBAC ロールも割り当てることをお勧めします。

• 組み込みのワークスペース ロールの一覧については、「API Management でロールベースのアクセス制御を使用する方法」を参照してください。
• ロールを割り当てる手順については、「ポータルを使用して Azure ロールを割り当てる」を参照してください。

サービス スコープのロールを割り当てる

1. Azure portal にサインインし、API Management インスタンスに移動します。

2. 左側のメニューで、[アクセス制御 (IAM)]>[追加] の順に選択します。

3. ワークスペースの他のメンバーに次のいずれかのサービス スコープのロールを割り当てます。

   • API Management サービス ワークスペース API 開発者
   • API Management サービス ワークスペース API プロダクト マネージャー

ワークスペース スコープのロールを割り当てる

1. API Management インスタンスのメニューで、[API] の [ワークスペース]> 作成したワークスペースの名前の順に選択します。

2. [ワークスペース] ウィンドウで、[アクセス制御 (IAM)]>[追加] の順に選択します。

3. ワークスペース メンバーに対しては、ワークスペース API やその他のリソースを管理できるように、次のいずれかのワークスペース スコープのロールを割り当てます。

   • API Management ワークスペース閲覧者
   • API Management ワークスペース共同作成者
   • API Management ワークスペース API 開発者
   • API Management ワークスペース API プロダクト マネージャー

ゲートウェイ スコープのロールを割り当てる

1. Azure portal にサインインし、API Management インスタンスに移動します。

2. 左側のメニューの [API] で、[ワークスペース]> ワークスペース名を選択します。

3. ワークスペースの左側のメニューで、[ゲートウェイ] を選択し、ワークスペース ゲートウェイを選択します。

4. 左側のメニューで、[アクセス制御 (IAM)]>[追加] の順に選択します。

5. ワークスペースの各メンバーに次のいずれかのロールを割り当てます。 少なくとも、ゲートウェイの設定を表示するための閲覧者ロールを割り当てることをお勧めします。 所有者と共同作成者 は、ゲートウェイのスケーリングを含むゲートウェイの設定を管理できます。

   • [所有者]
   • Contributor
   • Reader

ワークスペースの概要

ワークスペース内のロールによっては、ユーザーには API、製品、サブスクリプション、その他のリソースを作成するためのアクセス許可がある場合や、それらの一部またはすべてに対する読み取り専用アクセスが付与されている場合があります。

ワークスペースで API の管理、保護、公開を開始するには、次のガイダンスを参照してください。

関連するコンテンツ

• Azure API Management のワークスペースの詳細について確認します。
• 仮想ネットワークを使用して Azure API Management の受信または送信トラフィックをセキュリティで保護する