Java を使用して BLOB を削除して復元する

[アーティクル]
09/03/2024

この記事では、Java 用の Azure Storage クライアントライブラリを使用して BLOB を削除する方法と、保持期間中に論理的に削除された BLOB を復元する方法について説明します。

前提条件

Azure サブスクリプション - 無料アカウントを作成する
Azure Storage アカウント - ストレージアカウントの作成
Java Development Kit (JDK) バージョン 8 以降 (最適なエクスペリエンスを得るために、バージョン 17 をお勧めします)
この例では、Apache Maven をプロジェクト管理に使用します

環境を設定する

既存のプロジェクトがない場合、Java 用 Azure Blob Storage クライアントライブラリを操作するためにプロジェクトをセットアップする方法について、このセクションで説明します。詳細については、「Azure Blob Storage と Java での作業開始」を参照してください。

この記事のコード例を使用するには、次の手順に従ってプロジェクトを設定します。

Note

この記事では Maven ビルドツールを使用して、コード例をビルドして実行します。 Gradle などの他のビルドツールも、Azure SDK for Java で動作します。

パッケージをインストールする

テキストエディターで pom.xml ファイルを開きます。 BOM ファイルを含めるか、直接依存関係を含めることで、パッケージをインストールします。

import ステートメントを追加する

次の import ステートメントを追加します。

import com.azure.core.http.rest.*;
import com.azure.core.util.*;
import com.azure.storage.blob.*;
import com.azure.storage.blob.models.*;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

承認

認可メカニズムには、BLOB の削除、または論理的に削除された BLOB の復元のために必要なアクセス許可が必要です。 Microsoft Entra ID を使用した認可 (推奨) には、Azure RBAC 組み込みロールのストレージ BLOB データ共同作成者以上が必要です。詳しくは、「Delete Blob (REST API)」と「Undelete Blob (REST API)」の認可のガイダンスを参照してください。

クライアントオブジェクトの作成

アプリを Blob Storage に接続するには、 BlobServiceClientのインスタンスを作成します。

次の例では、BlobServiceClientBuilder を使用し、DefaultAzureCredential を使用して BlobServiceClient オブジェクトをビルドし、必要な場合にコンテナーおよび BLOB クライアントを作成する方法を示します。

// Azure SDK client builders accept the credential as a parameter
// TODO: Replace <storage-account-name> with your actual storage account name
BlobServiceClient blobServiceClient = new BlobServiceClientBuilder()
        .endpoint("https://<storage-account-name>.blob.core.windows.net/")
        .credential(new DefaultAzureCredentialBuilder().build())
        .buildClient();

// If needed, you can create a BlobContainerClient object from the BlobServiceClient
BlobContainerClient containerClient = blobServiceClient
        .getBlobContainerClient("<container-name>");

// If needed, you can create a BlobClient object from the BlobContainerClient
BlobClient blobClient = containerClient
        .getBlobClient("<blob-name>");

クライアントオブジェクトの作成と管理の詳細については、「データリソースを操作するクライアントオブジェクトを作成および管理する」を参照してください。

BLOB を削除する

Note

ストレージアカウントで BLOB の論理的な削除が有効になっている場合、クライアントライブラリのメソッドを使用して完全削除を実行することはできません。この記事の方法では、論理的に削除された BLOB、BLOB のバージョン、またはスナップショットは、保持期間が切れるまで使用でき、その時点になると完全に削除されます。基になる REST API 操作の詳細については、「BLOB を削除する (REST API)」を参照してください。

BLOB を削除するには、次のいずれかのメソッドを呼び出します。

次の例では、BLOB を削除します。

public void deleteBlob(BlobClient blobClient) {
    blobClient.delete();
}

BLOB にスナップショットが関連付けられている場合は、そのスナップショットをすべて削除してから BLOB を削除する必要があります。次の例では、応答を使用して BLOB とそのスナップショットを削除します。

public void deleteBlobWithSnapshots(BlobClient blobClient) {
    Response<Boolean> response = blobClient.deleteIfExistsWithResponse(DeleteSnapshotsOptionType.INCLUDE, null,
            null,
            new Context("key", "value"));
    if (response.getStatusCode() == 404) {
        System.out.println("Blob does not exist");
    } else {
        System.out.printf("Delete blob completed with status %d%n", response.getStatusCode());
    }
}

BLOB 自体ではなくスナップショットのみを削除する場合は、パラメーター DeleteSnapshotsOptionType.ONLY を渡します。

削除された BLOB を復元する

BLOB の論理的な削除を使用すると、削除されたデータがシステムに一定の期間保有されることにより、個々の BLOB とその複数バージョン、スナップショット、およびメタデータが誤った削除や上書きから保護されます。保持期間中は、BLOB を削除時の状態に復元できます。保持期間が過ぎると、BLOB オブジェクトは完全に削除されます。 BLOB の論理的な削除の詳細については、「BLOB の論理的な削除」を参照してください。

Azure Storage クライアントライブラリを使用して、論理的に削除された BLOB またはスナップショットを復元できます。

論理的に削除された BLOB を復元する方法は、ストレージアカウントで BLOB のバージョン管理が有効になっているかどうかに応じて異なります。 BLOB のバージョン管理の詳細については、「BLOB のバージョン管理」を参照してください。実際のシナリオに応じて、次のいずれかのセクションを参照してください。

BLOB のバージョン管理が有効になっていない
BLOB のバージョン管理が有効になっている

バージョン管理が無効になっている場合に論理的に削除されたオブジェクトを復元する

削除した BLOB を復元するには、次のメソッドを呼び出します。

undelete

このメソッドは、論理的に削除された BLOB と、関連付けられている論理的に削除されたスナップショットのコンテンツとメタデータを復元します。削除されていない BLOB に対してこのメソッドを呼び出しても効果はありません。

public void restoreBlob(BlobClient blobClient) {
    blobClient.undelete();
}

バージョン管理が有効になっている場合に論理的に削除されたオブジェクトを復元する

ストレージアカウントが BLOB のバージョン管理を有効にするように構成されている場合、BLOB を削除すると、BLOB の現在のバージョンが以前のバージョンになります。バージョン管理が有効になっている場合に論理的に削除された BLOB を復元するには、ベース BLOB に以前のバージョンをコピーします。次のメソッドを使用できます。

copyFromUrl

public void restoreBlobVersion(BlobContainerClient containerClient, BlobClient blobClient){
    // List blobs in this container that match the prefix
    // Include versions in the listing
    ListBlobsOptions options = new ListBlobsOptions()
            .setPrefix(blobClient.getBlobName())
            .setDetails(new BlobListDetails()
                    .setRetrieveVersions(true));
    Iterator<BlobItem> blobItem = containerClient.listBlobs(options, null).iterator();
    List<String> blobVersions = new ArrayList<>();
    while (blobItem.hasNext()) {
        blobVersions.add(blobItem.next().getVersionId());
    }

    // Sort the list of blob versions and get the most recent version ID
    Collections.sort(blobVersions, Collections.reverseOrder());
    String latestVersion = blobVersions.get(0);

    // Get a client object with the name of the deleted blob and the specified version
    BlobClient blob = containerClient.getBlobVersionClient("sampleBlob.txt", latestVersion);

    // Restore the most recent version by copying it to the base blob
    blobClient.copyFromUrl(blob.getBlobUrl());
}

論理的に削除された BLOB とディレクトリを復元する (階層型名前空間)

重要

このセクションは、階層型名前空間があるアカウントにのみ適用されます。

開始するには、テキストエディターで pom.xml ファイルを開きます。依存関係のグループに、次の dependency 要素を追加します。
```
<dependency>
  <groupId>com.azure</groupId>
  <artifactId>azure-storage-file-datalake</artifactId>
  <version>12.6.0</version>
</dependency>
```
次に、これらの import ステートメントをコードファイルに追加します。
```
Put imports here
```
次のスニペットは、my-file という名前の論理的に削除されたファイルを復元します。

この方法では、DataLakeServiceClient インスタンスが作成されていることを前提としています。 DataLakeServiceClient インスタンスを作成する方法については、「アカウントに接続する」を参照してください。
```
public void RestoreFile(DataLakeServiceClient serviceClient){

    DataLakeFileSystemClient fileSystemClient =
        serviceClient.getFileSystemClient("my-container");

    DataLakeFileClient fileClient =
        fileSystemClient.getFileClient("my-file");

    String deletionId = null;

    for (PathDeletedItem item : fileSystemClient.listDeletedPaths()) {

        if (item.getName().equals(fileClient.getFilePath())) {
           deletionId = item.getDeletionId();
        }
    }

    fileSystemClient.restorePath(fileClient.getFilePath(), deletionId);
 }
```
論理的に削除された項目が含まれているディレクトリの名前を変更すると、それらの項目はディレクトリから切断されます。それらの項目を復元するには、ディレクトリの名前を元の名前に戻すか、元のディレクトリ名を使用する別のディレクトリを作成する必要があります。そうしないと、これらの論理的に削除された項目を復元しようとしたときにエラーが発生します。

リソース

Java 用 Azure Blob Storage クライアントライブラリを使用して、BLOB を削除したり、削除済みの BLOB を復元したりする方法の詳細については、次のリソースを参照してください。

コードサンプル

この記事のコードサンプルを表示する (GitHub)

REST API の操作

Azure SDK for Java には Azure REST API に基づき構築されたライブラリが含まれるため、使い慣れた Java パラダイムを通じて REST API 操作を実施できます。 BLOB の削除および削除した BLOB の復元のためのクライアントライブラリメソッドでは、次の REST API 操作が使用されます。

Delete Blob (REST API)
Undelete Blob (REST API)

クライアントライブラリのリソース

こちらもご覧ください

この記事は、Java の Blob Storage 開発者ガイドの一部です。詳しくは、Java アプリの構築に関するセクションにある開発者ガイド記事の完全な一覧をご覧ください。

次の方法で共有

Java を使用して BLOB を削除して復元する

前提条件

環境を設定する

パッケージをインストールする

import ステートメントを追加する

承認

クライアントオブジェクトの作成

BLOB を削除する

削除された BLOB を復元する

バージョン管理が無効になっている場合に論理的に削除されたオブジェクトを復元する

バージョン管理が有効になっている場合に論理的に削除されたオブジェクトを復元する

論理的に削除された BLOB とディレクトリを復元する (階層型名前空間)

リソース

コードサンプル

REST API の操作

クライアントライブラリのリソース

こちらもご覧ください

フィードバック

その他のリソース

次の方法で共有

Java を使用して BLOB を削除して復元する

前提条件

環境を設定する

パッケージをインストールする

import ステートメントを追加する

承認

クライアント オブジェクトの作成

BLOB を削除する

削除された BLOB を復元する

バージョン管理が無効になっている場合に論理的に削除されたオブジェクトを復元する

バージョン管理が有効になっている場合に論理的に削除されたオブジェクトを復元する

論理的に削除された BLOB とディレクトリを復元する (階層型名前空間)

リソース

コード サンプル

REST API の操作

クライアント ライブラリのリソース

こちらもご覧ください

関連するコンテンツ

フィードバック

その他のリソース

クライアントオブジェクトの作成

コードサンプル

クライアントライブラリのリソース