PageBlobClient class

  • リファレンス
パッケージ:
@azure/storage-blob

PageBlobClient は、ページ BLOB に適用できる一連の操作を定義します。

Extends
BlobClient

コンストラクター

PageBlobClient(string, PipelineLike)

PageBlobClient のインスタンスを作成します。
PageBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

PageBlobClient のインスタンスを作成します。 このメソッドは、BLOB を指すエンコードされた URL またはエンコードされていない URL を受け入れます。 エンコードされた URL 文字列は 2 回エスケープされません。URL パス内の特殊文字のみがエスケープされます。 BLOB 名に が含まれている場合は ? または %、BLOB 名は URL でエンコードする必要があります。
PageBlobClient(string, string, string, StoragePipelineOptions)

PageBlobClient のインスタンスを作成します。

プロパティ

containerName

BLOB が関連付けられているストレージ コンテナーの名前。
name

BLOB の名前です。

継承されたプロパティ

accountName
credential

AnonymousCredential、StorageSharedKeyCredential、またはサービスへの要求を @azure/identity 認証するためのパッケージからの資格情報など。 TokenCredential インターフェイスを実装する オブジェクトを指定することもできます。 指定しない場合は、AnonymousCredential が使用されます。
url

エンコードされた URL 文字列値。

メソッド

clearPages(number, number, PageBlobClearPagesOptions)

指定したページをページ BLOB から解放します。

「https://docs.microsoft.com/rest/api/storageservices/put-page」を参照してください。
create(number, PageBlobCreateOptions)

指定した長さのページ BLOB を作成します。 uploadPages を呼び出して、ページ BLOB にデータ データをアップロードします。

「https://docs.microsoft.com/rest/api/storageservices/put-blob」を参照してください。
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

指定した長さのページ BLOB を作成します。 uploadPages を呼び出して、ページ BLOB にデータ データをアップロードします。 同じ名前の BLOB が既に存在する場合、既存の BLOB の内容は変更されません。

「https://docs.microsoft.com/rest/api/storageservices/put-blob」を参照してください。
getPageRanges(number, number, PageBlobGetPageRangesOptions)

ページ BLOB またはページ BLOB のスナップショットの有効なページ範囲の一覧を返します。

「https://docs.microsoft.com/rest/api/storageservices/get-page-ranges」を参照してください。
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

指定したスナップショットとこのページ BLOB の間で異なるページ範囲のコレクションを取得します。

「https://docs.microsoft.com/rest/api/storageservices/get-page-ranges」を参照してください。
getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

指定したスナップショットとマネージド ディスクのこのページ BLOB の間で異なるページ範囲のコレクションを取得します。

「https://docs.microsoft.com/rest/api/storageservices/get-page-ranges」を参照してください。
listPageRanges(number, number, PageBlobListPageRangesOptions)

ページ BLOB のページ範囲の一覧を示す非同期反復可能な反復子を返します。

「https://docs.microsoft.com/rest/api/storageservices/get-page-ranges」を参照してください。

.byPage() は、ページ BLOB のページ範囲の一覧を示す非同期反復可能な反復子を返します。

構文の使用 for await 例:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

iter.next() の使用例:

let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

byPage() の使用例:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

マーカーでページングを使用する例:

let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

指定したスナップショットとこのページ BLOB の間で異なるページ範囲の一覧を示す非同期反復可能な反復子を返します。

「https://docs.microsoft.com/rest/api/storageservices/get-page-ranges」を参照してください。

.byPage() は、指定されたスナップショットとこのページ BLOB の間で異なるページ範囲のリストを非同期反復可能な反復子を返します。

構文の使用 for await 例:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

iter.next() の使用例:

let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

byPage() の使用例:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

マーカーでページングを使用する例:

let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
resize(number, PageBlobResizeOptions)

ページ BLOB のサイズを指定したサイズに変更します (512 の倍数である必要があります)。

「https://docs.microsoft.com/rest/api/storageservices/set-blob-properties」を参照してください。
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

1 つのページ BLOB のスナップショットからこのページ BLOB への増分コピーを開始する操作を開始します。 スナップショットがコピーされ、前にコピーしたスナップショット間の差分変更のみが転送先に転送されます。 コピーされたスナップショットは、元のスナップショットの完全なコピーであり、通常どおりの読み取りまたはコピーが可能です。

詳細については、以下を参照してください。https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blobhttps://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

ページ BLOB のシーケンス番号を設定します。

「https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties」を参照してください。
uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

ページ BLOB に 1 つ以上のページを書き込みます。 開始オフセットと終了オフセットは、512 の倍数である必要があります。

「https://docs.microsoft.com/rest/api/storageservices/put-page」を参照してください。
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

ページのアップロード操作では、URL からコンテンツが読み取られたページ BLOB にページの範囲が書き込まれます。

「https://docs.microsoft.com/en-us/rest/api/storageservices/put-page-from-url」を参照してください。
withSnapshot(string)

ソースと同じで、指定されたスナップショット タイムスタンプを持つ新しい PageBlobClient オブジェクトを作成します。 "" を指定すると、スナップショットが削除され、クライアントがベース BLOB に返されます。

継承されたメソッド

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

保留中の非同期コピー BLOB 操作を中止し、コピー先 BLOB の長さと完全なメタデータを残します。 バージョン 2012-02-12 以降。

「https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob」を参照してください。
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

ストレージ アカウント内のコピー先に BLOB を非同期にコピーします。 このメソッドは、コピーが完了するまで無期限に待機できる実行時間の長い操作ポーリング を返します。 また、ポーラーで を呼び出 cancelOperation して、コピーが完了する前にコピーを取り消すこともできます。 最初の要求で操作が完了し、完了したコピーを取り消そうとすると、エラーがスローされる場合、onProgress コールバックは呼び出されないことに注意してください。

バージョン 2012-02-12 以降では、BLOB のコピー操作のソースは、任意の Azure ストレージ アカウントでコミットされた BLOB にすることができます。 バージョン 2015-02-21 以降では、BLOB のコピー操作のソースは、任意の Azure ストレージ アカウント内の Azure ファイルにすることができます。 2012 年 6 月 7 日以降に作成されたストレージ アカウントについてのみ、Copy Blob 操作による他のストレージ アカウントからのコピーが許可されています。

「https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob」を参照してください。

自動ポーリングの使用例:

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

手動ポーリングの使用例:

const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
   await poller.poll();
}
const result = copyPoller.getResult();

進行状況の更新の使用例:

const copyPoller = await blobClient.beginCopyFromURL('url', {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  }
});
const result = await copyPoller.pollUntilDone();

ポーリング間隔の変更を使用する例 (既定では 15 秒):

const copyPoller = await blobClient.beginCopyFromURL('url', {
  intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();

コピーの取り消しの使用例:

const copyPoller = await blobClient.beginCopyFromURL('url');
// cancel operation after starting it.
try {
  await copyPoller.cancelOperation();
  // calls to get the result now throw PollerCancelledError
  await copyPoller.getResult();
} catch (err) {
  if (err.name === 'PollerCancelledError') {
    console.log('The copy was cancelled.');
  }
}
createSnapshot(BlobCreateSnapshotOptions)

BLOB の読み取り専用のスナップショットを作成します。

「https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob」を参照してください。
delete(BlobDeleteOptions)

指定した BLOB またはスナップショットに削除のマークを付けます。 BLOB は、後でガベージ コレクション中に削除されます。 BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 BLOB の削除操作では、両方を同時に削除できます。

「https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob」を参照してください。
deleteIfExists(BlobDeleteOptions)

指定した BLOB またはスナップショットが存在する場合は、削除のマークを付けます。 BLOB は、後でガベージ コレクション中に削除されます。 BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 BLOB の削除操作では、両方を同時に削除できます。

「https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob」を参照してください。
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

BLOB の不変ポリシーを削除します。
download(number, number, BlobDownloadOptions)

メタデータやプロパティなど、システムから BLOB を読み取りまたはダウンロードします。 また、Get BLOB を呼び出してスナップショットを読み取ることもできます。

  • Node.jsでは、読み取り可能ストリーム readableStreamBody でデータが返されます
  • ブラウザーでは、promise blobBody でデータが返されます

「https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob」を参照してください。
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

NODE.JSランタイムでのみ使用できます。

Azure BLOB をバッファーに並列でダウンロードします。 オフセットとカウントは省略可能で、指定されていない場合は BLOB 全体をダウンロードします。

警告: バッファーでサポートできるファイルは、32 ビット システムでは最大約 1 ギガバイト、64 ビット システムでは約 2 ギガバイトです。Node.js/V8 の制限があります。 このサイズより大きい BLOB の場合は、 downloadToFile を検討してください。
downloadToBuffer(number, number, BlobDownloadToBufferOptions)

NODE.JSランタイムでのみ使用できます。

Azure BLOB をバッファーに並列でダウンロードします。 オフセットとカウントは省略可能で、指定されていない場合は BLOB 全体をダウンロードします。

警告: バッファーでサポートできるファイルは、32 ビット システムでは最大約 1 ギガバイト、64 ビット システムでは約 2 ギガバイトです。Node.js/V8 の制限があります。 このサイズより大きい BLOB の場合は、 downloadToFile を検討してください。
downloadToFile(string, number, number, BlobDownloadOptions)

NODE.JSランタイムでのみ使用できます。

Azure BLOB をローカル ファイルにダウンロードします。 指定されたファイル パスが既に終了した場合、失敗します。 オフセットとカウントは省略可能です。BLOB 全体をダウンロードするには、それぞれ 0 と undefined を渡します。
exists(BlobExistsOptions)

このクライアントによって表される Azure BLOB リソースが存在する場合は true を返します。それ以外の場合は false。

注: 既存の BLOB は他のクライアントまたはアプリケーションによって削除される可能性があるため、この関数は注意して使用してください。 その逆も同様に、この関数の完了後に、他のクライアントまたはアプリケーションによって新しい BLOB が追加される可能性があります。
generateSasUrl(BlobGenerateSasUrlOptions)

共有キー資格情報を使用して構築された BlobClient でのみ使用できます。

渡されたクライアント プロパティとパラメーターに基づいて、BLOB サービス Shared Access Signature (SAS) URI を生成します。 SAS は、クライアントの共有キー資格情報によって署名されます。

「https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas」を参照してください。
getAppendBlobClient()

AppendBlobClient オブジェクトを作成します。
getBlobLeaseClient(string)

BLOB のリースを管理する BlobLeaseClient を取得します。
getBlockBlobClient()

BlockBlobClient オブジェクトを作成します。
getPageBlobClient()

PageBlobClient オブジェクトを作成します。
getProperties(BlobGetPropertiesOptions)

BLOB のすべてのユーザー定義メタデータ、標準 HTTP プロパティ、およびシステム プロパティを返します。 BLOB のコンテンツは返しません。

「https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties」を参照してください。

警告: 応答で返されるオブジェクトのキーは metadata 、最初に大文字が含まれていた場合でも小文字になります。 これは、元の大文字と小文字を保持する オプションを使用して includeMetadata BLOB を一覧表示する ContainerClient のメソッドによって返されるメタデータ キーとは異なります。
getTags(BlobGetTagsOptions)

基になる BLOB に関連付けられているタグを取得します。
setAccessTier(string, BlobSetTierOptions)

BLOB の層を設定します。 この操作は、Premium ストレージ アカウントのページ BLOB と BLOB ストレージ アカウントのブロック BLOB (ローカル冗長ストレージのみ) で許可されます。 Premium ページ BLOB の層によって、BLOB の許容サイズ、IOPS、帯域幅が決まります。 ブロック BLOB の層によって、ホット/クール/アーカイブ ストレージの種類が決まります。 この操作では、BLOB の ETag は更新されません。

「https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier」を参照してください。
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

BLOB のシステム プロパティを設定します。

値が指定されていない場合、または指定された BLOB HTTP ヘッダーに値が指定されていない場合、値のないこれらの BLOB HTTP ヘッダーはクリアされます。

「https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties」を参照してください。
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

BLOB に不変ポリシーを設定します。
setLegalHold(boolean, BlobSetLegalHoldOptions)

BLOB に訴訟ホールドを設定します。
setMetadata(Metadata, BlobSetMetadataOptions)

1 つまたは複数の名前と値のペアとして指定された BLOB のユーザー定義メタデータを設定します。

オプションが指定されていない場合、または パラメーターにメタデータが定義されていない場合は、BLOB メタデータが削除されます。

「https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata」を参照してください。
setTags(Tags, BlobSetTagsOptions)

基になる BLOB にタグを設定します。 BLOB には最大 10 個のタグを含めることができます。 タグ キーは 1 ~ 128 文字にする必要があります。 タグの値は 0 ~ 256 文字にする必要があります。 有効なタグ キーと値の文字には、小文字と大文字、数字 (0 から 9)、スペース ('')、プラス ('+')、マイナス ('-')、ピリオド ('.')、スラッシュ ('/')、コロン (':')、等しい ('=')、アンダースコア ('_') が含まれます。
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

同期コピー元 URL 操作は、BLOB またはインターネット リソースを新しい BLOB にコピーします。 コピーが完了するまで応答は返されません。

「https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url」を参照してください。
undelete(BlobUndeleteOptions)

論理的に削除された BLOB および関連付けられている論理的に削除されたスナップショットの内容とメタデータを復元します。 BLOB の削除の取り消しは、バージョン 2017-07-29 以降でのみサポートされています。

「https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob」を参照してください。
withVersion(string)

この BLOB のバージョンを指す新しい BlobClient オブジェクトを作成します。 "" を指定すると、versionId が削除され、クライアントがベース BLOB に返されます。

コンストラクターの詳細

PageBlobClient(string, PipelineLike)

PageBlobClient のインスタンスを作成します。

new PageBlobClient(url: string, pipeline: PipelineLike)

パラメーター

url

string

"; などhttps://myaccount.blob.core.windows.net/mycontainer/pageblob"、Azure Storage ページ BLOB を指す URL 文字列。 AnonymousCredential を使用している場合は、SAS を追加できます (例: "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString")。 このメソッドは、BLOB を指すエンコードされた URL またはエンコードされていない URL を受け入れます。 エンコードされた URL 文字列は 2 回エスケープされません。URL パス内の特殊文字のみがエスケープされます。 ただし、BLOB 名に が含まれている場合は 。 または %、BLOB 名は URL でエンコードする必要があります。 "my?blob%" という名前の BLOB など、URL は "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25"" である必要があります。

pipeline
PipelineLike

newPipeline() を呼び出して既定のパイプラインを作成するか、カスタマイズされたパイプラインを指定します。

PageBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

PageBlobClient のインスタンスを作成します。 このメソッドは、BLOB を指すエンコードされた URL またはエンコードされていない URL を受け入れます。 エンコードされた URL 文字列は 2 回エスケープされません。URL パス内の特殊文字のみがエスケープされます。 BLOB 名に が含まれている場合は ? または %、BLOB 名は URL でエンコードする必要があります。

new PageBlobClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

パラメーター

url

string

"https://myaccount.blob.core.windows.net/mycontainer/pageblob" など、Azure Storage ページ BLOB を指すクライアント文字列。 AnonymousCredential を使用している場合は、SAS を追加できます (例: "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString")。

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

AnonymousCredential、StorageSharedKeyCredential、またはサービスに対する要求を @azure/identity 認証するためのパッケージからの任意の資格情報など。 TokenCredential インターフェイスを実装するオブジェクトを指定することもできます。 指定しない場合は、AnonymousCredential が使用されます。

options
StoragePipelineOptions

省略可能。 HTTP パイプラインを構成するためのオプション。

PageBlobClient(string, string, string, StoragePipelineOptions)

PageBlobClient のインスタンスを作成します。

new PageBlobClient(connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)

パラメーター

connectionString

string

アカウント接続文字列または Azure ストレージ アカウントの SAS 接続文字列。 [ 注 - アカウント接続文字列は、NODE.JSランタイムでのみ使用できます。 ] アカウント接続文字列の例 -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS 接続文字列の例 - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

containerName

string

コンテナー名。

blobName

string

BLOB 名。

options
StoragePipelineOptions

省略可能。 HTTP パイプラインを構成するためのオプション。

プロパティの詳細

containerName

BLOB が関連付けられているストレージ コンテナーの名前。

string containerName

プロパティ値

string

name

BLOB の名前です。

string name

プロパティ値

string

継承されたプロパティの詳細

accountName 

accountName: string

プロパティ値

string

BlobClient.accountNameから継承

credential

AnonymousCredential、StorageSharedKeyCredential、またはサービスへの要求を @azure/identity 認証するためのパッケージからの資格情報など。 TokenCredential インターフェイスを実装する オブジェクトを指定することもできます。 指定しない場合は、AnonymousCredential が使用されます。

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

プロパティ値

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

BlobClient.credentialから継承

url

エンコードされた URL 文字列値。

url: string

プロパティ値

string

BlobClient.urlから継承

メソッドの詳細

clearPages(number, number, PageBlobClearPagesOptions)

指定したページをページ BLOB から解放します。

「https://docs.microsoft.com/rest/api/storageservices/put-page」を参照してください。

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions): Promise<PageBlobClearPagesResponse>

パラメーター

offset

number

クリアするページの開始バイト位置。

count

number

クリアするバイト数。

options
PageBlobClearPagesOptions

ページ BLOB クリア ページ操作のオプション。

戻り値

Promise<PageBlobClearPagesResponse>

ページ BLOB クリア ページ操作の応答データ。

create(number, PageBlobCreateOptions)

指定した長さのページ BLOB を作成します。 uploadPages を呼び出して、ページ BLOB にデータ データをアップロードします。

「https://docs.microsoft.com/rest/api/storageservices/put-blob」を参照してください。

function create(size: number, options?: PageBlobCreateOptions): Promise<PageBlobCreateResponse>

パラメーター

size

number

ページ BLOB のサイズ。

options
PageBlobCreateOptions

ページ BLOB の作成操作のオプション。

戻り値

Promise<PageBlobCreateResponse>

ページ BLOB 作成操作の応答データ。

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

指定した長さのページ BLOB を作成します。 uploadPages を呼び出して、ページ BLOB にデータ データをアップロードします。 同じ名前の BLOB が既に存在する場合、既存の BLOB の内容は変更されません。

「https://docs.microsoft.com/rest/api/storageservices/put-blob」を参照してください。

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions): Promise<PageBlobCreateIfNotExistsResponse>

パラメーター

size

number

ページ BLOB のサイズ。

options
PageBlobCreateIfNotExistsOptions

戻り値

Promise<PageBlobCreateIfNotExistsResponse>

getPageRanges(number, number, PageBlobGetPageRangesOptions)

ページ BLOB またはページ BLOB のスナップショットの有効なページ範囲の一覧を返します。

「https://docs.microsoft.com/rest/api/storageservices/get-page-ranges」を参照してください。

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions): Promise<PageBlobGetPageRangesResponse>

パラメーター

offset

number

ページ範囲の開始バイト位置。

count

number

取得するバイト数。

options
PageBlobGetPageRangesOptions

ページ BLOB の範囲の取得操作のオプション。

戻り値

Promise<PageBlobGetPageRangesResponse>

ページ BLOB の範囲の取得操作の応答データ。

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

指定したスナップショットとこのページ BLOB の間で異なるページ範囲のコレクションを取得します。

「https://docs.microsoft.com/rest/api/storageservices/get-page-ranges」を参照してください。

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

パラメーター

offset

number

ページ BLOB の開始バイト位置

count

number

範囲の差分を取得するバイト数。

prevSnapshot

string

差分を取得するスナップショットのタイムスタンプ。

options
PageBlobGetPageRangesDiffOptions

ページ BLOB のページ範囲の取得差分操作のオプション。

戻り値

Promise<PageBlobGetPageRangesDiffResponse>

ページ BLOB のページ範囲の差分取得操作の応答データ。

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

指定したスナップショットとマネージド ディスクのこのページ BLOB の間で異なるページ範囲のコレクションを取得します。

「https://docs.microsoft.com/rest/api/storageservices/get-page-ranges」を参照してください。

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

パラメーター

offset

number

ページ BLOB の開始バイト位置

count

number

範囲の差分を取得するバイト数。

prevSnapshotUrl

string

差分を取得するスナップショットの URL。

options
PageBlobGetPageRangesDiffOptions

ページ BLOB のページ範囲の取得差分操作のオプション。

戻り値

Promise<PageBlobGetPageRangesDiffResponse>

ページ BLOB のページ範囲の差分取得操作の応答データ。

listPageRanges(number, number, PageBlobListPageRangesOptions)

ページ BLOB のページ範囲の一覧を示す非同期反復可能な反復子を返します。

「https://docs.microsoft.com/rest/api/storageservices/get-page-ranges」を参照してください。

.byPage() は、ページ BLOB のページ範囲の一覧を示す非同期反復可能な反復子を返します。

構文の使用 for await 例:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

iter.next() の使用例:

let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

byPage() の使用例:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

マーカーでページングを使用する例:

let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

function listPageRanges(offset?: number, count?: number, options?: PageBlobListPageRangesOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

パラメーター

offset

number

ページ範囲の開始バイト位置。

count

number

取得するバイト数。

options
PageBlobListPageRangesOptions

ページ BLOB の範囲の取得操作のオプション。

戻り値

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

ページングをサポートする asyncIterableIterator。

listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

指定したスナップショットとこのページ BLOB の間で異なるページ範囲の一覧を示す非同期反復可能な反復子を返します。

「https://docs.microsoft.com/rest/api/storageservices/get-page-ranges」を参照してください。

.byPage() は、指定されたスナップショットとこのページ BLOB の間で異なるページ範囲のリストを非同期反復可能な反復子を返します。

構文の使用 for await 例:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

iter.next() の使用例:

let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

byPage() の使用例:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

マーカーでページングを使用する例:

let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

function listPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobListPageRangesDiffOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

パラメーター

offset

number

ページ範囲の開始バイト位置。

count

number

取得するバイト数。

prevSnapshot

string

差分を取得するスナップショットのタイムスタンプ。

options
PageBlobListPageRangesDiffOptions

ページ BLOB の範囲の取得操作のオプション。

戻り値

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

ページングをサポートする asyncIterableIterator。

resize(number, PageBlobResizeOptions)

ページ BLOB のサイズを指定したサイズに変更します (512 の倍数である必要があります)。

「https://docs.microsoft.com/rest/api/storageservices/set-blob-properties」を参照してください。

function resize(size: number, options?: PageBlobResizeOptions): Promise<PageBlobResizeResponse>

パラメーター

size

number

ターゲット サイズ

options
PageBlobResizeOptions

ページ BLOB のサイズ変更操作のオプション。

戻り値

Promise<PageBlobResizeResponse>

ページ BLOB のサイズ変更操作の応答データ。

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

1 つのページ BLOB のスナップショットからこのページ BLOB への増分コピーを開始する操作を開始します。 スナップショットがコピーされ、前にコピーしたスナップショット間の差分変更のみが転送先に転送されます。 コピーされたスナップショットは、元のスナップショットの完全なコピーであり、通常どおりの読み取りまたはコピーが可能です。

詳細については、以下を参照してください。https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blobhttps://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions): Promise<PageBlobCopyIncrementalResponse>

パラメーター

copySource

string

ソース ページ BLOB スナップショットの名前を指定します。 たとえば、https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot= のように指定します。

options
PageBlobStartCopyIncrementalOptions

ページ BLOB コピー増分操作のオプション。

戻り値

Promise<PageBlobCopyIncrementalResponse>

ページ BLOB コピー増分操作の応答データ。

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

ページ BLOB のシーケンス番号を設定します。

「https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties」を参照してください。

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions): Promise<PageBlobUpdateSequenceNumberResponse>

パラメーター

sequenceNumberAction
SequenceNumberActionType

サービスが BLOB のシーケンス番号を変更する方法を示します。

sequenceNumber

number

sequenceNumberAction が max または update の場合は必須

options
PageBlobUpdateSequenceNumberOptions

ページ BLOB 更新シーケンス番号操作のオプション。

戻り値

Promise<PageBlobUpdateSequenceNumberResponse>

ページ BLOB 更新シーケンス番号操作の応答データ。

uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

ページ BLOB に 1 つ以上のページを書き込みます。 開始オフセットと終了オフセットは、512 の倍数である必要があります。

「https://docs.microsoft.com/rest/api/storageservices/put-page」を参照してください。

function uploadPages(body: HttpRequestBody, offset: number, count: number, options?: PageBlobUploadPagesOptions): Promise<PageBlobUploadPagesResponse>

パラメーター

body
HttpRequestBody

アップロードするデータ

offset

number

コピー先ページ BLOB のオフセット

count

number

本文のコンテンツ長、アップロードするバイト数も

options
PageBlobUploadPagesOptions

[ページ BLOB のページのアップロード] 操作のオプション。

戻り値

Promise<PageBlobUploadPagesResponse>

ページ BLOB アップロード ページ操作の応答データ。

uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

ページのアップロード操作では、URL からコンテンツが読み取られたページ BLOB にページの範囲が書き込まれます。

「https://docs.microsoft.com/en-us/rest/api/storageservices/put-page-from-url」を参照してください。

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions): Promise<PageBlobUploadPagesFromURLResponse>

パラメーター

sourceURL

string

コピー ソースの URL を指定します。認証に必要な Shared Access Signature(SAS)

sourceOffset

number

コピー元のソース オフセット。 ソース ページ BLOB の先頭からコピーするには、0 を渡します

destOffset

number

コピー先ページ BLOB のオフセット

count

number

ソース ページ BLOB からアップロードされるバイト数

options
PageBlobUploadPagesFromURLOptions

戻り値

Promise<PageBlobUploadPagesFromURLResponse>

withSnapshot(string)

ソースと同じで、指定されたスナップショット タイムスタンプを持つ新しい PageBlobClient オブジェクトを作成します。 "" を指定すると、スナップショットが削除され、クライアントがベース BLOB に返されます。

function withSnapshot(snapshot: string): PageBlobClient

パラメーター

snapshot

string

スナップショットのタイムスタンプ。

戻り値

PageBlobClient

ソースと同じが、指定されたスナップショット タイムスタンプを持つ新しい PageBlobClient オブジェクト。

継承済みメソッドの詳細

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

保留中の非同期コピー BLOB 操作を中止し、コピー先 BLOB の長さと完全なメタデータを残します。 バージョン 2012-02-12 以降。

「https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob」を参照してください。

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>

パラメーター

copyId

string

コピー元 URL 操作の ID。

options
BlobAbortCopyFromURLOptions

BLOB Abort Copy From URL 操作のオプション。

戻り値

Promise<BlobAbortCopyFromURLResponse>

BlobClient.abortCopyFromURL から継承

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

ストレージ アカウント内のコピー先に BLOB を非同期にコピーします。 このメソッドは、コピーが完了するまで無期限に待機できる実行時間の長い操作ポーリング を返します。 また、ポーラーで を呼び出 cancelOperation して、コピーが完了する前にコピーを取り消すこともできます。 最初の要求で操作が完了し、完了したコピーを取り消そうとすると、エラーがスローされる場合、onProgress コールバックは呼び出されないことに注意してください。

バージョン 2012-02-12 以降では、BLOB のコピー操作のソースは、任意の Azure ストレージ アカウントでコミットされた BLOB にすることができます。 バージョン 2015-02-21 以降では、BLOB のコピー操作のソースは、任意の Azure ストレージ アカウント内の Azure ファイルにすることができます。 2012 年 6 月 7 日以降に作成されたストレージ アカウントについてのみ、Copy Blob 操作による他のストレージ アカウントからのコピーが許可されています。

「https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob」を参照してください。

自動ポーリングの使用例:

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

手動ポーリングの使用例:

const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
   await poller.poll();
}
const result = copyPoller.getResult();

進行状況の更新の使用例:

const copyPoller = await blobClient.beginCopyFromURL('url', {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  }
});
const result = await copyPoller.pollUntilDone();

ポーリング間隔の変更を使用する例 (既定では 15 秒):

const copyPoller = await blobClient.beginCopyFromURL('url', {
  intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();

コピーの取り消しの使用例:

const copyPoller = await blobClient.beginCopyFromURL('url');
// cancel operation after starting it.
try {
  await copyPoller.cancelOperation();
  // calls to get the result now throw PollerCancelledError
  await copyPoller.getResult();
} catch (err) {
  if (err.name === 'PollerCancelledError') {
    console.log('The copy was cancelled.');
  }
}

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions): Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

パラメーター

copySource

string

ソースの Azure Blob/File への URL。

options
BlobBeginCopyFromURLOptions

BLOB の URL からのコピー開始操作のオプション。

戻り値

Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

BlobClient.beginCopyFromURL から継承

createSnapshot(BlobCreateSnapshotOptions)

BLOB の読み取り専用のスナップショットを作成します。

「https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob」を参照してください。

function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>

パラメーター

options
BlobCreateSnapshotOptions

BLOB スナップショット作成操作のオプション。

戻り値

Promise<BlobCreateSnapshotResponse>

BlobClient.createSnapshotから継承

delete(BlobDeleteOptions)

指定した BLOB またはスナップショットに削除のマークを付けます。 BLOB は、後でガベージ コレクション中に削除されます。 BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 BLOB の削除操作では、両方を同時に削除できます。

「https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob」を参照してください。

function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>

パラメーター

options
BlobDeleteOptions

BLOB 削除操作のオプション。

戻り値

Promise<BlobDeleteResponse>

BlobClient.deleteから継承

deleteIfExists(BlobDeleteOptions)

指定した BLOB またはスナップショットが存在する場合は、削除のマークを付けます。 BLOB は、後でガベージ コレクション中に削除されます。 BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 BLOB の削除操作では、両方を同時に削除できます。

「https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob」を参照してください。

function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>

パラメーター

options
BlobDeleteOptions

BLOB 削除操作のオプション。

戻り値

Promise<BlobDeleteIfExistsResponse>

BlobClient.deleteIfExistsから継承

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

BLOB の不変ポリシーを削除します。

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>

パラメーター

options
BlobDeleteImmutabilityPolicyOptions

BLOB の不変性ポリシーを削除するオプション。

戻り値

Promise<BlobDeleteImmutabilityPolicyResponse>

BlobClient.deleteImmutabilityPolicyから継承

download(number, number, BlobDownloadOptions)

メタデータやプロパティなど、システムから BLOB を読み取りまたはダウンロードします。 また、Get BLOB を呼び出してスナップショットを読み取ることもできます。

  • Node.jsでは、読み取り可能ストリーム readableStreamBody でデータが返されます
  • ブラウザーでは、promise blobBody でデータが返されます

「https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob」を参照してください。

function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

パラメーター

offset

number

ダウンロードする BLOB の位置 (0 以上)

count

number

ダウンロードするデータの量(0 より大きい)。 未定義の場合、末尾にダウンロードされます

options
BlobDownloadOptions

BLOB ダウンロード操作のオプション。

使用例 (Node.js):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob content:", downloaded.toString());

async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}

使用例 (ブラウザー):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
  "Downloaded blob content",
  downloaded
);

async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

戻り値

Promise<BlobDownloadResponseParsed>

BlobClient.downloadから継承

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

NODE.JSランタイムでのみ使用できます。

Azure BLOB をバッファーに並列でダウンロードします。 オフセットとカウントは省略可能で、指定されていない場合は BLOB 全体をダウンロードします。

警告: バッファーでサポートできるファイルは、32 ビット システムでは最大約 1 ギガバイト、64 ビット システムでは約 2 ギガバイトです。Node.js/V8 の制限があります。 このサイズより大きい BLOB の場合は、 downloadToFile を検討してください。

function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>

パラメーター

buffer

Buffer

バッファーが埋められるには、count より大きい長さが必要です

offset

number

ダウンロードするブロック BLOB の位置 (バイト単位)

count

number

ダウンロードするデータの量 (バイト単位)。 undefined を渡すときに最後にダウンロードされます

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

戻り値

Promise<Buffer>

BlobClient.downloadToBufferから継承

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

NODE.JSランタイムでのみ使用できます。

Azure BLOB をバッファーに並列でダウンロードします。 オフセットとカウントは省略可能で、指定されていない場合は BLOB 全体をダウンロードします。

警告: バッファーでサポートできるファイルは、32 ビット システムでは最大約 1 ギガバイト、64 ビット システムでは約 2 ギガバイトです。Node.js/V8 の制限があります。 このサイズより大きい BLOB の場合は、 downloadToFile を検討してください。

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>

パラメーター

offset

number

ダウンロードするブロック BLOB の位置 (バイト単位)

count

number

ダウンロードするデータの量 (バイト単位)。 undefined を渡すときに最後にダウンロードされます

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

戻り値

Promise<Buffer>

BlobClient.downloadToBufferから継承

downloadToFile(string, number, number, BlobDownloadOptions)

NODE.JSランタイムでのみ使用できます。

Azure BLOB をローカル ファイルにダウンロードします。 指定されたファイル パスが既に終了した場合、失敗します。 オフセットとカウントは省略可能です。BLOB 全体をダウンロードするには、それぞれ 0 と undefined を渡します。

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

パラメーター

filePath

string

offset

number

ダウンロードするブロック BLOB の位置。

count

number

ダウンロードするデータの量。 undefined を渡すと、最後までダウンロードされます。

options
BlobDownloadOptions

BLOB ダウンロード オプションのオプション。

戻り値

Promise<BlobDownloadResponseParsed>

BLOB ダウンロード操作の応答データ。ただし、readableStreamBody の内容は既に読み取られ、指定されたパスのローカル ファイルに書き込まれるため、undefined に設定されています。

BlobClient.downloadToFileから継承

exists(BlobExistsOptions)

このクライアントによって表される Azure BLOB リソースが存在する場合は true を返します。それ以外の場合は false。

注: 既存の BLOB は他のクライアントまたはアプリケーションによって削除される可能性があるため、この関数は注意して使用してください。 その逆も同様に、この関数の完了後に、他のクライアントまたはアプリケーションによって新しい BLOB が追加される可能性があります。

function exists(options?: BlobExistsOptions): Promise<boolean>

パラメーター

options
BlobExistsOptions

オプションを [Exists]\(存在する\) 操作に設定します。

戻り値

Promise<boolean>

BlobClient.existsから継承

generateSasUrl(BlobGenerateSasUrlOptions)

共有キー資格情報を使用して構築された BlobClient でのみ使用できます。

渡されたクライアント プロパティとパラメーターに基づいて、BLOB サービス Shared Access Signature (SAS) URI を生成します。 SAS は、クライアントの共有キー資格情報によって署名されます。

「https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas」を参照してください。

function generateSasUrl(options: BlobGenerateSasUrlOptions): Promise<string>

パラメーター

options
BlobGenerateSasUrlOptions

省略可能なパラメーター。

戻り値

Promise<string>

このクライアントによって表されるリソースへの URI と、生成された SAS トークンで構成される SAS URI。

BlobClient.generateSasUrlから継承

getAppendBlobClient()

AppendBlobClient オブジェクトを作成します。

function getAppendBlobClient(): AppendBlobClient

戻り値

AppendBlobClient

BlobClient.getAppendBlobClientから継承

getBlobLeaseClient(string)

BLOB のリースを管理する BlobLeaseClient を取得します。

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

パラメーター

proposeLeaseId

string

最初に提案されたリース ID。

戻り値

BlobLeaseClient

BLOB のリースを管理するための新しい BlobLeaseClient オブジェクト。

BlobClient.getBlobLeaseClientから継承

getBlockBlobClient()

BlockBlobClient オブジェクトを作成します。

function getBlockBlobClient(): BlockBlobClient

戻り値

BlockBlobClient

BlobClient.getBlockBlobClientから継承

getPageBlobClient()

PageBlobClient オブジェクトを作成します。

function getPageBlobClient(): PageBlobClient

戻り値

PageBlobClient

BlobClient.getPageBlobClientから継承

getProperties(BlobGetPropertiesOptions)

BLOB のすべてのユーザー定義メタデータ、標準 HTTP プロパティ、およびシステム プロパティを返します。 BLOB のコンテンツは返しません。

「https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties」を参照してください。

警告: 応答で返されるオブジェクトのキーは metadata 、最初に大文字が含まれていた場合でも小文字になります。 これは、元の大文字と小文字を保持する オプションを使用して includeMetadata BLOB を一覧表示する ContainerClient のメソッドによって返されるメタデータ キーとは異なります。

function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>

パラメーター

options
BlobGetPropertiesOptions

プロパティの取得操作のオプション。

戻り値

Promise<BlobGetPropertiesResponse>

BlobClient.getPropertiesから継承

getTags(BlobGetTagsOptions)

基になる BLOB に関連付けられているタグを取得します。

function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>

パラメーター

options
BlobGetTagsOptions

戻り値

Promise<BlobGetTagsResponse>

BlobClient.getTagsから継承

setAccessTier(string, BlobSetTierOptions)

BLOB の層を設定します。 この操作は、Premium ストレージ アカウントのページ BLOB と BLOB ストレージ アカウントのブロック BLOB (ローカル冗長ストレージのみ) で許可されます。 Premium ページ BLOB の層によって、BLOB の許容サイズ、IOPS、帯域幅が決まります。 ブロック BLOB の層によって、ホット/クール/アーカイブ ストレージの種類が決まります。 この操作では、BLOB の ETag は更新されません。

「https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier」を参照してください。

function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>

パラメーター

tier

string

BLOB に設定する層。 有効な値は、ホット、クール、またはアーカイブです。

options
BlobSetTierOptions

BLOB セット層操作のオプション。

戻り値

Promise<BlobSetTierResponse>

BlobClient.setAccessTierから継承

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

BLOB のシステム プロパティを設定します。

値が指定されていない場合、または指定された BLOB HTTP ヘッダーに値が指定されていない場合、値のないこれらの BLOB HTTP ヘッダーはクリアされます。

「https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties」を参照してください。

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>

パラメーター

blobHTTPHeaders
BlobHTTPHeaders

値が指定されていない場合、または指定された BLOB HTTP ヘッダーに値が指定されていない場合、値のないこれらの BLOB HTTP ヘッダーはクリアされます。 設定する一般的なヘッダーは、 blobContentType ブラウザーがファイルの種類に基づいて機能を提供できるようにすることです。

options
BlobSetHTTPHeadersOptions

BLOB セット HTTP ヘッダー操作のオプション。

戻り値

Promise<BlobSetHTTPHeadersResponse>

BlobClient.set から継承HTTPHeaders

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

BLOB に不変ポリシーを設定します。

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>

パラメーター

immutabilityPolicy
BlobImmutabilityPolicy
options
BlobSetImmutabilityPolicyOptions

BLOB に不変性ポリシーを設定するためのオプション。

戻り値

Promise<BlobSetImmutabilityPolicyResponse>

BlobClient.setImmutabilityPolicyから継承

setLegalHold(boolean, BlobSetLegalHoldOptions)

BLOB に訴訟ホールドを設定します。

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>

パラメーター

legalHoldEnabled

boolean

options
BlobSetLegalHoldOptions

BLOB に訴訟ホールドを設定するためのオプション。

戻り値

Promise<BlobSetLegalHoldResponse>

BlobClient.setLegalHoldから継承

setMetadata(Metadata, BlobSetMetadataOptions)

1 つまたは複数の名前と値のペアとして指定された BLOB のユーザー定義メタデータを設定します。

オプションが指定されていない場合、または パラメーターにメタデータが定義されていない場合は、BLOB メタデータが削除されます。

「https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata」を参照してください。

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>

パラメーター

metadata
Metadata

既存のメタデータをこの値に置き換えます。 値が指定されていない場合、既存のメタデータは削除されます。

options
BlobSetMetadataOptions

メタデータの設定操作のオプション。

戻り値

Promise<BlobSetMetadataResponse>

BlobClient.setMetadataから継承

setTags(Tags, BlobSetTagsOptions)

基になる BLOB にタグを設定します。 BLOB には最大 10 個のタグを含めることができます。 タグ キーは 1 ~ 128 文字にする必要があります。 タグの値は 0 ~ 256 文字にする必要があります。 有効なタグ キーと値の文字には、小文字と大文字、数字 (0 から 9)、スペース ('')、プラス ('+')、マイナス ('-')、ピリオド ('.')、スラッシュ ('/')、コロン (':')、等しい ('=')、アンダースコア ('_') が含まれます。

function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>

パラメーター

tags
Tags
options
BlobSetTagsOptions

戻り値

Promise<BlobSetTagsResponse>

BlobClient.setTagsから継承

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

同期コピー元 URL 操作は、BLOB またはインターネット リソースを新しい BLOB にコピーします。 コピーが完了するまで応答は返されません。

「https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url」を参照してください。

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>

パラメーター

copySource

string

コピー元のソース URL(Shared Access Signature(SAS) が認証に必要な場合があります

options
BlobSyncCopyFromURLOptions

戻り値

Promise<BlobCopyFromURLResponse>

BlobClient.syncCopyFromURL から継承

undelete(BlobUndeleteOptions)

論理的に削除された BLOB および関連付けられている論理的に削除されたスナップショットの内容とメタデータを復元します。 BLOB の削除の取り消しは、バージョン 2017-07-29 以降でのみサポートされています。

「https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob」を参照してください。

function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>

パラメーター

options
BlobUndeleteOptions

Blob Undelete 操作のオプション。

戻り値

Promise<BlobUndeleteResponse>

BlobClient.undeleteから継承

withVersion(string)

この BLOB のバージョンを指す新しい BlobClient オブジェクトを作成します。 "" を指定すると、versionId が削除され、クライアントがベース BLOB に返されます。

function withVersion(versionId: string): BlobClient

パラメーター

versionId

string

versionId。

戻り値

BlobClient

この BLOB のバージョンを指す新しい BlobClient オブジェクト。

BlobClient.withVersionから継承