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 のインスタンスを作成します。

プロパティ

accountName
containerName	BLOB が関連付けられているストレージコンテナーの名前。
credential	AnonymousCredential、StorageSharedKeyCredential、またはサービスへの要求を `@azure/identity` 認証するためのパッケージからの資格情報など。 TokenCredential インターフェイスを実装するオブジェクトを指定することもできます。指定しない場合は、AnonymousCredential が使用されます。
name	BLOB の名前です。
url	エンコードされた URL 文字列値。

メソッド

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	保留中の非同期 BLOB のコピー操作を中止し、転送先 BLOB の長さと完全なメタデータを残します。バージョン 2012-02-12 以降。
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	ストレージアカウント内の宛先に BLOB を非同期にコピーします。このメソッドは、コピーが完了するまで無期限に待機できる実行時間の長い操作ポーリングャーを返します。投票者でを呼び出 `cancelOperation` すことで、コピーが完了する前にコピーを取り消すこともできます。最初の要求で操作が完了し、完了したコピーを取り消そうとすると、onProgress コールバックは呼び出されないことに注意してください。エラーがスローされます。バージョン 2012-02-12 以降では、BLOB のコピー操作のソースは、任意の Azure ストレージアカウントのコミット済み BLOB にすることができます。バージョン 2015-02-21 以降では、BLOB のコピー操作のソースは、任意の Azure ストレージアカウント内の Azure ファイルにすることができます。 2012 年 6 月 7 日以降に作成されたストレージアカウントについてのみ、Copy Blob 操作による他のストレージアカウントからのコピーが許可されています。
clearPages(number, number, PageBlobClearPagesOptions)	指定したページをページ BLOB から解放します。
create(number, PageBlobCreateOptions)	指定した長さのページ BLOB を作成します。 uploadPages を呼び出して、ページ BLOB にデータデータをアップロードします。
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)	指定した長さのページ BLOB を作成します。 uploadPages を呼び出して、ページ BLOB にデータデータをアップロードします。同じ名前の BLOB が既に存在する場合、既存の BLOB の内容は変更されません。
createSnapshot(BlobCreateSnapshotOptions)	BLOB の読み取り専用のスナップショットを作成します。
delete(BlobDeleteOptions)	指定した BLOB またはスナップショットに削除のマークを付けます。 BLOB は、後でガベージコレクション中に削除されます。 BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 BLOB の削除操作を使用して、両方を同時に削除できます。
deleteIfExists(BlobDeleteOptions)	指定した BLOB またはスナップショットが存在する場合は、削除対象としてマークします。 BLOB は、後でガベージコレクション中に削除されます。 BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 BLOB の削除操作を使用して、両方を同時に削除できます。
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	BLOB の不変ポリシーを削除します。
download(number, number, BlobDownloadOptions)	メタデータとプロパティを含め、システムから BLOB を読み取るかダウンロードします。 Get Blob を呼び出してスナップショットを読み取ることもできます。 Node.jsでは、読み取り可能ストリーム readableStreamBody でデータが返されますブラウザーでは、promise blobBody でデータが返されます
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	NODE.JSランタイムでのみ使用できます。 Azure BLOB をバッファーに並列でダウンロードします。オフセットとカウントは省略可能で、指定されていない場合は BLOB 全体をダウンロードします。警告: バッファーは、32 ビットシステムでは最大約 1 ギガバイト、64 ビットシステムでは約 2 ギガバイトまでしかサポートできません。Node.js/V8 の制限があります。このサイズより大きい BLOB の場合は、を検討してください <xref:downloadToFile>。
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	NODE.JSランタイムでのみ使用できます。 Azure BLOB をバッファーに並列でダウンロードします。オフセットとカウントは省略可能で、指定されていない場合は BLOB 全体をダウンロードします。警告: バッファーは、32 ビットシステムでは最大約 1 ギガバイト、64 ビットシステムでは約 2 ギガバイトまでしかサポートできません。Node.js/V8 の制限があります。このサイズより大きい BLOB の場合は、を検討してください <xref:downloadToFile>。
downloadToFile(string, number, number, BlobDownloadOptions)	NODE.JSランタイムでのみ使用できます。 Azure BLOB をローカルファイルにダウンロードします。指定されたファイルパスが既に終了している場合、失敗します。オフセットとカウントは省略可能で、それぞれ 0 と undefined を渡して BLOB 全体をダウンロードします。
exists(BlobExistsOptions)	このクライアントによって表される Azure BLOB リソースが存在する場合は true を返します。それ以外の場合は false。注: 既存の BLOB は他のクライアントまたはアプリケーションによって削除される可能性があるため、この関数は注意して使用してください。その逆も同様に、この関数の完了後に他のクライアントまたはアプリケーションによって新しい BLOB が追加される場合があります。
generateSasUrl(BlobGenerateSasUrlOptions)	共有キー資格情報を使用して構築された BlobClient でのみ使用できます。渡されたクライアントのプロパティとパラメーターに基づいて、BLOB サービス Shared Access Signature (SAS) URI を生成します。 SAS は、クライアントの共有キー資格情報によって署名されます。
getAppendBlobClient()	AppendBlobClient オブジェクトを作成します。
getBlobLeaseClient(string)	BLOB の <xref:BlobLeaseClient> リースを管理するを取得します。
getBlockBlobClient()	BlockBlobClient オブジェクトを作成します。
getPageBlobClient()	PageBlobClient オブジェクトを作成します。
getPageRanges(number, number, PageBlobGetPageRangesOptions)	ページ BLOB またはページ BLOB のスナップショットの有効なページ範囲の一覧を返します。
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)	指定したスナップショットとこのページ BLOB の間で異なるページ範囲のコレクションを取得します。
getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)	指定したスナップショットとマネージドディスクのこのページ BLOB の間で異なるページ範囲のコレクションを取得します。
getProperties(BlobGetPropertiesOptions)	BLOB のすべてのユーザー定義メタデータ、標準 HTTP プロパティ、およびシステムプロパティを返します。 BLOB のコンテンツは返しません。
getTags(BlobGetTagsOptions)	基になる BLOB に関連付けられているタグを取得します。
resize(number, PageBlobResizeOptions)	ページ BLOB のサイズを指定したサイズに変更します (512 の倍数である必要があります)。
setAccessTier(BlockBlobTier \| PremiumPageBlobTier \| string, BlobSetTierOptions)	BLOB の層を設定します。操作は、Premium Storage アカウントのページ BLOB と BLOB ストレージアカウント内のブロック BLOB (ローカル冗長ストレージのみ) で許可されます。 Premium ページ BLOB の層によって、BLOB の許容サイズ、IOPS、帯域幅が決まります。ブロック BLOB の層によって、ホット/クール/アーカイブストレージの種類が決まります。この操作では、BLOB の ETag は更新されません。
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	BLOB のシステムプロパティを設定します。値が指定されていない場合、または指定された BLOB HTTP ヘッダーに値が指定されていない場合は、値のないこれらの BLOB HTTP ヘッダーがクリアされます。
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	BLOB に不変ポリシーを設定します。
setLegalHold(boolean, BlobSetLegalHoldOptions)	BLOB に訴訟ホールドを設定します。
setMetadata(Metadata, BlobSetMetadataOptions)	1 つまたは複数の名前と値のペアとして指定された BLOB のユーザー定義メタデータを設定します。オプションが指定されていない場合、またはパラメーターにメタデータが定義されていない場合は、BLOB メタデータが削除されます。
setTags(Tags, BlobSetTagsOptions)	基になる BLOB にタグを設定します。 BLOB には、最大 10 個のタグを含めることができます。タグキーは 1 ~ 128 文字にする必要があります。タグ値は 0 ~ 256 文字にする必要があります。有効なタグキーと値の文字には、小文字と大文字、数字 (0 から 9)、スペース (' ')、プラス ('+')、マイナス ('-')、ピリオド ('.')、スラッシュ ('/')、コロン (':')、等しい ('=')、アンダースコア ('_') が含まれます。
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)	1 つのページ BLOB のスナップショットからこのページ BLOB への増分コピーを開始する操作を開始します。スナップショットがコピーされ、前にコピーしたスナップショット間の差分変更のみが転送先に転送されます。コピーされたスナップショットは、元のスナップショットの完全なコピーであり、通常どおりの読み取りまたはコピーが可能です。
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	同期コピー元 URL 操作は、BLOB またはインターネットリソースを新しい BLOB にコピーします。コピーが完了するまで応答は返されません。
undelete(BlobUndeleteOptions)	論理的に削除された BLOB と、関連付けられている論理的に削除されたスナップショットの内容とメタデータを復元します。 BLOB の削除の取り消しは、バージョン 2017-07-29 以降でのみサポートされています。
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)	ページ BLOB のシーケンス番号を設定します。
uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)	ページ BLOB に 1 つ以上のページを書き込みます。開始オフセットと終了オフセットは、512 の倍数である必要があります。
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)	ページのアップロード操作では、URL からコンテンツが読み取られたページ BLOB にページの範囲が書き込まれます。
withSnapshot(string)	ソースと同じで、指定されたスナップショットタイムスタンプを持つ新しい PageBlobClient オブジェクトを作成します。 "" を指定すると、スナップショットが削除され、クライアントがベース 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 を指すクライアント文字列。 AnonymousCredential を使用している場合は、SAS を追加できます (例: "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString")。

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

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 パイプラインを構成するためのオプション。

プロパティの詳細

accountName

accountName: string

プロパティ値

string

containerName

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

string containerName

プロパティ値

string

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

プロパティ値

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

name

BLOB の名前です。

string name

プロパティ値

string

url

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

url: string

プロパティ値

string

メソッドの詳細

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions)

パラメーター

copyId: string

URL からのコピー操作の ID。

options: BlobAbortCopyFromURLOptions

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

戻り値

Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

ストレージアカウント内の宛先に BLOB を非同期にコピーします。このメソッドは、コピーが完了するまで無期限に待機できる実行時間の長い操作ポーリングャーを返します。投票者でを呼び出 cancelOperation すことで、コピーが完了する前にコピーを取り消すこともできます。最初の要求で操作が完了し、完了したコピーを取り消そうとすると、onProgress コールバックは呼び出されないことに注意してください。エラーがスローされます。バージョン 2012-02-12 以降では、BLOB のコピー操作のソースは、任意の Azure ストレージアカウントのコミット済み BLOB にすることができます。バージョン 2015-02-21 以降では、BLOB のコピー操作のソースは、任意の Azure ストレージアカウント内の Azure ファイルにすることができます。 2012 年 6 月 7 日以降に作成されたストレージアカウントについてのみ、Copy Blob 操作による他のストレージアカウントからのコピーが許可されています。

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions)

パラメーター

copySource: string

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

options: BlobBeginCopyFromURLOptions

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

戻り値

Promise<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

clearPages(number, number, PageBlobClearPagesOptions)

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

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions)

パラメーター

offset: number

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

count: number

クリアするバイト数。

options: PageBlobClearPagesOptions

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

戻り値

Promise<PageBlobClearPagesResponse>

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

create(number, PageBlobCreateOptions)

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

function create(size: number, options?: PageBlobCreateOptions)

パラメーター

size: number

ページ BLOB のサイズ。

options: PageBlobCreateOptions

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

戻り値

Promise<PageBlobCreateResponse>

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

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

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

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions)

パラメーター

size: number

ページ BLOB のサイズ。

options: PageBlobCreateIfNotExistsOptions

戻り値

Promise<PageBlobCreateIfNotExistsResponse>

createSnapshot(BlobCreateSnapshotOptions)

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

function createSnapshot(options?: BlobCreateSnapshotOptions)

パラメーター

options: BlobCreateSnapshotOptions

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

戻り値

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

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

function delete(options?: BlobDeleteOptions)

パラメーター

options: BlobDeleteOptions

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

戻り値

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

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

function deleteIfExists(options?: BlobDeleteOptions)

パラメーター

options: BlobDeleteOptions

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

戻り値

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

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

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

パラメーター

options: BlobDeleteImmutabilityPolicyOptions

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

戻り値

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

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

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

function download(offset?: number, count?: number, options?: BlobDownloadOptions)

パラメーター

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>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

NODE.JSランタイムでのみ使用できます。 Azure BLOB をバッファーに並列でダウンロードします。オフセットとカウントは省略可能で、指定されていない場合は BLOB 全体をダウンロードします。

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

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

パラメーター

buffer: Buffer

バッファーを塗りつぶすには、count より大きい長さを持つ必要があります

offset: number

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

count: number

ダウンロードするデータの量 (バイト単位)。未定義を渡すときに末尾にダウンロードされます

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

戻り値

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions)

パラメーター

offset: number

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

count: number

ダウンロードするデータの量 (バイト単位)。未定義を渡すときに末尾にダウンロードされます

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

戻り値

Promise<Buffer>

downloadToFile(string, number, number, BlobDownloadOptions)

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

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions)

パラメーター

filePath: string

offset: number

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

count: number

ダウンロードするデータの量。未定義を渡すときに末尾にダウンロードされます。

options: BlobDownloadOptions

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

戻り値

Promise<BlobDownloadResponseParsed>

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

exists(BlobExistsOptions)

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

function exists(options?: BlobExistsOptions)

パラメーター

options: BlobExistsOptions

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

戻り値

Promise<boolean>

generateSasUrl(BlobGenerateSasUrlOptions)

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

function generateSasUrl(options: BlobGenerateSasUrlOptions)

パラメーター

options: BlobGenerateSasUrlOptions

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

戻り値

Promise<string>

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

getAppendBlobClient()

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

function getAppendBlobClient()

戻り値

AppendBlobClient

getBlobLeaseClient(string)

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

function getBlobLeaseClient(proposeLeaseId?: string)

パラメーター

proposeLeaseId: string

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

戻り値

BlobLeaseClient

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

getBlockBlobClient()

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

function getBlockBlobClient()

戻り値

BlockBlobClient

getPageBlobClient()

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

function getPageBlobClient()

戻り値

PageBlobClient

getPageRanges(number, number, PageBlobGetPageRangesOptions)

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

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions)

パラメーター

offset: number

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

count: number

取得するバイト数。

options: PageBlobGetPageRangesOptions

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

戻り値

Promise<PageBlobGetPageRangesResponse>

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

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

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

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions)

パラメーター

offset: number

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

count: number

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

prevSnapshot: string

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

options: PageBlobGetPageRangesDiffOptions

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

戻り値

Promise<PageBlobGetPageRangesDiffResponse>

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

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

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

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions)

パラメーター

offset: number

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

count: number

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

prevSnapshotUrl: string

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

options: PageBlobGetPageRangesDiffOptions

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

戻り値

Promise<PageBlobGetPageRangesDiffResponse>

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

getProperties(BlobGetPropertiesOptions)

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

function getProperties(options?: BlobGetPropertiesOptions)

パラメーター

options: BlobGetPropertiesOptions

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

戻り値

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

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

function getTags(options?: BlobGetTagsOptions)

パラメーター

options: BlobGetTagsOptions

戻り値

Promise<BlobGetTagsResponse>

resize(number, PageBlobResizeOptions)

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

function resize(size: number, options?: PageBlobResizeOptions)

パラメーター

size: number

ターゲットサイズ

options: PageBlobResizeOptions

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

戻り値

Promise<PageBlobResizeResponse>

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

setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)

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

function setAccessTier(tier: BlockBlobTier | PremiumPageBlobTier | string, options?: BlobSetTierOptions)

パラメーター

tier: BlockBlobTier | PremiumPageBlobTier | string

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

options: BlobSetTierOptions

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

戻り値

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

BLOB のシステムプロパティを設定します。値が指定されていない場合、または指定された BLOB HTTP ヘッダーに値が指定されていない場合は、値のないこれらの BLOB HTTP ヘッダーがクリアされます。

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions)

パラメーター

blobHTTPHeaders: BlobHTTPHeaders

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

options: BlobSetHTTPHeadersOptions

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

戻り値

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

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

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions)

パラメーター

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

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

戻り値

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions)

パラメーター

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

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

戻り値

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

1 つまたは複数の名前と値のペアとして指定された BLOB のユーザー定義メタデータを設定します。オプションが指定されていない場合、またはパラメーターにメタデータが定義されていない場合は、BLOB メタデータが削除されます。

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions)

パラメーター

metadata: Metadata

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

options: BlobSetMetadataOptions

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

戻り値

Promise<BlobSetMetadataResponse>

setTags(Tags, BlobSetTagsOptions)

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

function setTags(tags: Tags, options?: BlobSetTagsOptions)

パラメーター

tags: Tags

options: BlobSetTagsOptions

戻り値

Promise<BlobSetTagsResponse>

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

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

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions)

パラメーター

copySource: string

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

options: PageBlobStartCopyIncrementalOptions

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

戻り値

Promise<PageBlobCopyIncrementalResponse>

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

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions)

パラメーター

copySource: string

コピー元の URL (認証に Shared Access Signature(SAS) が必要な場合がある)

options: BlobSyncCopyFromURLOptions

戻り値

Promise<BlobCopyFromURLResponse>

undelete(BlobUndeleteOptions)

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

function undelete(options?: BlobUndeleteOptions)

パラメーター

options: BlobUndeleteOptions

BLOB の削除取り消し操作のオプション。

戻り値

Promise<BlobUndeleteResponse>

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

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

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions)

パラメーター

sequenceNumberAction: SequenceNumberActionType

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

sequenceNumber: number

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

options: PageBlobUpdateSequenceNumberOptions

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

戻り値

Promise<PageBlobUpdateSequenceNumberResponse>

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

uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

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

function uploadPages(body: HttpRequestBody, offset: number, count: number, options?: PageBlobUploadPagesOptions)

パラメーター

body: HttpRequestBody

アップロードするデータ

offset: number

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

count: number

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

options: PageBlobUploadPagesOptions

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

戻り値

Promise<PageBlobUploadPagesResponse>

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

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

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

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions)

パラメーター

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)

パラメーター

snapshot: string

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

戻り値

PageBlobClient

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

withVersion(string)

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

function withVersion(versionId: string)

パラメーター

versionId: string

versionId。

戻り値

BlobClient

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

次の方法で共有

PageBlobClient class

コンストラクター

プロパティ

メソッド

コンストラクターの詳細

PageBlobClient(string, PipelineLike)

パラメーター

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

パラメーター

PageBlobClient(string, string, string, StoragePipelineOptions)

パラメーター

プロパティの詳細

accountName

プロパティ値

containerName

プロパティ値

credential

プロパティ値

name

プロパティ値

url

プロパティ値

メソッドの詳細

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

パラメーター

戻り値

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

パラメーター

戻り値

clearPages(number, number, PageBlobClearPagesOptions)

パラメーター

戻り値

create(number, PageBlobCreateOptions)

パラメーター

戻り値

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

パラメーター

戻り値

createSnapshot(BlobCreateSnapshotOptions)

パラメーター

戻り値

delete(BlobDeleteOptions)

パラメーター

戻り値

deleteIfExists(BlobDeleteOptions)

パラメーター

戻り値

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

パラメーター

戻り値

download(number, number, BlobDownloadOptions)

パラメーター

戻り値

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

パラメーター

戻り値

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

パラメーター

戻り値

downloadToFile(string, number, number, BlobDownloadOptions)

パラメーター

戻り値

exists(BlobExistsOptions)

パラメーター

戻り値

generateSasUrl(BlobGenerateSasUrlOptions)

パラメーター

戻り値

getAppendBlobClient()

戻り値

getBlobLeaseClient(string)

パラメーター

戻り値

getBlockBlobClient()

戻り値

getPageBlobClient()

戻り値

getPageRanges(number, number, PageBlobGetPageRangesOptions)

パラメーター