次の方法で共有

API Management とオペレーショナル エクセレンス

  • [アーティクル]

API Management を使用して、API を社外、パートナー、社内の開発者に対して安全かつ大規模に発行する方法について説明します。 このネットワーク サービスは、あらゆる環境にわたる API のためのハイブリッドなマルチクラウド管理プラットフォームです。

次のものがコンポーネントに含まれます。

詳細については、「API Management について」を参照してください。

API Management でオペレーショナル エクセレンスがどのようにサポートされるかについては、次のトピックを参照してください。

チェック リスト

オペレーショナル エクセレンスを考慮して API Management を構成しましたか?

  • API Management とバックエンドの間の通信をセキュリティで保護します。
  • API をサード パーティに公開するときに、各パーティが独自の資格情報を持っている必要があります。
  • API をサード パーティに公開するときに、必ずクォータとレート制限を設定します。
  • Microsoft REST API の設計とアーキテクチャのガイダンスについて理解します。
  • API のバージョン管理を有効にして、他の機能を追加しながら下位互換性を維持します。
  • API Management のバージョン管理機能とリビジョン機能を使用して、API のバージョン管理を実装します。
  • API Management での API のインポートに関する制限について理解します。
  • イベント ログ機能について理解します。
  • Azure API Management で呼び出しをトレースして、デバッグとテストに利用します。
  • API Management サービスに Azure Monitor を使用してログを構成します。
  • プライベート サイト接続にアクセスする適切なモードを選択します。
  • API Management のパブリック IP アドレスに基づいて、ファイアウォール規則と IP 許可リストを検討します。

構成に関する推奨事項

API Management サービスを構成するときは、オペレーショナル エクセレンスに関する次の推奨事項を考慮してください。

推奨 Description
API をサード パーティに公開する場合は、クォータとレート制限を設定してください。 バックエンド サービスを保護し、API Management スケール ユニットに対する負荷を軽減します。 レート制限ポリシーをグローバル、製品、API、操作の各レベルで適用することで、API コンシューマーに適用されるレート制限をカスタマイズできます。
Microsoft REST API の設計とアーキテクチャのガイダンスについて理解します。 REST API を使用するときは、標準とベスト プラクティスに従います。 ベスト プラクティスに従うことで、プラットフォームと実装間で最大限の互換性を確保できます。 REST API のガイドラインと API 設計ガイダンスを確認してください。
API Management での API のインポートに関する制限について理解します。 API のインポート プロセスがスムーズに実行されるように、カスタマイズを不要にするなどのあらゆる対応が行われています。 場合によっては、適用された制限によってインポート ソースの変更が必要となることがあります。 該当するのは REST サービスと SOAP サービスです。 ポリシーの制限を参照して、API のインポートに関する最新の制限を確認してください。
イベント ログ機能について理解します。 ほぼリアルタイムの分析を実行できるように、Azure イベント ハブへのイベント ログの記録がサポートされます。 この機能は、外部ログ、セキュリティ情報イベント管理 (SIEM) ソリューション、あるいはほぼリアルタイムの API 使用分析と統合されます。
Azure API Management で呼び出しをトレースして、デバッグとテストに利用します。 要求を行うために使用するサブスクリプションでトレースを有効にする必要があります。 トレースは、Ocp-Apim-Trace ヘッダー値を使用して要求ごとに有効にします。 API トレースは管理ポータルにも組み込まれており、ポータルから API をテストするときに既定で有効になります。
API Management サービスに Azure Monitor を使用してログを構成します。 ログを Logs Analytics ワークスペースに送信して、複雑なクエリや分析を行うことができます。 長期的な分析のためにメトリックを取り込むこともできます。 その後、Azure Monitor を使用してすべてのデータを確認できます。 アプリケーション パフォーマンス管理のために Application Insightsを統合することができます。
プライベート サイト接続にアクセスする適切なモードを選択します。 内部モードと外部モードでの Virtual Network 統合がサポートされます。
API Management のパブリック IP アドレスに基づいて、ファイアウォール規則と IP 許可リストを検討します。 固定パブリック IP アドレスは、API Management の Basic、Developer、Standard、Premium の各プランでサービスの有効期間にわたって使用できます。

次のステップ

信頼性と Azure Firewall