チュートリアル: REST API を使用する

このチュートリアルでは、 Microsoft Purview データ プレーン REST API の使用方法について説明します。 Microsoft Purview にデータを送信したり、自動プロセスの一部として Microsoft Purview を含めたり、Microsoft Purview で独自のユーザー エクスペリエンスを構築したりする場合は、REST API を使用してこれを行うことができます。

Azure サブスクリプションをお持ちでない場合は、開始 する前に無料アカウントを作成 してください。

前提条件

• 開始するには、既存の Microsoft Purview アカウントが必要です。 カタログがない場合は、 Microsoft Purview アカウントを作成するためのクイック スタートを参照してください。

サービス プリンシパル (アプリケーション) を作成する

REST API クライアントが Microsoft Purview データ プレーン API にアクセスするには、クライアントにサービス プリンシパル (アプリケーション)、および Microsoft Purview が認識し、信頼するように構成されている ID が必要です。 REST API 呼び出しを行うと、そのサービス プリンシパルの ID が承認に使用されます。

既存のサービス プリンシパル (アプリケーション ID) を使用しているお客様は、エラー率が高くなっています。 そのため、API を呼び出すための新しいサービス プリンシパルを作成することをお勧めします。

新しいサービス プリンシパルを作成するには:

1. Azure portal にサインインし

2. ポータルで、 Azure Active Directory を検索して選択します。

3. [Azure Active Directory] ページで、左側のウィンドウから [アプリの登録] を選択します。

4. [新規登録] を選択します。

5. [アプリケーションの登録] ページ で、次の手順を実行 します。

   1. アプリケーションの 名前 (サービス プリンシパル名) を入力します。
   2. [この組織のディレクトリ内のアカウントのみ ( <テナントの名前>のみ - シングル テナント)] を選択します。
   3. [ リダイレクト URI (省略可能)] で、[ Web ] を選択し、値を入力します。 この値は有効なエンドポイントである必要はありません。 https://exampleURI.com やりましょう。
   4. [登録] を選択します。

   

6. 新しいサービス プリンシパル ページで、後で保存する [表示名 ] と [アプリケーション (クライアント) ID] の 値をコピーします。

   アプリケーション ID は、 client_id サンプル コードの値です。

   

サービス プリンシパル (アプリケーション) を使用するには、次の方法で検出できるサービス プリンシパルのパスワードを知っている必要があります。

1. Azure portalで[Azure Active Directory] を検索して選択し、左側のウィンドウで [アプリの登録] を選択します。

2. 一覧からサービス プリンシパル (アプリケーション) を選択します。

3. 左側のウィンドウで [証明書 & シークレット ] を選択します。

4. [新しいクライアント シークレット] を選択します。

5. [ クライアント シークレットの追加] ページで 、[ 説明] を入力し、[ 有効期限] で有効期限を選択し、[ 追加] を選択します。

   [ クライアント シークレット ] ページで、新しいシークレットの [値 ] 列の文字列がパスワードです。 この値を保存します。

   

サービス プリンシパルを使用して認証を設定する

新しいサービス プリンシパルが作成されたら、purview アカウントのデータ プレーン ロールを上記で作成したサービス プリンシパルに割り当てる必要があります。 サービス プリンシパルと Purview アカウントの間で信頼を確立するための正しいロールを割り当てるには、次の手順に従います。

1. Microsoft Purview ガバナンス ポータルに移動します。

2. 左側のメニューで [データ マップ] を選択します。

3. [コレクション] を選択します。

4. [コレクション] メニューでルート コレクションを選択します。 これはリストの最上位のコレクションであり、Microsoft Purview アカウントと同じ名前になります。

   注:

   ルート コレクションではなく、任意のサブコレクションにサービス プリンシパルのアクセス許可を割り当てることもできます。 ただし、すべての API はそのコレクション (およびアクセス許可を継承するサブコレクション) にスコープが設定され、別のコレクションの API を呼び出そうとしているユーザーはエラーを受け取ります。

5. [ ロールの割り当て ] タブを選択します。

6. 以前に作成したサービス プリンシパルに次のロールを割り当てて、Microsoft Purview のさまざまなデータ プレーンにアクセスします。 詳細な手順については、「 Microsoft Purview ガバナンス ポータルを使用して Azure ロールを割り当てる」を参照してください。

   • カタログ データ プレーンにアクセスするためのデータ キュレーター ロール。
   • スキャン データ プレーンにアクセスするためのデータ ソース管理者ロール。
   • コレクション 管理アカウント データ プレーンとメタデータ ポリシー データ プレーンにアクセスするためのロール。
   • DevOps ポリシー API にアクセスするためのポリシー作成者ロール

   注:

   Microsoft Purview でデータ プレーン ロールを割り当てることができるのは、Collection 管理 ロールのメンバーのみです。 Microsoft Purview ロールの詳細については、「Microsoft Purview のAccess Control」を参照してください。

トークンを取得する

POST 要求を次の URL に送信して、アクセス トークンを取得できます。

https://login.microsoftonline.com/{your-tenant-id}/oauth2/token

テナント ID は、Azure portalで [テナントのプロパティ] を検索することで確認できます。 ID はテナントのプロパティ ページで使用できます。

次のパラメーターを上記の URL に渡す必要があります。

• client_id: Azure Active Directory に登録され、Microsoft Purview アカウントのデータ プレーン ロールに割り当てられているアプリケーションのクライアント ID。
• client_secret: 上記のアプリケーション用に作成されたクライアント シークレット。
• grant_type: これは 'client_credentials' である必要があります。
• resource: 'https://purview.azure.net'

PowerShell の POST 要求の例を次に示します。

$tenantID = "12a345bc-67d1-ef89-abcd-efg12345abcde"

$url = "https://login.microsoftonline.com/$tenantID/oauth2/token"
$params = @{ client_id = "a1234bcd-5678-9012-abcd-abcd1234abcd"; client_secret = "abcd~a1234bcd56789012abcdabcd1234abcd"; grant_type = "client_credentials"; resource = ‘https://purview.azure.net’ }

Invoke-WebRequest $url -Method Post -Body $params -UseBasicParsing | ConvertFrom-Json

サンプル応答トークン:

    {
        "token_type": "Bearer",
        "expires_in": "86399",
        "ext_expires_in": "86399",
        "expires_on": "1621038348",
        "not_before": "1620951648",
        "resource": "https://purview.azure.net",
        "access_token": "<<access token>>"
    }

データ プレーン API を呼び出すには、上記のアクセス トークンを使用します。

次の手順