適用対象: 開発者
コンテナーを保持する必要があるが、アクティブにアクセスしたり、コラボレーションに使用したりする必要がなくなった場合は、SharePoint Embedded コンテナーのアーカイブを使用します。 アーカイブでは、Microsoft 365 アーカイブを使用します。これは、同じセキュリティ、コンプライアンス、および検索標準を維持しながら、ストレージ コストを削減するコールド ストレージ層です。 Microsoft 365 アーカイブの概要については、「Microsoft 365 アーカイブ」を参照してください。
重要
Microsoft 365 アーカイブは、SharePoint Embedded のプレビュー段階にあります。 アーカイブ アクションをユーザーに公開する前に、テナントの可用性、課金、API の動作を検証します。
コンテナーの種類でアーカイブを有効にする
アーカイブは、コンテナーの種類で有効にする必要があります。 既存のコンテナーの種類に SharePoint Embedded admin PowerShell を使用します。
Set-SPOContainerTypeConfiguration -ContainerTypeId <id> -IsArchiveEnabled $true
-IsArchiveEnabled $trueを渡して新しいコンテナーの種類を作成するときにアーカイブを有効にします。
New-SPOContainerType -ContainerTypeName <name> -OwningApplicationId <id> -IsArchiveEnabled $true
コンテナーの種類に対して所有しているアプリケーションと使用しているテナントが構成された後にのみ、アプリにアーカイブ コマンドを表示します。
コンテナーをアーカイブする
ターゲット コンテナーの Microsoft Graph ベータ アーカイブ アクションを呼び出します。
POST https://graph.microsoft.com/beta/storage/fileStorage/containers/{containerId}/archive
呼び出し元には、コンテナーの Owner または PrincipalOwner ロールが必要です。 グローバル管理者と SharePoint 埋め込み管理者は、すべてのコンテナーに対して操作できます。 アプリには、コンテナーに対する書き込みアクセス許可も必要です。
アーカイブされたコンテナーは、再アクティブ化されるまでアクセスできません。 アーカイブ要求を送信する前に、アップロード、バックグラウンド プロセッサ、Webhook に依存するワークフロー、対話型編集を停止します。
アーカイブされたコンテナーを取得する
通常のコンテナー取得操作を使用して、アーカイブされたコンテナーを 1 つ読み取ります。
GET https://graph.microsoft.com/beta/storage/fileStorage/containers/{containerId}
アーカイブの詳細を持つコンテナーをフィルター処理して、コンテナーの種類のアーカイブ済みコンテナーを一覧表示します。
GET https://graph.microsoft.com/beta/storage/fileStorage/containers?$filter=containerTypeId eq {containerTypeId} and archivalDetails ne null
この一覧は、ライフサイクル ビュー、管理者レポート、または再アクティブ化フローに使用します。 ユーザーがファイルを開くことができない理由をユーザーが理解できるように、アーカイブされた状態を UI に表示します。
コンテナーを再アクティブ化する
Microsoft Graph ベータ版のアーカイブ解除アクションを呼び出して、アーカイブされたコンテナーを再アクティブ化します。
POST https://graph.microsoft.com/beta/storage/fileStorage/containers/{containerId}/unarchive
再アクティブ化は、アーカイブ後の最初の 7 日間に瞬時に行われます。 7 日後、再アクティブ化には最大 24 時間かかることがあります。 コンテナーが再度アクティブであることがサービスから報告されるまで、コンテナーの読み取りおよび書き込みアクションを無効のままにします。
ライフサイクル コントロールを設計する
アーカイブ要求とアーカイブ解除要求の前に明示的なユーザー意図が必要です。 コンテナー ID、アクター、タイムスタンプ、Graph 要求の関連付けデータをアプリケーション ログに記録します。 アーカイブを削除として扱ってはいけません。保持、電子情報開示、監査、コンプライアンスの要件は、アーカイブされたデータにも適用されます。
ライフサイクル操作が失敗した場合は、呼び出し元ロール、アプリの書き込みアクセス許可、コンテナーの種類のアーカイブ設定、およびターゲット コンテナーが既に要求された状態であるかどうかをチェックします。