電子情報開示に Microsoft Purview API を使用する

Microsoft Graph の電子情報開示用 Microsoft Purview アプリケーションプログラミングインターフェイス (API) を使用すると、organizationは反復的なタスクを自動化し、既存の電子情報開示ツールと統合して、業界の規制で必要になる可能性がある反復可能なワークフローを構築できます。この記事では、電子情報開示用の Microsoft Purview API へのアクセスを有効にするために必要な前提条件を構成する方法について説明します。このガイダンスは、クライアントシークレットまたは自己署名証明書を使用して、API へのアプリ専用アクセスを使用して要求を認証する方法に基づいています。

Microsoft Purview API

電子情報開示用の Microsoft Purview API には、2 つの個別の API が含まれています。

Microsoft Graph: Microsoft.Graph.Security 名前空間の一部であり、電子情報開示ケースの操作に使用されます。
Microsoft Purview eDiscovery API: 電子情報開示で検索およびレビューセットからエクスポートするときに作成されたパッケージをプログラムでダウンロードするためにのみ使用されます。

Microsoft Graph の電子情報開示 API では、プレミアム機能が有効になっている場合と有効になっていない電子情報開示ケースがサポートされています。委任された認証では、ケース、保留、検索、エクスポートなどの主要な電子情報開示機能がサポートされています。アプリのみの認証は、Premium 機能が有効になっている場合に使用でき、レビューセット、タグ付け、分析などの高度な操作をサポートします。

Microsoft Graph 呼び出し内でサポートされている API 呼び出しの一覧については、「Microsoft Purview eDiscovery API を使用する」を参照してください。

データへのアプリケーションアクセス

電子情報開示用の Microsoft Purview API を呼び出すには、まず、Microsoft ID プラットフォームの Entra ID にアプリを登録する必要があります。

アプリケーションは、次の 2 つの方法でデータにアクセスできます。

委任されたアクセス: サインインしているユーザーに代わって動作するアプリ。
アプリ専用アクセス: 独自の ID で動作するアプリ。

アクセスシナリオの詳細については、「認証と承認の基本」を参照してください。

重要

アプリのみの認証では、プレミアム機能が有効になっている電子情報開示ケースが必要です。委任された認証は、ケース、訴訟ホールド、検索、エクスポートなどの主要な電子情報開示機能で使用できます。 Premium API 操作 (レビューセット、タグ付け、分析) では、認証方法に関係なく Premium 機能が有効になっている必要があります。サブスクリプション要件の詳細については、「電子情報開示のサブスクリプション要件」を参照してください。

Microsoft Graph API

Microsoft Graph APIの前提条件

アプリ専用 accessinvolves を実装するAzure portalでアプリを登録する、クライアントシークレット/証明書を作成する、API のアクセス許可を割り当てる、サービスプリンシパルを設定する、アプリ専用アクセスを使用して Microsoft Graph API を呼び出す。アプリを登録するには、クライアントシークレット/証明書を作成し、アカウントが クラウドアプリケーション管理者である必要がある API アクセス許可を割り当てます。

Azure portalでのアプリの登録の詳細については、「Microsoft ID プラットフォームにアプリケーションを登録する」を参照してください。

Microsoft Purview eDiscovery API アプリケーションのアクセス許可にテナント全体の管理者の同意を付与するには、organizationの代わりに同意する権限を持つユーザーとしてサインインする必要があります。詳細については、「アプリケーションにテナント全体の管理者の同意を付与する」を参照してください。

サービスプリンシパルを設定するには、次の前提条件が必要です。

ExchangeOnlineManagement モジュールがインストールされているマシン。
Microsoft Purview でロール管理ロールが割り当てられているアカウント。

電子情報開示にアプリ専用アクセスを実装する方法の詳細については、「Microsoft Purview eDiscoveryのアプリ専用アクセスを設定する」を参照してください。

アプリ専用アクセスを使用して Microsoft Graph APIに接続する

PowerShell の Connect-MgGraph コマンドレットを使用して、アプリのみのアクセス方法を使用して Microsoft Graph の認証と接続を行います。このコマンドレットを使用すると、アプリが Microsoft Graph と安全に対話でき、Microsoft Purview eDiscovery API を調べることができます。

クライアントシークレットを使用した接続

クライアントシークレットを使用して接続するには、次の PowerShell コードの例を更新して実行します。

$clientSecret = "<client secret>" ## Update with client secret added to the registered app
$appID = "<APP ID>" ## Update with Application ID of registered/Enterprise app
$tenantId = "<Tenant ID>" ## Update with tenant ID
$ClientSecretPW = ConvertTo-SecureString "$clientSecret" -AsPlainText -Force
$clientSecretCred = New-Object System.Management.Automation.PSCredential -ArgumentList ("$appID", $clientSecretPW)
Connect-MgGraph -TenantId "$tenantId" -ClientSecretCredential $clientSecretCred

証明書を使用した接続

証明書を使用して接続するには、次の PowerShell コードの例を更新して実行します。

$certPath = "Cert:\currentuser\my\<xxxxxxxxxx>" ## Update with the cert thumbnail
$appID = "<APP ID>" ## Update with Application ID of registered/Enterprise app
$tenantId = "<Tenant ID>" ## Update with tenant ID
$ClientCert = Get-ChildItem $certPath
Connect-MgGraph -TenantId $TenantId -ClientId $appId -Certificate $ClientCert

Microsoft Graph API 呼び出しを呼び出す

接続後、Microsoft Graph APIへの呼び出しを開始できます。

たとえば、ediscoveryCases API を使用して、テナント内の電子情報開示ケースを一覧表示できます。各操作のガイダンスには、次の情報が一覧表示されます。

API 呼び出しを行うために必要なアクセス許可
HTTP 要求とメソッド
ヘッダーと本文の情報を要求する
応答
例 (HTTP、C#、CLI、Go、Java、PHP、PowerShell、Python)

Microsoft Graph PowerShell モジュールを介して接続されているため、HTTP メソッドまたは PowerShell メソッドを使用できます。

まず、 PowerShell の例を見てみましょう。

電子情報開示ケースの一覧の PowerShell の例。

ご覧のように、テナント内のすべてのケースの一覧が返されます。ケースをさらに詳しく説明する場合は、ケース ID を記録することが重要です。今後の API 呼び出しには、この ID が必要です。

次に、 HTTP の例を見てみましょう。 Invoke-MgGraphRequest コマンドレットを使用して、PowerShell を使用して呼び出しを行います。

まず、URL を変数に格納します。

$uri = "https://graph.microsoft.com/v1.0/security/cases/ediscoveryCases"

次に、Invoke-MgGraphRequest コマンドレットを使用して API 呼び出しを行います。

Invoke-MgGraphRequest -Method Get -Uri $uri

次の出力からわかるように、返された応答から値を抽出する必要があります。

URL 出力の PowerShell の例。

次のコマンドを使用して、応答の Value 要素を新しい変数に保存できます。

$cases = (Invoke-MgGraphRequest -Method Get -Uri $uri).value

URL を抽出するための PowerShell の例。

ケースの URL を抽出するための PowerShell の例。

このコマンドは、ハッシュテーブルのコレクションを返します。必要に応じて、少しの PowerShell コードを実行して、ハッシュテーブルを PowerShell オブジェクトに変換して、 format-table や format-list などのコマンドレットパラメーターで簡単に使用 できます。

$CasesAsObjects = @()
foreach($i in $cases) {$CasesAsObjects += [pscustomobject]$i}
$CasesAsObjects | ft displayname,id,status

ハッシュテーブルを変換する PowerShell の例。

Microsoft Purview eDiscovery API

Microsoft Purview eDiscovery API を構成して、電子情報開示ケースのエクスポートパッケージとエクスポートプロセスからのレポートのプログラムによるダウンロードを有効にすることができます。

Microsoft Purview eDiscovery API の前提条件

このセクションの構成手順を実行する前に、「Microsoft Graph API」セクションで詳しく説明されている構成を完了して検証します。以前に登録したアプリをMicrosoft Entra IDに拡張して、エクスポートパッケージのプログラムによるダウンロードを実現するために必要なアクセス許可を含めます。

この構成には、次の前提条件が既に用意されています。

Azure portalに登録されているアプリは、適切なクライアントシークレットまたは証明書で構成されています。
Microsoft Purview のサービスプリンシパルには、関連する電子情報開示ロールが割り当てられます。
Microsoft Graph 用に構成された Microsoft 電子情報開示 API のアクセス許可。

既存の登録済みアプリの API アクセス許可を拡張してプログラムによるダウンロードを有効にするには、次の手順を実行します。

テナントに新しい Microsoft アプリケーションとサービスプリンシパルを登録します。
Azure portalで以前に登録したアプリに追加の API アクセス許可を割り当てます。

Microsoft Purview eDiscovery API アプリケーションのアクセス許可にテナント全体の管理者の同意を付与するには、organizationの代わりに同意する権限を持つユーザーとしてサインインします。詳細については、「アプリケーションにテナント全体の管理者の同意を付与する」を参照してください。

構成の手順

手順 1: MicrosoftPurviewEDiscovery アプリをMicrosoft Entra IDに登録する

次の手順を実行します。

MicrosoftPurviewEDiscovery アプリがまだ登録されていないことを検証します。 Azure portalにサインインし、[Microsoft Entra ID>Enterprise Applications] に移動します。
[アプリケーションの種類] フィルターを変更して、Microsoft アプリケーションを表示します。
検索ボックスに「 MicrosoftPurviewEDiscovery」と入力します。 MicrosoftPurviewEDiscovery アプリが表示されます。 MicrosoftPurviewEDiscovery アプリが一覧にない場合は、アプリをMicrosoft Entra IDに登録します。

アプリを登録するには、次の手順を実行します。
- Microsoft.Graph PowerShell モジュールを使用して、Microsoft Entra IDで MicrosoftPurviewEDiscovery アプリを登録します。詳細については、「 Microsoft Graph PowerShell SDK のインストール」を参照してください。
- モジュールがマシンにインストールされたら、次のコマンドレットを実行して、PowerShell を使用して Microsoft Graph に接続します。
```
Connect-MgGraph -scopes "Application.ReadWrite.All"
```
Microsoft Graph PowerShell コマンドレットを初めて使用する場合は、必要なアクセス許可に同意するように求められる場合があります。

MicrosoftPurviewEDiscovery アプリを登録するには、次の PowerShell コマンドを実行します。
```
$spId = @{"AppId" = "b26e684c-5068-4120-a679-64a5d2c909d9" }
```
```
New-MgServicePrincipal -BodyParameter $spId;
```

注:

PowerShell スクリプトを使用して、Microsoft Entra IDに新しいアプリケーションを登録し、必要に応じてアプリケーション認証用のMicrosoft Purview eDiscovery API アクセス許可を割り当てます。アプリケーションを登録したら、クライアントシークレットまたは証明書を構成し、ポータルを通じて管理者の同意を付与する必要があります。

手順 2: 登録されているアプリに追加の MicrosoftPurviewEDiscovery アクセス許可を割り当てる

サービスプリンシパルが追加されたら、この記事の Microsoft Graph API セクションで作成した以前に登録したアプリのアクセス許可を更新します。 Azure portalにサインインし、[Microsoft Entra ID>App Registrations] に移動します。

この記事の Microsoft Graph API セクションで作成したアプリを見つけて選択します。
ナビゲーションメニューから [ API アクセス許可] を選択します。
[アクセス許可の追加] を選択し、organizationで使用する API を選択します。
MicrosoftPurviewEDiscovery を検索して選択します。
[ アプリケーションのアクセス許可] を選択します。
電子情報開示の [チェック] ボックスを選択します。
[ アクセス許可の追加] を選択します。
[API のアクセス許可] で、[管理同意の付与 (organization)] を選択して、追加されたアクセス許可を承認します。

管理者の同意が付与されると、organizationに対して追加されたアクセス許可の状態が更新されます。

エクスポートパッケージとレポートのダウンロード

ケース ID とエクスポートジョブ ID の取得

電子情報開示ケースでエクスポートプロセスのエクスポートパッケージとレポートをダウンロードするには、エクスポートジョブのケース ID と操作またはジョブ ID が必要です。

Microsoft Purview ポータルを使用してこの情報を収集するには、

電子情報開示ケースを開きます。
エクスポートプロセスを見つけます。
[ サポート情報のコピー] を選択します。
この情報をテキストエディター (メモ帳など) に追加します。

または、次のGraph API呼び出しを使用して、この情報にプログラムでアクセスして、エクスポートするケース ID とジョブ ID を見つけます。

この記事の「アプリ専用アクセスを使用して Microsoft Graph APIに接続する」セクションの手順に従って、Microsoft Graph に接続します。
ケース名がわかっている場合は、次のコマンドで電子情報開示 Graph PowerShell コマンドレットを使用します。
```
Get-MgSecurityCaseEdiscoveryCase | where {$_.displayname -eq "<Name of case>"}
```
ケース ID を取得したら、次のコマンドを使用して、ケース内の操作を検索して、エクスポートのジョブ ID を特定します。
```
Get-MgSecurityCaseEdiscoveryCaseOperation -EdiscoveryCaseId "<case ID>"
```

エクスポートジョブは、検索からの直接エクスポートの 場合は exportResult 、レビューセットからのエクスポートの 場合は ContentExport のアクションでログに記録されます。エクスポートジョブの名前は、この API 呼び出しによって返されません。エクスポートプロセスの名前を見つけるには、特定の操作 ID を照会する必要があります。エクスポートプロセスの名前を見つけるには、次のコマンドを使用します。

Get-MgSecurityCaseEdiscoveryCaseOperation -EdiscoveryCaseId "<case ID>" -CaseOperationId “<operation ID>”

エクスポート操作の名前は、 AdditionalProperties フィールドに含まれます。

HTTP API 呼び出しを直接実行して、organization内のケースを一覧表示するには、「電子情報開示ケースの一覧表示」を参照してください。

HTTP API 呼び出しを直接実行してケースの操作を一覧表示するには、「 caseOperations の一覧表示」を参照してください。

API 呼び出しでケース ID を使用して、操作を一覧表示するケースを示します。例:

https://graph.microsoft.com/v1.0/security/cases/ediscoveryCases/<CaseID>/operations/

エクスポートジョブの名前は、この API 呼び出しでは返されません。エクスポートプロセスの名前を見つけるには、特定のジョブ ID を照会する必要があります。例:

https://graph.microsoft.com/v1.0/security/cases/ediscoveryCases/<CaseID>/operations/<OperationID>

エクスポートパッケージのダウンロード

エクスポートパッケージのダウンロード URL の取得

exportFileMetaData プロパティには、エクスポートパッケージとレポートをダウンロードするために必要な URL が含まれています。 URL を取得するには、エクスポートプロセスを実行した電子情報開示ケースのケース ID とエクスポートプロセスの操作 ID が 必要です。

この情報を見つけるには、次の電子情報開示グラフ PowerShell コマンドレットを使用します。

$operation = Get-MgSecurityCaseEdiscoveryCaseOperation -EdiscoveryCaseId "<case ID>" -CaseOperationId “<operation ID>”

$Operation.AdditionalProperties.exportFileMetadata

操作の exportFileMetaData 情報を返す HTTP API 呼び出しを直接行うには、 caseOperations の一覧表示に関するページを参照してください。

Microsoft Purview ポータルの各エクスポートパッケージには、 exportFileMetaData プロパティにエントリがあります。各エントリには、次の情報が一覧表示されます。

エクスポートパッケージファイル名
エクスポートパッケージを取得する downloadUrl
エクスポートパッケージのサイズ

エクスポートパッケージをダウンロードするためのスクリプトの例

Microsoft Purview eDiscovery API は Microsoft Graph APIとは別であるため、ダウンロード要求を承認するには別の認証トークンが必要です。 MSAL.PS PowerShell モジュールと Get-MSALToken コマンドレットを使用して、別のトークンを取得します。また、 Connect-MgGraph コマンドレットを使用して Microsoft Graph API に接続する必要もあります。

次のスクリプト例は、エクスポートパッケージのプログラムによるダウンロードを有効にするために、独自のスクリプトを開発するときに参照として使用できます。

クライアントシークレットとの接続

クライアントシークレットを使用するようにアプリを構成した場合は、次のサンプルスクリプトを参照として使用して、エクスポートパッケージとレポートをプログラムでダウンロードします。メモ帳に内容をコピーし、 DownloadExportUsingApp.ps1として保存します。

[CmdletBinding()]
param (
    [Parameter(Mandatory = $true)]
    [string]$tenantId,
    [Parameter(Mandatory = $true)]
    [string]$appId,
    [Parameter(Mandatory = $true)]
    [string]$appSecret,
    [Parameter(Mandatory = $true)]
    [string]$caseId,
    [Parameter(Mandatory = $true)]
    [string]$exportId,
    [Parameter(Mandatory = $true)]
    [string]$path = "D:\Temp",
    [ValidateSet($null, 'USGov', 'USGovDoD')]
    [string]$environment = $null
)

if (-not(Get-Module -Name Microsoft.Graph -ListAvailable)) {
    Write-Host "Installing Microsoft.Graph module"
    Install-Module Microsoft.Graph -Scope CurrentUser
}

if (-not(Get-Module -Name MSAL.PS -ListAvailable)) {
    Write-Host "Installing MSAL.PS module"
    Install-Module MSAL.PS -Scope CurrentUser
}

$password = ConvertTo-SecureString $appSecret -AsPlainText -Force
$clientSecretCred = New-Object System.Management.Automation.PSCredential -ArgumentList ($appId, $password)

if (-not(Get-MgContext)) {
    Write-Host "Connect with credentials of a ediscovery admin (token for graph)"
    if (-not($environment)) {
        Connect-MgGraph -TenantId $TenantId -ClientSecretCredential $clientSecretCred
    }
    else {
        Connect-MgGraph -TenantId $TenantId -ClientSecretCredential $clientSecretCred -Environment $environment
    }
}

Write-Host "Connect with credentials of a ediscovery admin (token for export)"
$exportToken = Get-MsalToken -ClientId $appId -Scopes "00001111-aaaa-2222-bbbb-3333cccc4444/.default" -TenantId $tenantId -RedirectUri "http://localhost" -ClientSecret $password

$uri = "/v1.0/security/cases/ediscoveryCases/$($caseId)/operations/$($exportId)"

$export = Invoke-MgGraphRequest -Uri $uri;
if (-not($export)){
    Write-Host "Export not found"
    exit
}
else{
    $export.exportFileMetadata | % {
        Write-Host "Downloading $($_.fileName)"
        Invoke-WebRequest -Uri $_.downloadUrl -OutFile "$($path)\$($_.fileName)" -Headers @{"Authorization" = "Bearer $($exportToken.AccessToken)"; "X-AllowWithAADToken" = "true" }
    }
}

スクリプトを保存し、次の PowerShell モジュールがインストールされている新しい PowerShell ウィンドウを開きます。

Microsoft.Graph
MSAL.PS

スクリプトを保存したディレクトリを参照し、次のコマンドを実行します。

.\DownloadExportUsingApp.ps1 -tenantId “<tenant ID>” -appId “<App ID>” -appSecret “<Client Secret>” -caseId “<CaseID>” -exportId “<ExportID>” -path “<Output Path>”

パスとして指定したフォルダーを確認して、ダウンロードしたファイルを表示します。

証明書を使用した接続

証明書を使用するようにアプリを構成した場合は、次のサンプルスクリプトを参照として使用して、エクスポートパッケージとレポートをプログラムでダウンロードします。内容をテキストエディターにコピーし、 DownloadExportUsingAppCert.ps1として保存します。

[CmdletBinding()]
param (
    [Parameter(Mandatory = $true)]
    [string]$tenantId,
    [Parameter(Mandatory = $true)]
    [string]$appId,
    [Parameter(Mandatory = $true)]
    [String]$certPath,
    [Parameter(Mandatory = $true)]
    [string]$caseId,
    [Parameter(Mandatory = $true)]
    [string]$exportId,
    [Parameter(Mandatory = $true)]
    [string]$path = "D:\Temp",
    [ValidateSet($null, 'USGov', 'USGovDoD')]
    [string]$environment = $null
)

if (-not(Get-Module -Name Microsoft.Graph -ListAvailable)) {
    Write-Host "Installing Microsoft.Graph module"
    Install-Module Microsoft.Graph -Scope CurrentUser
}

if (-not(Get-Module -Name MSAL.PS -ListAvailable)) {
    Write-Host "Installing MSAL.PS module"
    Install-Module MSAL.PS -Scope CurrentUser
}

##$password = ConvertTo-SecureString $appSecret -AsPlainText -Force
##$clientSecretCred = New-Object System.Management.Automation.PSCredential -ArgumentList ($appId, $password)

$ClientCert = Get-ChildItem $certPath

if (-not(Get-MgContext)) {
    Write-Host "Connect with credentials of a ediscovery admin (token for graph)"
    if (-not($environment)) {
        Connect-MgGraph -TenantId $TenantId -ClientId $appId -Certificate $ClientCert
    }
    else {
        Connect-MgGraph -TenantId $TenantId -ClientId $appId -Certificate $ClientCert -Environment $environment
    }
}

Write-Host "Connect with credentials of a ediscovery admin (token for export)"

$connectionDetails = @{
    'TenantId'          = $tenantId
    'ClientId'          = $appID
    'ClientCertificate' = $ClientCert
    'Scope' = "00001111-aaaa-2222-bbbb-3333cccc4444/.default"
}

$exportToken = Get-MsalToken @connectionDetails

$uri = "/v1.0/security/cases/ediscoveryCases/$($caseId)/operations/$($exportId)"

$export = Invoke-MgGraphRequest -Uri $uri;
if (-not($export)){
    Write-Host "Export not found"
    exit
}
else{
    $export.exportFileMetadata | % {
        Write-Host "Downloading $($_.fileName)"
        Invoke-WebRequest -Uri $_.downloadUrl -OutFile "$($path)\$($_.fileName)" -Headers @{"Authorization" = "Bearer $($exportToken.AccessToken)"; "X-AllowWithAADToken" = "true" }
    }
}

スクリプトを保存するときに、次の PowerShell モジュールがインストールされている新しい PowerShell ウィンドウを開きます。

Microsoft.Graph
MSAL.PS

スクリプトを保存したディレクトリを参照し、次のコマンドを実行します。

.\DownloadExportUsingAppCert.ps1 -tenantId “<tenant ID>” -appId “<App ID>” -certPath “<Certificate Path>” -caseId “<CaseID>” -exportId “<ExportID>” -path “<Output Path>”

パスとして指定したフォルダーを確認して、ダウンロードしたファイルを表示します。

フィードバック

このページはお役に立ちましたか?

Last updated on 2026-05-06

電子情報開示に Microsoft Purview API を使用する

Microsoft Purview API

データへのアプリケーション アクセス

Microsoft Graph API

Microsoft Graph APIの前提条件

アプリ専用アクセスを使用して Microsoft Graph APIに接続する

クライアント シークレットを使用した接続

証明書を使用した接続

Microsoft Graph API 呼び出しを呼び出す

Microsoft Purview eDiscovery API

Microsoft Purview eDiscovery API の前提条件

構成の手順

手順 1: MicrosoftPurviewEDiscovery アプリをMicrosoft Entra IDに登録する

手順 2: 登録されているアプリに追加の MicrosoftPurviewEDiscovery アクセス許可を割り当てる

エクスポート パッケージとレポートのダウンロード

ケース ID とエクスポート ジョブ ID の取得

エクスポート パッケージのダウンロード

エクスポート パッケージのダウンロード URL の取得

エクスポート パッケージをダウンロードするためのスクリプトの例

クライアント シークレットとの接続

証明書を使用した接続

フィードバック

その他のリソース

データへのアプリケーションアクセス

クライアントシークレットを使用した接続

エクスポートパッケージとレポートのダウンロード

ケース ID とエクスポートジョブ ID の取得

エクスポートパッケージのダウンロード

エクスポートパッケージのダウンロード URL の取得

エクスポートパッケージをダウンロードするためのスクリプトの例

クライアントシークレットとの接続