@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 に対する操作の集計セットを表します。
現時点では、 |
| BlobBatchClient |
BlobBatchClient を使用すると、Azure Storage Blob Service に対してバッチ処理された要求を行うことができます。 |
| BlobClient |
BlobClient は、Azure Storage BLOB への URL を表します。BLOB には、ブロック BLOB、追加 BLOB、またはページ BLOB を指定できます。 |
| BlobLeaseClient |
<xref:ContainerClient> または <xref:BlobClient>のリースを管理するクライアント。 |
| BlobSASPermissions |
NODE.JSランタイムでのみ使用できます。 これは、ServiceSAS によって BLOB に付与されるアクセス許可を表す文字列を構築するためのヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS にその操作のアクセス許可が付与されます。 すべての値が設定されたら、これを toString でシリアル化し、<xref:BlobSASSignatureValues> オブジェクトの権限フィールドとして設定する必要があります。 このクラスを使用せずにアクセス許可文字列を構築することはできますが、アクセス許可の順序は特定であり、このクラスは正確性を保証します。 |
| BlobServiceClient |
BlobServiceClient は、Blob コンテナーを操作できる Azure Storage Blob Service へのクライアントを表します。 |
| 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:AccountSASSignatureValues> 型と <xref:BlobSASSignatureValues> 型によってのみ生成されます。 生成されると、<xref:String> にエンコードして URL に直接追加できます (ただし、既存のクエリ パラメーターがある場合は注意が必要です。これらのクエリ パラメーターを追加する適切な方法に影響する可能性があります)。 注: このクラスのインスタンスは不変です。 |
| StorageBrowserPolicy |
StorageBrowserPolicy は、次のような Node.js とブラウザー ランタイムの違いを処理します。
|
| StorageBrowserPolicyFactory |
StorageBrowserPolicyFactory は、StorageBrowserPolicy オブジェクトの生成を支援するファクトリ クラスです。 |
| StorageClient |
StorageClient は、<xref:BlobServiceClient>、<xref:ContainerClient> などのベースの URL クラスを表します。 |
| StorageClientContext | |
| StorageRetryPolicy |
指数再試行と線形再試行が実装された再試行ポリシー。 |
| StorageRetryPolicyFactory |
StorageRetryPolicyFactory は、<xref:StorageRetryPolicy> オブジェクトの生成に役立つファクトリ クラスです。 |
| StorageSharedKeyCredential |
NODE.JSランタイムでのみ使用できます。 Azure Storage サービスのアカウント キー承認用の StorageSharedKeyCredential。 |
| StorageSharedKeyCredentialPolicy |
StorageSharedKeyCredentialPolicy は、共有キーを使用して HTTP 要求に署名するために使用されるポリシーです。 |
インターフェイス
| AccessPolicy |
アクセス ポリシー |
| AccountSASPermissionsLike |
アカウント SAS アクセス許可のような型。 <xref:AccountSASPermissions> で生オブジェクトからの SAS アクセス許可を解析するために使用されます。 |
| 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>から返されたポーリングャーによって使用される状態。
この状態は、コピーの進行状況が検出されるたびに、ユーザー指定の |
| 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 アクセス許可のような型。 <xref:BlobSASPermissions> で生オブジェクトからの SAS アクセス許可を解析するために使用されます。 |
| 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.uploadFile> と <xref:BlockBlobClient.uploadSeekableStream>のオプションインターフェイス。 |
| 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:BlobGenerateSasUrlOptions> と <xref:ContainerGenerateSasUrlOptions>の一般的なオプション。 |
| 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 操作を一覧表示します。 見る:
|
| ContainerProperties |
コンテナーのプロパティ |
| ContainerReleaseLeaseOptions |
コンテナーを構成するためのオプション - リース操作を解放します。 |
| ContainerRenameHeaders |
Container_rename操作のヘッダーを定義します。 |
| ContainerRenewLeaseOptions |
コンテナーを構成するためのオプション - リースの更新操作。 |
| ContainerRequestConditions |
コンテナーに対して満たす条件。 |
| ContainerSASPermissionsLike |
コンテナー SAS アクセス許可のような型。 <xref:ContainerSASPermissions> で生オブジェクトからの SAS アクセス許可を解析するために使用されます。 |
| 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 |
<xref:BlobServiceClient.findBlobsByTags> からの BLOB 情報 |
| 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:ObjectReplicationRule>の下には複数の <xref:ObjectReplicationPolicy> があります。 |
| 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 |
各サブ要求の応答を含むマルチパート/混合応答。 |
| 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.uploadFile>、<xref:BlockBlobClient.uploadStream>、および <xref:BlockBlobClient.uploadBrowserDate>の応答の種類。 |
| 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> によって返されるポーリングャーが機能するために必要な <xref:BlobClient.beginCopyFromURL> からの操作を定義します。 |
| 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 型。 |
関数
| generate |
NODE.JSランタイムでのみ使用できます。 実際の REST 要求を行うために必要なすべての SAS クエリ パラメーターを含む <xref:SASQueryParameters> オブジェクトを生成します。 |
| generate |
NODE.JSランタイムでのみ使用できます。 SASQueryParameters のインスタンスを作成します。 SAS の作成に必要な設定のみを受け入れます。 オプションの設定については、アクセス許可、startsOn、識別子など、対応するプロパティを直接設定してください。 警告: 識別子が指定されていない場合、アクセス許可と expiresOn が必要です。 このコンストラクターを最初に使用する場合は、識別子または expiresOn & アクセス許可に値を手動で割り当てる必要があります。 次のスニペットを実行する前に、必要な詳細を入力します。 使用例:
識別子の使用例:
BLOB 名の使用例:
|
| generate |
NODE.JSランタイムでのみ使用できます。 SASQueryParameters のインスタンスを作成します。 警告: ユーザー委任 SAS を生成するときに識別子は無視されます。アクセス許可と expiresOn が必要です。 使用例:
|
| is |
指定された引数がパイプライン コントラクトを満たすかどうかを判断するヘルパー |
| new |
Credential が指定された新しい Pipeline オブジェクトを作成します。 |
関数の詳細
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)
NODE.JSランタイムでのみ使用できます。 実際の REST 要求を行うために必要なすべての SAS クエリ パラメーターを含む <xref:SASQueryParameters> オブジェクトを生成します。
function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)
パラメーター
- accountSASSignatureValues
- AccountSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
戻り値
generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)
NODE.JSランタイムでのみ使用できます。 SASQueryParameters のインスタンスを作成します。
SAS の作成に必要な設定のみを受け入れます。 オプションの設定については、アクセス許可、startsOn、識別子など、対応するプロパティを直接設定してください。
警告: 識別子が指定されていない場合、アクセス許可と expiresOn が必要です。 このコンストラクターを最初に使用する場合は、識別子または 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)
Credential が指定された新しい Pipeline オブジェクトを作成します。
function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions)
パラメーター
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
AnonymousCredential、StorageSharedKeyCredential、サービスへの要求を認証するための @azure/identity パッケージの資格情報など。 TokenCredential インターフェイスを実装するオブジェクトを指定することもできます。 指定しない場合は、AnonymousCredential が使用されます。
- pipelineOptions
- StoragePipelineOptions
随意。 オプション。
戻り値
新しい Pipeline オブジェクト。