@azure/storage-blob package

クラス

AccountSASPermissions

NODE.JS ランタイムでのみ使用できます。 これは、AccountSAS によって付与されるアクセス許可を表す文字列を作成するヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS によって、その操作に対するアクセス許可が付与されます。 すべての値が設定されたら、これを toString でシリアル化し、オブジェクトのアクセス許可フィールドとして設定する <xref:AccountSASSignatureValues> 必要があります。 このクラスを使用せずにアクセス許可文字列を作成することはできますが、アクセス許可の順序は特定であり、このクラスは正確性を保証します。

AccountSASResourceTypes

NODE.JS ランタイムでのみ使用できます。 これは、AccountSAS によってアクセス可能なリソースを表す文字列を構築するためのヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS によって、そのリソースの種類へのアクセスが許可されます。 すべての値が設定されたら、これを toString でシリアル化し、オブジェクトのリソース フィールドとして設定する <xref:AccountSASSignatureValues> 必要があります。 このクラスを使用せずにリソース文字列を構築することはできますが、リソースの順序は特定であり、このクラスは正確性を保証します。

AccountSASServices

NODE.JS ランタイムでのみ使用できます。 これは、AccountSAS によってアクセス可能なサービスを表す文字列を作成するヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS によって、そのサービスへのアクセスが許可されます。 すべての値が設定されたら、これを toString でシリアル化し、オブジェクトのサービス フィールドとして設定する <xref:AccountSASSignatureValues> 必要があります。 このクラスを使用せずにサービス文字列を構築することはできますが、サービスの順序は特定であり、このクラスは正確性を保証します。

AnonymousCredential

AnonymousCredential は、AnonymousCredentialPolicy オブジェクトの作成に使用される credentialPolicyCreator メンバーを提供します。 AnonymousCredentialPolicy は、パブリック リソースを読み取る HTTP(S) 要求、または Shared Access Signature (SAS) で使用するために使用されます。

AnonymousCredentialPolicy

AnonymousCredentialPolicy は、パブリック リソースを読み取る HTTP(S) 要求、または Shared Access Signature (SAS) で使用するために使用されます。

AppendBlobClient

AppendBlobClient は、追加 BLOB に適用できる一連の操作を定義します。

BlobBatch

BlobBatch は、BLOB に対する操作の集計セットを表します。 現時点では、 と setAccessTier のみがdeleteサポートされています。

BlobBatchClient

BlobBatchClient を使用すると、Azure Storage BLOB サービスにバッチ処理された要求を行うことができます。

BlobClient

BlobClient は、Azure Storage BLOB への URL を表します。BLOB には、ブロック BLOB、追加 BLOB、またはページ BLOB を指定できます。

BlobLeaseClient

または <xref:BlobClient>のリースを<xref:ContainerClient>管理するクライアント。

BlobSASPermissions

NODE.JS ランタイムでのみ使用できます。 これは、ServiceSAS によって BLOB に付与されるアクセス許可を表す文字列を構築するためのヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS によって、その操作のアクセス許可が付与されます。 すべての値が設定されたら、これを toString でシリアル化し、オブジェクトのアクセス許可フィールドとして設定する <xref:BlobSASSignatureValues> 必要があります。 このクラスを使用せずにアクセス許可文字列を構築することはできますが、アクセス許可の順序は特定であり、このクラスは正確性を保証します。

BlobServiceClient

BlobServiceClient は、Blob コンテナーを操作できる Azure Storage BLOB サービスへのクライアントを表します。

BlockBlobClient

BlockBlobClient は、ブロック BLOB に適用できる一連の操作を定義します。

ContainerClient

ContainerClient は、その BLOB を操作できる Azure Storage コンテナーへの URL を表します。

ContainerSASPermissions

これは、ServiceSAS によってコンテナーに付与されるアクセス許可を表す文字列を作成するヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS によって、その操作に対するアクセス許可が付与されます。 すべての値が設定されたら、これを toString でシリアル化し、オブジェクトのアクセス許可フィールドとして設定する <xref:BlobSASSignatureValues> 必要があります。 このクラスを使用せずにアクセス許可文字列を作成することはできますが、アクセス許可の順序は特定であり、このクラスは正確性を保証します。

Credential

資格情報は、Azure Storage HTTP 要求署名の抽象クラスです。 このクラスは、CredentialPolicy を生成する credentialPolicyCreator ファクトリをホストします。

CredentialPolicy

送信前に HTTP(S) 要求に署名するために使用される資格情報ポリシー。 これは抽象クラスです。

PageBlobClient

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

Pipeline

HTTP 要求ポリシーを含む Pipeline クラス。 を呼び出 <xref:newPipeline>すことで、既定のパイプラインを作成できます。 または、Pipeline のコンストラクターを使用して、独自のポリシーを使用してパイプラインを作成することもできます。 カスタマイズしたパイプラインを実装する <xref:newPipeline> 前に、ポリシーと指定されたポリシーを参照してください。

SASQueryParameters

Azure Storage SAS のクエリ パラメーターを構成するコンポーネントを表します。 この型は、ユーザーによって直接構築されません。型と <xref:BlobSASSignatureValues> 型によって<xref:AccountSASSignatureValues>のみ生成されます。 生成されると、 に <xref:String> エンコードして URL に直接追加できます (ただし、既存のクエリ パラメーターがある場合は注意が必要です。これは、これらのクエリ パラメーターを追加する適切な方法に影響する可能性があります)。 注: このクラスのインスタンスは変更できません。

StorageBrowserPolicy

StorageBrowserPolicy は、Node.js とブラウザー ランタイムの違いを処理します。これには次が含まれます。

  1. ブラウザーは、"IF_MODIFIED_SINCE" などの条件付きヘッダーを追加することで、GET/HEAD 要求をキャッシュします。 StorageBrowserPolicy は、GET/HEAD 要求 URL にタイムスタンプ クエリを追加するために使用されるポリシーであるため、ブラウザー キャッシュを回避します。

  2. セキュリティのために Cookie ヘッダーを削除する

  3. ブラウザーの警告を回避するためにコンテンツ長ヘッダーを削除する

StorageBrowserPolicyFactory

StorageBrowserPolicyFactory は、StorageBrowserPolicy オブジェクトの生成を支援するファクトリ クラスです。

StorageClient

StorageClient は、 などのベースの URL クラスを<xref:BlobServiceClient><xref:ContainerClient>表します。

StorageClientContext
StorageRetryPolicy

指数再試行と線形再試行が実装された再試行ポリシー。

StorageRetryPolicyFactory

StorageRetryPolicyFactory は、オブジェクトの生成を支援する <xref:StorageRetryPolicy> ファクトリ クラスです。

StorageSharedKeyCredential

NODE.JS ランタイムでのみ使用できます。 Azure Storage サービスのアカウント キー承認用の StorageSharedKeyCredential。

StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy は、共有キーを使用して HTTP 要求に署名するために使用されるポリシーです。

インターフェイス

AccessPolicy

アクセス ポリシー

AccountSASPermissionsLike

アカウントの SAS アクセス許可のような型。 生オブジェクトから SAS アクセス許可を解析するために で <xref:AccountSASPermissions> 使用されます。

AccountSASSignatureValues

NODE.JS ランタイムでのみ使用できます。 AccountSASSignatureValues は、Azure Storage アカウントの Shared Access Signature (SAS) を生成するために使用されます。 ここでのすべての値が適切に設定されたら、 を呼び出 <xref:generateAccountSASQueryParameters> して、実際に BLOB URL に適用できる SAS の表現を取得します。 注: 前者が変更可能で論理表現であるのに対し、後者は不変であり、実際の REST 要求を生成するために使用されるため、このクラス <xref:SASQueryParameters> と は両方存在します。

AppendBlobAppendBlockFromURLOptions

操作を構成するための <xref:AppendBlobClient.appendBlockFromURL> オプション。

AppendBlobAppendBlockFromUrlHeaders

AppendBlob_appendBlockFromUrl操作のヘッダーを定義します。

AppendBlobAppendBlockHeaders

AppendBlob_appendBlock操作のヘッダーを定義します。

AppendBlobAppendBlockOptions

操作を構成するための <xref:AppendBlobClient.appendBlock> オプション。

AppendBlobCreateHeaders

AppendBlob_create操作のヘッダーを定義します。

AppendBlobCreateIfNotExistsOptions

操作を構成 <xref:AppendBlobClient.createIfNotExists> するためのオプション。

AppendBlobCreateIfNotExistsResponse

操作の応答データが <xref:appendBlobClient.createIfNotExists> 含まれます。

AppendBlobCreateOptions

操作を構成 <xref:AppendBlobClient.create> するためのオプション。

AppendBlobRequestConditions

この追加 BLOB の作成に追加する条件。

AppendBlobSealOptions

操作を構成 <xref:AppendBlobClient.seal> するためのオプション。

AppendPositionAccessConditions

パラメーター グループ

BatchSubRequest

バッチ操作に関連付けられている要求。

BatchSubResponse

バッチ操作内の 1 つの要求に関連付けられている応答データ。

BlobAbortCopyFromURLHeaders

Blob_abortCopyFromURL操作のヘッダーを定義します。

BlobAbortCopyFromURLOptions

操作を構成するための <xref:BlobClient.abortCopyFromURL> オプション。

BlobAcquireLeaseOptions

BLOB を構成するためのオプション - リース操作を取得します。

BlobBatchSubmitBatchOptionalParams

サービスを構成するためのオプション - バッチの送信オプション パラメーター。

BlobBeginCopyFromURLOptions

操作を構成するための <xref:BlobClient.beginCopyFromURL> オプション。

BlobBeginCopyFromURLResponse

操作の応答データが <xref:BlobClient.beginCopyFromURL> 含まれます。

BlobBeginCopyFromUrlPollState

から <xref:BlobClient.beginCopyFromURL>返されたポーリングャーによって使用される状態。 この状態は、コピーの進行状況が検出されるたびに、ユーザー指定のコールバックに渡されます onProgress

BlobBreakLeaseOptions

Blob - Break Lease 操作を構成するためのオプション。

BlobChangeLeaseOptions

BLOB を構成するためのオプション - リース操作の変更。

BlobCopyFromURLHeaders

Blob_copyFromURL操作のヘッダーを定義します。

BlobCreateSnapshotHeaders

Blob_createSnapshot操作のヘッダーを定義します。

BlobCreateSnapshotOptions

操作を構成するための <xref:BlobClient.createSnapshot> オプション。

BlobDeleteHeaders

Blob_delete操作のヘッダーを定義します。

BlobDeleteIfExistsResponse

操作の応答データが <xref:BlobClient.deleteIfExists> 含まれます。

BlobDeleteImmutabilityPolicyHeaders

Blob_deleteImmutabilityPolicy操作のヘッダーを定義します。

BlobDeleteImmutabilityPolicyOptions

不変ポリシー <xref:BlobClient.deleteImmutabilityPolicy> 操作を削除するためのオプション。

BlobDeleteOptions

操作を構成するための <xref:BlobClient.delete> オプション。

BlobDownloadHeaders

Blob_download操作のヘッダーを定義します。

BlobDownloadOptionalParams

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

BlobDownloadOptions

操作を構成するための <xref:BlobClient.download> オプション。

BlobDownloadResponseParsed

操作の応答データが <xref:BlobClient.download> 含まれます。

BlobDownloadToBufferOptions

操作の <xref:BlobClient.downloadToBuffer> オプション インターフェイス。

BlobExistsOptions

操作を構成するための <xref:BlobClient.exists> オプション。

BlobFlatListSegment

BlobFlatListSegment を表すインターフェイス。

BlobFlatListSegmentModel
BlobGenerateSasUrlOptions

操作を構成 <xref:BlobClient.generateSasUrl> するためのオプション。

BlobGetPropertiesHeaders

Blob_getProperties操作のヘッダーを定義します。

BlobGetPropertiesOptions

操作を構成するための <xref:BlobClient.getProperties> オプション。

BlobGetPropertiesResponse

操作の応答データが <xref:BlobClient.getProperties> 含まれます。

BlobGetTagsHeaders

Blob_getTags操作のヘッダーを定義します。

BlobGetTagsOptions

操作を構成するための <xref:BlobClient.getTags> オプション。

BlobHTTPHeaders

パラメーター グループ

BlobHierarchyListSegment

BlobHierarchyListSegment を表すインターフェイス。

BlobHierarchyListSegmentModel
BlobImmutabilityPolicy

BLOB の不変ポリシーについて説明する。

BlobItem

Azure Storage BLOB

BlobItemInternal

Azure Storage BLOB

BlobPrefix
BlobProperties

BLOB のプロパティ

BlobQueryArrowConfiguration

Apache Arrow 形式で BLOB にクエリを実行するオプション。 に対 <xref:BlockBlobQueryOptions.outputTextConfiguration>してのみ有効です。

BlobQueryArrowField

の <xref:BlobQueryArrowConfiguration>フィールドについて説明します。

BlobQueryCsvTextConfiguration

CSV 形式で BLOB にクエリを実行するオプション。

BlobQueryError

BLOB クエリのエラーの種類。

BlobQueryHeaders

Blob_query操作のヘッダーを定義します。

BlobQueryJsonTextConfiguration

JSON 形式で BLOB にクエリを実行するオプション。

BlobQueryParquetConfiguration

Parquet 形式で BLOB にクエリを実行するオプション。 に対 <xref:BlockBlobQueryOptions.inputTextConfiguration>してのみ有効です。

BlobReleaseLeaseOptions

BLOB - リリース リース操作を構成するためのオプション。

BlobRenewLeaseOptions

BLOB を構成するためのオプション - リース操作を更新します。

BlobRequestConditions

標準 HTTP 条件付きヘッダー、タグ条件、リース条件

BlobSASPermissionsLike

BLOB SAS アクセス許可のような型。 生オブジェクトからの SAS アクセス許可を解析するために で <xref:BlobSASPermissions> 使用されます。

BlobSASSignatureValues

NODE.JS ランタイムでのみ使用できます。 BlobSASSignatureValues は、コンテナーまたは BLOB の BLOB サービス SAS トークンの生成に使用されます。

BlobServiceProperties

ストレージ サービスのプロパティ。

BlobServiceStatistics

ストレージ サービスの統計。

BlobSetHTTPHeadersHeaders

Blob_setHttpHeaders操作のヘッダーを定義します。

BlobSetHTTPHeadersOptions

操作を構成するための <xref:BlobClient.setHTTPHeaders> オプション。

BlobSetImmutabilityPolicyHeaders

Blob_setImmutabilityPolicy操作のヘッダーを定義します。

BlobSetImmutabilityPolicyOptions

不変ポリシー <xref:BlobClient.setImmutabilityPolicy> 操作を設定するためのオプション。

BlobSetLegalHoldHeaders

Blob_setLegalHold操作のヘッダーを定義します。

BlobSetLegalHoldOptions

訴訟ホールド <xref:BlobClient.setLegalHold> 操作を設定するためのオプション。

BlobSetMetadataHeaders

Blob_setMetadata操作のヘッダーを定義します。

BlobSetMetadataOptions

操作を構成するための <xref:BlobClient.setMetadata> オプション。

BlobSetTagsHeaders

Blob_setTags操作のヘッダーを定義します。

BlobSetTagsOptions

操作を構成するための <xref:BlobClient.setTags> オプション。

BlobSetTierHeaders

Blob_setTier操作のヘッダーを定義します。

BlobSetTierOptions

操作を構成するための <xref:BlobClient.setAccessTier> オプション。

BlobStartCopyFromURLHeaders

Blob_startCopyFromURL操作のヘッダーを定義します。

BlobStartCopyFromURLOptions

操作を構成するための <xref:BlobClient.beginCopyFromURL> オプション。

BlobSyncCopyFromURLOptions

操作を構成するための <xref:BlobClient.syncCopyFromURL> オプション。

BlobTag
BlobTags

BLOB タグ

BlobUndeleteHeaders

Blob_undelete操作のヘッダーを定義します。

BlobUndeleteOptions

操作を構成するための <xref:BlobClient.undelete> オプション。

Block

ブロック BLOB 内の 1 つのブロックを表します。 ブロックの ID とサイズについて説明します。

BlockBlobCommitBlockListHeaders

BlockBlob_commitBlockList操作のヘッダーを定義します。

BlockBlobCommitBlockListOptions

操作を構成 <xref:BlockBlobClient.commitBlockList> するためのオプション。

BlockBlobGetBlockListHeaders

BlockBlob_getBlockList操作のヘッダーを定義します。

BlockBlobGetBlockListOptions

操作を構成 <xref:BlockBlobClient.getBlockList> するためのオプション。

BlockBlobParallelUploadOptions

と <xref:BlockBlobClient.uploadSeekableStream>の<xref:BlockBlobClient.uploadFile>オプション インターフェイス。

BlockBlobPutBlobFromUrlHeaders

BlockBlob_putBlobFromUrl操作のヘッダーを定義します。

BlockBlobQueryOptions

操作を構成 <xref:BlockBlobClient.query> するためのオプション。

BlockBlobStageBlockFromURLHeaders

BlockBlob_stageBlockFromURL操作のヘッダーを定義します。

BlockBlobStageBlockFromURLOptions

操作を構成 <xref:BlockBlobClient.stageBlockFromURL> するためのオプション。

BlockBlobStageBlockHeaders

BlockBlob_stageBlock操作のヘッダーを定義します。

BlockBlobStageBlockOptions

操作を構成 <xref:BlockBlobClient.stageBlock> するためのオプション。

BlockBlobSyncUploadFromURLOptions

操作を構成 <xref:BlockBlobClient.syncUploadFromURL> するためのオプション。

BlockBlobUploadHeaders

BlockBlob_upload操作のヘッダーを定義します。

BlockBlobUploadOptions

操作を構成 <xref:BlockBlobClient.upload> するためのオプション。

BlockBlobUploadStreamOptions

操作の <xref:BlockBlobClient.uploadStream> オプション インターフェイス。

BlockList
CommonGenerateSasUrlOptions

と <xref:ContainerGenerateSasUrlOptions>の<xref:BlobGenerateSasUrlOptions>一般的なオプション。

CommonOptions

すべてのリモート操作に共通するオプションのインターフェイス。

ContainerAcquireLeaseOptions

コンテナーを構成するためのオプション - リース操作を取得します。

ContainerBreakLeaseOptionalParams

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

ContainerBreakLeaseOptions

コンテナーを構成するためのオプション - リースの中断操作。

ContainerChangeLeaseOptions

コンテナーを構成するためのオプション - リース操作の変更。

ContainerCreateHeaders

Container_create操作のヘッダーを定義します。

ContainerCreateIfNotExistsResponse

操作の応答データが <xref:ContainerClient.createIfNotExists> 含まれます。

ContainerCreateOptions

操作を構成 <xref:ContainerClient.create> するためのオプション。

ContainerDeleteBlobOptions

操作を構成するための <xref:ContainerClient.deleteBlob> オプション。

ContainerDeleteHeaders

Container_delete操作のヘッダーを定義します。

ContainerDeleteIfExistsResponse

操作の応答データが <xref:ContainerClient.deleteIfExists> 含まれます。

ContainerDeleteMethodOptions

操作を構成 <xref:ContainerClient.delete> するためのオプション。

ContainerEncryptionScope

パラメーター グループ

ContainerExistsOptions

操作を構成 <xref:ContainerClient.exists> するためのオプション。

ContainerGenerateSasUrlOptions

操作を構成 <xref:ContainerClient.generateSasUrl> するためのオプション。

ContainerGetAccessPolicyHeaders

Container_getAccessPolicy操作のヘッダーを定義します。

ContainerGetAccessPolicyOptions

操作を構成 <xref:ContainerClient.getAccessPolicy> するためのオプション。

ContainerGetPropertiesHeaders

Container_getProperties操作のヘッダーを定義します。

ContainerGetPropertiesOptions

操作を構成 <xref:ContainerClient.getProperties> するためのオプション。

ContainerItem

Azure Storage コンテナー

ContainerListBlobFlatSegmentHeaders

Container_listBlobFlatSegment操作のヘッダーを定義します。

ContainerListBlobHierarchySegmentHeaders

Container_listBlobHierarchySegment操作のヘッダーを定義します。

ContainerListBlobsOptions

コンテナーを構成するためのオプション - BLOB 操作を一覧表示します。 参照トピック

  • <xref:ContainerClient.listBlobsFlat>
  • <xref:ContainerClient.listBlobsByHierarchy>
ContainerProperties

コンテナーのプロパティ

ContainerReleaseLeaseOptions

コンテナーを構成するためのオプション - リース操作を解放します。

ContainerRenameHeaders

Container_rename操作のヘッダーを定義します。

ContainerRenewLeaseOptions

コンテナーを構成するためのオプション - リースの更新操作。

ContainerRequestConditions

コンテナーで満たす条件。

ContainerSASPermissionsLike

コンテナー SAS アクセス許可のような型。 生オブジェクトから SAS アクセス許可を解析するために で <xref:ContainerSASPermissions> 使用されます。

ContainerSetAccessPolicyHeaders

Container_setAccessPolicy操作のヘッダーを定義します。

ContainerSetAccessPolicyOptions

操作を構成 <xref:ContainerClient.setAccessPolicy> するためのオプション。

ContainerSetMetadataHeaders

Container_setMetadata操作のヘッダーを定義します。

ContainerSetMetadataOptions

操作を構成 <xref:ContainerClient.setMetadata> するためのオプション。

ContainerUndeleteHeaders

Container_restore操作のヘッダーを定義します。

CorsRule

CORS は、あるドメインで実行されている Web アプリケーションが別のドメイン内にあるリソースにアクセスできるようにする HTTP 機能です。 Web ブラウザーは、Web ページが別のドメインの API を呼び出さないようにする、同じ配信元ポリシーと呼ばれるセキュリティ制限を実装します。CORS は、あるドメイン (配信元ドメイン) が別のドメインの API を呼び出せるようにするための安全な方法を提供します

CpkInfo

パラメーター グループ

FilterBlobItem

からの BLOB 情報 <xref:BlobServiceClient.findBlobsByTags>

FilterBlobItemModel

フィルター BLOB API 呼び出しからの BLOB 情報

FilterBlobSegment

操作の <xref:BlobServiceClient.findBlobsByTags> セグメント応答。

FilterBlobSegmentModel

フィルター BLOB API 呼び出しの結果

GeoReplication

セカンダリ ストレージ サービスの Geo-Replication 情報

HttpAuthorization

Authorization、ProxyAuthorization、WWW-Authenticate、Proxy-Authenticate のヘッダー値の認証情報を表します。

Lease

特定のリースの詳細。

LeaseAccessConditions

パラメーター グループ

LeaseOperationOptions

リース操作を構成します。

ListBlobsFlatSegmentResponse

BLOB の列挙

ListBlobsFlatSegmentResponseModel

BLOB の列挙

ListBlobsHierarchySegmentResponse

BLOB の列挙

ListBlobsHierarchySegmentResponseModel

BLOB の列挙

ListContainersSegmentResponse

コンテナーの列挙

Logging

Azure Analytics のログ設定。

MatchConditions

ETag 照合に基づいて条件付き要求の HTTP オプションを指定します。

Metadata

リソースに関連付ける名前と値のペアのマップ。

Metrics

BLOB の時間または分の集計で API 別にグループ化された要求統計の概要

ModificationConditions

変更時刻に基づいて条件付き要求の HTTP オプションを指定します。

ModifiedAccessConditions

標準の HTTP 条件付きヘッダーとタグの条件。

ModifiedAccessConditionsModel

パラメーター グループ

ObjectReplicationPolicy

オブジェクト レプリケーション ポリシー ID と のそれぞれのリスト <xref:ObjectReplicationRule>が含まれます。 これは、ソース BLOB のオブジェクト レプリケーション プロパティを取得するときに使用されます。 宛先 BLOB のポリシー ID は、それぞれのメソッド応答の ObjectReplicationDestinationPolicyId (例: ) で設定されます。 <xref:BlobProperties.ObjectReplicationDestinationPolicyId>

ObjectReplicationRule

BLOB のオブジェクト レプリケーション 規則 ID と <xref:ObjectReplicationStatus> が含まれます。 の下<xref:ObjectReplicationPolicy>に複数<xref:ObjectReplicationRule>の を指定できます。

PageBlobClearPagesHeaders

PageBlob_clearPages操作のヘッダーを定義します。

PageBlobClearPagesOptions

操作を構成するための <xref:PageBlobClient.clearPages> オプション。

PageBlobCopyIncrementalHeaders

PageBlob_copyIncremental操作のヘッダーを定義します。

PageBlobCreateHeaders

PageBlob_create操作のヘッダーを定義します。

PageBlobCreateIfNotExistsOptions

操作を構成するための <xref:PageBlobClient.createIfNotExists> オプション。

PageBlobCreateIfNotExistsResponse

操作の応答データが <xref:PageBlobClient.createIfNotExists> 含まれます。

PageBlobCreateOptions

操作を構成するための <xref:PageBlobClient.create> オプション。

PageBlobGetPageRangesDiffHeaders

PageBlob_getPageRangesDiff操作のヘッダーを定義します。

PageBlobGetPageRangesDiffOptions

操作を構成するための <xref:PageBlobClient.getRangesDiff> オプション。

PageBlobGetPageRangesDiffResponse

操作の応答データが <xref:BlobClient.getPageRangesDiff> 含まれます。

PageBlobGetPageRangesHeaders

PageBlob_getPageRanges操作のヘッダーを定義します。

PageBlobGetPageRangesOptions

操作を構成するための <xref:PageBlobClient.getPageRanges> オプション。

PageBlobGetPageRangesResponse

操作の応答データが <xref:BlobClient.getPageRanges> 含まれます。

PageBlobRequestConditions

このページ BLOB の作成に追加する条件。

PageBlobResizeHeaders

PageBlob_resize操作のヘッダーを定義します。

PageBlobResizeOptions

操作を構成 <xref:PageBlobClient.resize> するためのオプション。

PageBlobStartCopyIncrementalOptions

操作を構成 <xref:PageBlobClient.startCopyIncremental> するためのオプション。

PageBlobUpdateSequenceNumberHeaders

PageBlob_updateSequenceNumber操作のヘッダーを定義します。

PageBlobUpdateSequenceNumberOptions

操作を構成 <xref:PageBlobClient.updateSequenceNumber> するためのオプション。

PageBlobUploadPagesFromURLHeaders

PageBlob_uploadPagesFromURL操作のヘッダーを定義します。

PageBlobUploadPagesFromURLOptions

操作を構成 <xref:PageBlobClient.uploadPagesFromURL> するためのオプション。

PageBlobUploadPagesHeaders

PageBlob_uploadPages操作のヘッダーを定義します。

PageBlobUploadPagesOptions

操作を構成するための <xref:PageBlobClient.uploadPages> オプション。

PageList

BLOB のページ範囲の一覧。

ParsedBatchResponse

各サブ要求の応答を含む multipart/mixed 応答。

PipelineLike

HTTP 要求ポリシーを <xref:Pipeline> 含むクラスのインターフェイス。 を呼び出 <xref:newPipeline>すことで、既定のパイプラインを作成できます。 または、Pipeline のコンストラクターを使用して、独自のポリシーを使用してパイプラインを作成することもできます。 カスタマイズしたパイプラインを実装する <xref:newPipeline> 前に、ポリシーと指定されたポリシーを参照してください。

PipelineOptions

パイプライン コンストラクターのオプション インターフェイス。

Range

Blob Service 操作の範囲。

RetentionPolicy

関連付けられているデータを保持する期間を決定するアイテム保持ポリシー

SASQueryParametersOptions

を構築 <xref:SASQueryParameters>するためのオプション。

SasIPRange

SAS に対して許可される IP 範囲。

SequenceNumberAccessConditions

パラメーター グループ

ServiceFilterBlobsHeaders

Service_filterBlobs操作のヘッダーを定義します。

ServiceFindBlobByTagsOptions

操作を構成するための <xref:BlobServiceClient.findBlobsByTags> オプション。

ServiceGenerateAccountSasUrlOptions

操作を構成 <xref:BlobServiceClient.generateAccountSasUrl> するためのオプション。

ServiceGetAccountInfoHeaders

Service_getAccountInfo操作のヘッダーを定義します。

ServiceGetAccountInfoOptions

操作を構成するための <xref:BlobServiceClient.getAccountInfo> オプション。

ServiceGetPropertiesHeaders

Service_getProperties操作のヘッダーを定義します。

ServiceGetPropertiesOptions

操作を構成するための <xref:BlobServiceClient.getProperties> オプション。

ServiceGetStatisticsHeaders

Service_getStatistics操作のヘッダーを定義します。

ServiceGetStatisticsOptions

操作を構成するための <xref:BlobServiceClient.getStatistics> オプション。

ServiceGetUserDelegationKeyHeaders

Service_getUserDelegationKey操作のヘッダーを定義します。

ServiceGetUserDelegationKeyOptions

サービスを構成するためのオプション - ユーザー委任キーを取得します。

ServiceListContainersOptions

操作を構成するための <xref:BlobServiceClient.listContainers> オプション。

ServiceListContainersSegmentHeaders

Service_listContainersSegment操作のヘッダーを定義します。

ServiceRenameContainerOptions

操作を構成 <xref:BlobServiceClient.renameContainer> するためのオプション。

ServiceSetPropertiesHeaders

Service_setProperties操作のヘッダーを定義します。

ServiceSetPropertiesOptions

操作を構成するための <xref:BlobServiceClient.setProperties> オプション。

ServiceSubmitBatchHeaders

Service_submitBatch操作のヘッダーを定義します。

ServiceSubmitBatchOptionalParamsModel

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

ServiceUndeleteContainerOptions

操作を構成 <xref:BlobServiceClient.undeleteContainer> するためのオプション。

SignedIdentifier

署名付き識別子。

SignedIdentifierModel

署名付き識別子

StaticWebsite

アカウントが静的 Web サイトをホストできるようにするプロパティ

StorageClientOptionalParams

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

StoragePipelineOptions

関数の <xref:newPipeline> オプション インターフェイス。

StorageRetryOptions

ストレージ BLOB 再試行オプション インターフェイス。

TagConditions

BLOB タグに基づいて条件付き要求の HTTP オプションを指定します。

UserDelegationKey

ユーザー委任キー。

UserDelegationKeyModel

ユーザー委任キー

型エイリアス

AccessTier

AccessTier の値を定義します。

AccountKind

AccountKind の値を定義します。

AppendBlobAppendBlockFromUrlResponse

appendBlockFromUrl 操作の応答データを格納します。

AppendBlobAppendBlockResponse

appendBlock 操作の応答データを格納します。

AppendBlobCreateResponse

作成操作の応答データが含まれます。

ArchiveStatus

ArchiveStatus の値を定義します。

BlobAbortCopyFromURLResponse

abortCopyFromURL 操作の応答データを格納します。

BlobBatchDeleteBlobsResponse

操作の応答データが <xref:deleteBlobs> 含まれます。

BlobBatchSetBlobsAccessTierResponse

操作の応答データが <xref:setBlobsAccessTier> 含まれます。

BlobBatchSubmitBatchResponse

BLOB バッチ操作の応答データが含まれます。

BlobCopyFromURLResponse

copyFromURL 操作の応答データを格納します。

BlobCreateSnapshotResponse

createSnapshot 操作の応答データが含まれます。

BlobDeleteImmutabilityPolicyResponse

deleteImmutabilityPolicy 操作の応答データを格納します。

BlobDeleteResponse

削除操作の応答データが含まれます。

BlobDownloadResponseModel

ダウンロード操作の応答データが含まれます。

BlobGetPropertiesResponseModel

getProperties 操作の応答データが含まれます。

BlobGetTagsResponse

操作の応答データが <xref:BlobClient.getTags> 含まれます。

BlobImmutabilityPolicyMode

BlobImmutabilityPolicyMode の値を定義します。

BlobQueryArrowFieldType

の <xref:BlobQueryArrowField>型。

BlobQueryResponseModel

クエリ操作の応答データが含まれます。

BlobSetHTTPHeadersResponse

setHttpHeaders 操作の応答データが含まれます。

BlobSetImmutabilityPolicyResponse

setImmutabilityPolicy 操作の応答データが含まれます。

BlobSetLegalHoldResponse

setLegalHold 操作の応答データを格納します。

BlobSetMetadataResponse

setMetadata 操作の応答データが含まれます。

BlobSetTagsResponse

setTags 操作の応答データが含まれます。

BlobSetTierResponse

setTier 操作の応答データが含まれます。

BlobStartCopyFromURLResponse

startCopyFromURL 操作の応答データが含まれます。

BlobType

BlobType の値を定義します。

BlobUndeleteResponse

削除取り消し操作の応答データが含まれます。

BlobUploadCommonResponse

、<xref:BlockBlobClient.uploadStream>、および <xref:BlockBlobClient.uploadBrowserDate>の応答の<xref:BlockBlobClient.uploadFile>種類。

BlockBlobCommitBlockListResponse

commitBlockList 操作の応答データが含まれます。

BlockBlobGetBlockListResponse

getBlockList 操作の応答データが含まれます。

BlockBlobPutBlobFromUrlResponse

putBlobFromUrl 操作の応答データが含まれます。

BlockBlobStageBlockFromURLResponse

stageBlockFromURL 操作の応答データが含まれます。

BlockBlobStageBlockResponse

stageBlock 操作の応答データが含まれます。

BlockBlobUploadResponse

アップロード操作の応答データが含まれます。

BlockListType

BlockListType の値を定義します。

ContainerCreateResponse

作成操作の応答データが含まれます。

ContainerDeleteResponse

削除操作の応答データが含まれます。

ContainerGetAccessPolicyResponse

操作の応答データが <xref:ContainerClient.getAccessPolicy> 含まれます。

ContainerGetPropertiesResponse

getProperties 操作の応答データを格納します。

ContainerListBlobFlatSegmentResponse

listBlobFlatSegment 操作の応答データを格納します。

ContainerListBlobHierarchySegmentResponse

listBlobHierarchySegment 操作の応答データを格納します。

ContainerRenameResponse

名前変更操作の応答データが含まれます。

ContainerSetAccessPolicyResponse

setAccessPolicy 操作の応答データを格納します。

ContainerSetMetadataResponse

setMetadata 操作の応答データを格納します。

ContainerUndeleteResponse

復元操作の応答データが含まれます。

CopyPollerBlobClient

によって<xref:BlobClient.beginCopyFromURL>返されるポーリングプログラムが機能するために必要な から<xref:BlobClient>操作を定義します。

CopyStatusType

CopyStatusType の値を定義します。

CredentialPolicyCreator

指定された nextPolicy を使用する新しい CredentialPolicy を作成するファクトリ関数。

DeleteSnapshotsOptionType

DeleteSnapshotsOptionType の値を定義します。

EncryptionAlgorithmType

EncryptionAlgorithmType の値を定義します。

GeoReplicationStatusType

GeoReplicationStatusType の値を定義します。

LeaseDurationType

LeaseDurationType の値を定義します。

LeaseOperationResponse

リースを作成、変更、または削除する操作の応答データを格納します。 「<xref:BlobLeaseClient>」を参照してください。

LeaseStateType

LeaseStateType の値を定義します。

LeaseStatusType

LeaseStatusType の値を定義します。

ListBlobsIncludeItem

ListBlobsIncludeItem の値を定義します。

ListContainersIncludeType

ListContainersIncludeType の値を定義します。

ObjectReplicationStatus

BLOB のレプリケーションの状態を指定します。 これは、ストレージ アカウントにオブジェクト レプリケーション ポリシーが適用されている場合に使用されます。 <xref:ObjectReplicationPolicy> と <xref:ObjectReplicationRule> を参照してください。

PageBlobClearPagesResponse

clearPages 操作の応答データを格納します。

PageBlobCopyIncrementalResponse

copyIncremental 操作の応答データを格納します。

PageBlobCreateResponse

作成操作の応答データが含まれます。

PageBlobResizeResponse

サイズ変更操作の応答データが含まれます。

PageBlobUpdateSequenceNumberResponse

updateSequenceNumber 操作の応答データを格納します。

PageBlobUploadPagesFromURLResponse

uploadPagesFromURL 操作の応答データを格納します。

PageBlobUploadPagesResponse

uploadPages 操作の応答データを格納します。

PublicAccessType

PublicAccessType の値を定義します。

RehydratePriority

RehydratePriority の値を定義します。

SequenceNumberActionType

SequenceNumberActionType の値を定義します。

ServiceFindBlobsByTagsSegmentResponse

操作の <xref:BlobServiceClient.findBlobsByTags> 応答。

ServiceGetAccountInfoResponse

getAccountInfo 操作の応答データを格納します。

ServiceGetPropertiesResponse

getProperties 操作の応答データを格納します。

ServiceGetStatisticsResponse

getStatistics 操作の応答データを格納します。

ServiceGetUserDelegationKeyResponse

操作の応答データが <xref:getUserDelegationKey> 含まれます。

ServiceListContainersSegmentResponse

listContainersSegment 操作の応答データを格納します。

ServiceSetPropertiesResponse

setProperties 操作の応答データを格納します。

ServiceSubmitBatchResponseModel

submitBatch 操作の応答データを格納します。

SkuName

SkuName の値を定義します。

SyncCopyStatusType

SyncCopyStatusType の値を定義します。

Tags

BLOB タグ。

列挙型

BlockBlobTier

BLOB のアクセス層を表します。 ブロック BLOB レベルの階層化の詳細については、「ホット、クール、アーカイブのストレージ層」を参照してください。

PremiumPageBlobTier

BLOB を設定するページ BLOB 層を指定します。 これは、Premium Storage アカウントのページ BLOB にのみ適用されます。 PageBlobTier ごとの対応する IOPS とスループットの詳細については、 こちらを 参照してください。

SASProtocol

生成された SAS のプロトコル。

StorageRetryPolicyType

RetryPolicy 型。

機能

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

NODE.JS ランタイムでのみ使用できます。 実際の REST 要求を <xref:SASQueryParameters> 行うために必要なすべての SAS クエリ パラメーターを含む オブジェクトを生成します。

generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)

NODE.JS ランタイムでのみ使用できます。 SASQueryParameters のインスタンスを作成します。

SAS の作成に必要な設定のみを受け入れます。 オプションの設定については、アクセス許可、startsOn、identifier などの対応するプロパティを直接設定してください。

警告: 識別子が指定されていない場合は、アクセス許可と expiresOn が必要です。 このコンストラクターを最初に使用する場合は、値を identifier または expiresOn & アクセス許可に手動で割り当てる必要があります。

次のスニペットを実行する前に、必要な詳細を入力します。

使用例:

// Generate service level SAS for a container
const containerSAS = generateBlobSASQueryParameters({
    containerName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

識別子の使用例:

// Generate service level SAS for a container with identifier
// startsOn & permissions are optional when identifier is provided
const identifier = "unique-id";
await containerClient.setAccessPolicy(undefined, [
  {
    accessPolicy: {
      expiresOn: new Date(new Date().valueOf() + 86400), // Date type
      permissions: ContainerSASPermissions.parse("racwdl").toString(),
      startsOn: new Date() // Date type
    },
    id: identifier
  }
]);

const containerSAS = generateBlobSASQueryParameters(
  {
    containerName, // Required
    identifier // Required
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

BLOB 名の使用例:

// Generate service level SAS for a blob
const blobSAS = generateBlobSASQueryParameters({
    containerName, // Required
    blobName, // Required
    permissions: BlobSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();
generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)

NODE.JS ランタイムでのみ使用できます。 SASQueryParameters のインスタンスを作成します。 警告: ユーザー委任 SAS を生成する場合、識別子は無視されます。アクセス許可と expiresOn が必要です。

使用例:

// Generate user delegation SAS for a container
const userDelegationKey = await blobServiceClient.getUserDelegationKey(startsOn, expiresOn);
const containerSAS = generateBlobSASQueryParameters({
    containerName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn, // Optional. Date type
    expiresOn, // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();
isPipelineLike(unknown)

指定された引数がパイプライン コントラクトを満たすかどうかを判断するヘルパー

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

資格情報が指定された新しい Pipeline オブジェクトを作成します。

関数の詳細

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

NODE.JS ランタイムでのみ使用できます。 実際の REST 要求を <xref:SASQueryParameters> 行うために必要なすべての SAS クエリ パラメーターを含む オブジェクトを生成します。

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

パラメーター

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

戻り値

generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)

NODE.JS ランタイムでのみ使用できます。 SASQueryParameters のインスタンスを作成します。

SAS の作成に必要な設定のみを受け入れます。 オプションの設定については、アクセス許可、startsOn、identifier などの対応するプロパティを直接設定してください。

警告: 識別子が指定されていない場合は、アクセス許可と expiresOn が必要です。 このコンストラクターを最初に使用する場合は、値を identifier または expiresOn & アクセス許可に手動で割り当てる必要があります。

次のスニペットを実行する前に、必要な詳細を入力します。

使用例:

// Generate service level SAS for a container
const containerSAS = generateBlobSASQueryParameters({
    containerName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

識別子の使用例:

// Generate service level SAS for a container with identifier
// startsOn & permissions are optional when identifier is provided
const identifier = "unique-id";
await containerClient.setAccessPolicy(undefined, [
  {
    accessPolicy: {
      expiresOn: new Date(new Date().valueOf() + 86400), // Date type
      permissions: ContainerSASPermissions.parse("racwdl").toString(),
      startsOn: new Date() // Date type
    },
    id: identifier
  }
]);

const containerSAS = generateBlobSASQueryParameters(
  {
    containerName, // Required
    identifier // Required
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

BLOB 名の使用例:

// Generate service level SAS for a blob
const blobSAS = generateBlobSASQueryParameters({
    containerName, // Required
    blobName, // Required
    permissions: BlobSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();
function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

パラメーター

blobSASSignatureValues
BlobSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

戻り値

generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)

NODE.JS ランタイムでのみ使用できます。 SASQueryParameters のインスタンスを作成します。 警告: ユーザー委任 SAS を生成する場合、識別子は無視されます。アクセス許可と expiresOn が必要です。

使用例:

// Generate user delegation SAS for a container
const userDelegationKey = await blobServiceClient.getUserDelegationKey(startsOn, expiresOn);
const containerSAS = generateBlobSASQueryParameters({
    containerName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn, // Optional. Date type
    expiresOn, // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();
function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string)

パラメーター

blobSASSignatureValues
BlobSASSignatureValues
userDelegationKey
UserDelegationKey

の戻り値 blobServiceClient.getUserDelegationKey()

accountName

string

戻り値

isPipelineLike(unknown)

指定された引数がパイプライン コントラクトを満たすかどうかを判断するヘルパー

function isPipelineLike(pipeline: unknown)

パラメーター

pipeline

unknown

パイプラインである可能性がある引数

戻り値

boolean

引数がパイプライン コントラクトを満たす場合は true

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

資格情報が指定された新しい Pipeline オブジェクトを作成します。

function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions)

パラメーター

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

pipelineOptions
StoragePipelineOptions

省略可能。 オプション。

戻り値

新しい Pipeline オブジェクト。