環境クレジット サービスの Postman コレクションを設定する (プレビュー)

  • [アーティクル]

Microsoft Cloud for Sustainability テクニカルサミット 2024 年 5 月

重要

この機能の一部またはすべては、プレビュー リリースの一部として利用できます。 コンテンツおよび機能は変更される場合があります。 30 日間の試用版で、環境クレジット サービス (プレビュー) サンドボックス環境にアクセスできます。 運用環境で、環境クレジット サービス (プレビュー) を使用するには、環境クレジット サービス (プレビュー) サインアップ フォームを完了してください。

Postman コレクション をコピーして、必要に応じてパラメータを変更できます。

Microsoft Entra ID テナントのファースト パーティ アプリケーションとしてのオンボード環境クレジット サービス (プレビュー)

環境クレジット サービス (プレビュー) で認証するには、ディレクトリのユーザーは認証トークン (特に JSON Web トークン) を必要なクレームと共に提示する必要があります。 これらの要求は、環境クレジット サービス (プレビュー) がユーザーに提供されたアクセスを識別するのに役立ちます。

メモ

環境クレジット サービス (プレビュー) は Microsoft のファースト パーティ アプリケーションであるため、デプロイ後にテナントから削除することはできません。

  1. テナントに環境クレジット サービス (プレビュー) を展開するためのアクセス権があることを確認します。

    Azure Portal > Microsoft Entra ID > ユーザー設定 に移動し、ユーザーがアプリケーションを登録できるプロパティを確認します。 これが いいえ に設定されている場合は、Microsoft Entra ID テナント管理者のいずれかに連絡して、テナントに環境クレジット サービス (プレビュー) を設定してください。

  2. チームに該当するシナリオに基づいて、クライアントまたは Web アプリをテナントに登録するために、このアクセス許可が必要になる場合もあります。

  3. Microsoft Entra ID PowerShell for Graph で接続モジュール の手順に従ってください。 これらの手順により、Microsoft Entra ID PowerShell モジュールを設定し、最初の手順で指定したアクセス許可を持つ ID を使用して、Microsoft Entra ID テナントに接続します。

  4. テナントに環境クレジット サービス (プレビュー) を展開するには、Microsoft Entra ID PowerShell モジュールを指定して、次の PowerShell コマンドを使用します。

       New-AzureADServicePrincipal -AppId "b9b0ac19-f710-429d-b58e-dc3f73a330a9" -DisplayName "Environmental Credit Service"

  5. 環境クレジット サービス (プレビュー) がテナントに展開されたら、Azure ポータル > Microsoft Entra ID > エンタープライズ アプリケーション > アプリケーションの種類に Microsoft アプリケーションを選択 (および適用) に移動します。 環境クレジット サービス (プレビュー) を検索して、展開されたエンタープライズ アプリを視覚化します。

Postman コレクションを設定する

環境クレジット サービス (プレビュー) の Postman コレクションを設定するには、環境クレジット サービス (プレビュー) と対話する使用する Microsoft Entra ID テナントごとに、1 回限りの手順に従います。

  1. Azure Portal > Microsoft Entra ID > アプリの登録 > 新規登録 に移動して、テナントにパブリック クライアント アプリケーションを登録します。 次の値を入力します。

    • 名前: 有効なユーザー向け表示名を付けます。
    • サポートされているアカウントの種類: オプション この組織ディレクトリ内のアカウントのみ を選択します。これは、アプリがこのテナントの外部のユーザー アカウントを認証しないためです。
    • この場合、リダイレクト URI は想定されていません。

  2. 認証を選択します。 詳細設定 で、アプリケーションをパブリック クライアントとして扱う を はい に設定します。 変更を保存。 パブリック クライアント アプリケーションを使用すると、ユーザーはモバイルまたはデスクトップ ワークフローを使用して認証し、リソース所有者のパスワード資格情報ワークフローを使用してプレーンテキストのパスワードを収集できます。

  3. マニフェスト セクションを選択します。 JSON エディターで、accessTokenAcceptedVersion プロパティを検索し、その値を 2 に設定します。 保存を選択して、変更を適用します。

  4. このシナリオでは、パブリック クライアントは、サインインしているユーザーのトークンを使用して、環境クレジット サービス (プレビュー) API にアクセスしようとします。 アプリケーションは、Application.ReadWrite 委任されたアクセス許可を、前提条件セクションに登録されている環境クレジット サービス (プレビュー) エンタープライズ アプリによって公開されるように要求する必要があります。

    1. 登録済みのアプリケーションに移動し、 API 権限 を選択してから、権限を追加 を選択します。
    2. 自分の組織が使用する API タブを選択し、前提条件の手順でテナントに展開された環境クレジット サービス (プレビュー) エンタープライズ アプリを検索します。
    3. 委任されたアクセス許可 を選択します。 委任されたアクセス許可では、アプリケーションがトークンを使用して必要なリソースにアクセスできることを示すために、1 回限りのユーザーの同意が必要です。 このシナリオには非対話型のワークフローが含まれるため、必要な委任されたアクセス許可について、テナント管理者によって事前に同意が付与される必要があります。

委任されたアクセス許可が設定されたら、承認要求に記載されている詳細を使用して、非インタラクティブのアクセス トークンを要求できます。

アクセス トークンの要求のスコープ プロパティの値は、Application.ReadWrite スコープ: https://ecs.mcfs.microsoft.com/Application.ReadWrite と等しくなければなりません。 トークン エンドポイント の呼び出しは、環境クレジット サービス (プレビュー) API にアクセスする前に開始できます。

認証が機能したら、次の Postman コレクション変数を更新します。

  1. 前の手順で説明したように、クライアント ID 変数を、それぞれの Microsoft Entra ID テナントに登録されているパブリック クライアント アプリケーションのアプリケーション ID プロパティに設定します。

  2. Postman コレクションで使用可能な変数の必要に応じて、ユーザー名 (電子メール) とパスワードを更新します。

関連項目

環境クレジット サービス (プレビュー) の概要
環境クレジット サービス (プレビュー) の用語集
環境クレジット サービス (プレビュー) API リファレンスの概要