@azure/storage-blob package

クラス

AccountSASPermissions	NODE.JSランタイムでのみ使用できます。 これは、AccountSAS によって付与されるアクセス許可を表す文字列を構築するためのヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS にその操作のアクセス許可が付与されます。 すべての値が設定されたら、これを toString でシリアル化し、AccountSASSignatureValues オブジェクトのアクセス許可フィールドとして設定する必要があります。 このクラスを使用せずにアクセス許可文字列を構築することはできますが、アクセス許可の順序は特定であり、このクラスは正確性を保証します。
AccountSASResourceTypes	NODE.JSランタイムでのみ使用できます。 これは、AccountSAS によってアクセス可能なリソースを表す文字列を構築するためのヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS によって、そのリソースの種類へのアクセスが許可されます。 すべての値が設定されたら、これを toString でシリアル化し、AccountSASSignatureValues オブジェクトのリソース フィールドとして設定する必要があります。 このクラスを使用せずにリソース文字列を構築することはできますが、リソースの順序は特定であり、このクラスは正確性を保証します。
AccountSASServices	NODE.JSランタイムでのみ使用できます。 これは、AccountSAS によってアクセス可能なサービスを表す文字列を構築するためのヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS によって、そのサービスへのアクセスが許可されます。 すべての値が設定されたら、これを toString でシリアル化し、AccountSASSignatureValues オブジェクトのサービス フィールドとして設定する必要があります。 このクラスを使用せずにサービス文字列を構築することはできますが、サービスの順序は特定であり、このクラスは正確性を保証します。
AnonymousCredential	AnonymousCredential は、AnonymousCredentialPolicy オブジェクトの作成に使用される credentialPolicyCreator メンバーを提供します。 AnonymousCredentialPolicy は、パブリック リソースを読み取る HTTP(S) 要求または Shared Access Signature (SAS) で使用する要求で使用されます。
AnonymousCredentialPolicy	AnonymousCredentialPolicy は、パブリック リソースを読み取る HTTP(S) 要求または Shared Access Signature (SAS) で使用する要求で使用されます。
AppendBlobClient	AppendBlobClient は、追加 BLOB に適用できる一連の操作を定義します。
BaseRequestPolicy	すべての要求ポリシーの派生元となる基本クラス。
BlobBatch	BlobBatch は、BLOB に対する操作の集計セットを表します。 現時点では、delete と setAccessTier のみがサポートされています。
BlobBatchClient	BlobBatchClient を使用すると、Azure Storage Blob Service に対してバッチ処理された要求を行うことができます。 https://learn.microsoft.com/rest/api/storageservices/blob-batch を参照してください
BlobClient	BlobClient は、Azure Storage BLOB への URL を表します。BLOB には、ブロック BLOB、追加 BLOB、またはページ BLOB を指定できます。
BlobLeaseClient	ContainerClient または BlobClientのリースを管理するクライアント。
BlobSASPermissions	NODE.JSランタイムでのみ使用できます。 これは、ServiceSAS によって BLOB に付与されるアクセス許可を表す文字列を構築するためのヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS にその操作のアクセス許可が付与されます。 すべての値が設定されたら、これを toString でシリアル化し、BlobSASSignatureValues オブジェクトのアクセス許可フィールドとして設定する必要があります。 このクラスを使用せずにアクセス許可文字列を構築することはできますが、アクセス許可の順序は特定であり、このクラスは正確性を保証します。
BlobServiceClient	BlobServiceClient は、Blob コンテナーを操作できる Azure Storage Blob Service へのクライアントを表します。
BlockBlobClient	BlockBlobClient は、ブロック BLOB に適用できる一連の操作を定義します。
ContainerClient	ContainerClient は、その BLOB を操作できる Azure Storage コンテナーへの URL を表します。
ContainerSASPermissions	これは、ServiceSAS によってコンテナーに付与されるアクセス許可を表す文字列を構築するためのヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS にその操作のアクセス許可が付与されます。 すべての値が設定されたら、これを toString でシリアル化し、BlobSASSignatureValues オブジェクトのアクセス許可フィールドとして設定する必要があります。 このクラスを使用せずにアクセス許可文字列を構築することはできますが、アクセス許可の順序は特定であり、このクラスは正確性を保証します。
Credential	資格情報は、Azure Storage HTTP 要求の署名のための抽象クラスです。 このクラスは、CredentialPolicy を生成する credentialPolicyCreator ファクトリをホストします。
CredentialPolicy	送信前に HTTP(S) 要求に署名するために使用される資格情報ポリシー。 これは抽象クラスです。
PageBlobClient	PageBlobClient は、ページ BLOB に適用できる一連の操作を定義します。
Pipeline	HTTP 要求ポリシーを含む Pipeline クラス。 newPipeline 呼び出すことで、既定のパイプラインを作成できます。 または、Pipeline のコンストラクターによって独自のポリシーを使用してパイプラインを作成することもできます。 カスタマイズしたパイプライン 実装する前に、newPipeline と指定されたポリシーを参照してください。
SASQueryParameters	Azure Storage SAS のクエリ パラメーターを構成するコンポーネントを表します。 この型は、ユーザーによって直接構築されるわけではありません。これは、AccountSASSignatureValues および blobSASSignatureValues 型 によってのみ生成されます。 生成されると、toString() にエンコードして URL に直接追加できます (ただし、既存のクエリ パラメーターがある場合は注意が必要です。これらのクエリ パラメーターを追加する適切な方法に影響する可能性があります)。 注: このクラスのインスタンスは不変です。
StorageBrowserPolicy	StorageBrowserPolicy は、次のような Node.js とブラウザー ランタイムの違いを処理します。 ブラウザーは、"IF_MODIFIED_SINCE" などの条件付きヘッダーを追加して GET/HEAD 要求をキャッシュします。 StorageBrowserPolicy は、GET/HEAD 要求 URL にタイムスタンプ クエリを追加するために使用されるポリシーであり、ブラウザーのキャッシュを回避します。 セキュリティのために Cookie ヘッダーを削除する ブラウザーの警告を回避するために content-length ヘッダーを削除する Node.jsでは、このポリシーは no-op パススルーです。
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory は、StorageBrowserPolicy オブジェクトの生成を支援するファクトリ クラスです。
StorageRetryPolicy	指数再試行と線形再試行が実装された再試行ポリシー。
StorageRetryPolicyFactory	StorageRetryPolicyFactory は、StorageRetryPolicy オブジェクト 生成するのに役立つファクトリ クラスです。
StorageSharedKeyCredential	NODE.JSランタイムでのみ使用できます。 Azure Storage サービスのアカウント キー承認用の StorageSharedKeyCredential。
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy は、共有キーを使用して HTTP 要求に署名するために使用されるポリシーです。

インターフェイス

AccessPolicy	アクセス ポリシー
AccessTierModifiedConditions	標準の HTTP 条件付きヘッダー、タグの条件、リース条件
AccountSASPermissionsLike	アカウント SAS アクセス許可のような型。 AccountSASPermissions で使用され、生オブジェクトからの SAS アクセス許可を解析します。
AccountSASSignatureValues	NODE.JSランタイムでのみ使用できます。 AccountSASSignatureValues は、Azure Storage アカウントの Shared Access Signature (SAS) を生成するために使用されます。 ここでのすべての値が適切に設定されたら、generateAccountSASQueryParameters 呼び出して、実際に BLOB URL に適用できる SAS の表現を取得します。 注: 前者は変更可能であり、論理表現であるのに対し、後者は不変であり、実際の REST 要求の生成に使用されるため、このクラスと SASQueryParameters の両方が存在。 SAS の概念の詳細については、https://learn.microsoft.com/azure/storage/common/storage-dotnet-shared-access-signature-part-1 を参照してください。パラメーターの説明については、https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas を参照してください。これには、必要なパラメーターが含まれます。
AppendBlobAppendBlockFromURLOptions	AppendBlobClient.appendBlockFromURL操作の設定オプション。
AppendBlobAppendBlockFromUrlHeaders	AppendBlob_appendBlockFromUrl操作のヘッダーを定義します。
AppendBlobAppendBlockHeaders	AppendBlob_appendBlock操作のヘッダーを定義します。
AppendBlobAppendBlockOptions	AppendBlobClient.appendBlock操作の設定オプション。
AppendBlobCreateHeaders	AppendBlob_create操作のヘッダーを定義します。
AppendBlobCreateIfNotExistsOptions	AppendBlobClient.createIfNotExists 操作の設定オプション。
AppendBlobCreateIfNotExistsResponse	<xref:appendBlobClient.createIfNotExists> 操作の応答データが含まれています。
AppendBlobCreateOptions	AppendBlobClient.create 操作を設定するオプション。
AppendBlobRequestConditions	この追加 BLOB の作成に追加する条件。
AppendBlobSealOptions	AppendBlobClient.seal 操作の設定オプション。
AppendPositionAccessConditions	パラメーター グループ
BatchSubRequest	バッチ操作に関連付けられている要求。
BatchSubResponse	バッチ操作内の 1 つの要求に関連付けられた応答データ。
BlobAbortCopyFromURLHeaders	Blob_abortCopyFromURL操作のヘッダーを定義します。
BlobAbortCopyFromURLOptions	BlobClient.abortCopyFromURL操作の設定オプション。
BlobAcquireLeaseOptions	BLOB を構成するオプション - リース操作を取得します。
BlobBatchSubmitBatchOptionalParams	サービスを構成するためのオプション - バッチオプションパラメーターの送信。
BlobBeginCopyFromURLOptions	BlobClient.beginCopyFromURL操作の設定オプション。
BlobBeginCopyFromURLResponse	BlobClient.beginCopyFromURL操作の応答データが含まれています。
BlobBeginCopyFromUrlPollState	ポーラーが使用した状態は BlobClient.beginCopyFromURLから返されました。 この状態は、コピーの進行状況が検出されるたびに、ユーザー指定の onProgress コールバックに渡されます。
BlobBreakLeaseOptions	Blob - Break Lease 操作を構成するためのオプション。
BlobChangeLeaseOptions	BLOB を構成するためのオプション - リース操作の変更。
BlobClientConfig	Blobクライアントインスタンスの作成に使われる設定。
BlobCopyFromURLHeaders	Blob_copyFromURL操作のヘッダーを定義します。
BlobCreateSnapshotHeaders	Blob_createSnapshot操作のヘッダーを定義します。
BlobCreateSnapshotOptions	BlobClient.createSnapshot操作の設定オプション。
BlobDeleteHeaders	Blob_delete操作のヘッダーを定義します。
BlobDeleteIfExistsResponse	BlobClient.deleteIfExists操作の応答データが含まれています。
BlobDeleteImmutabilityPolicyHeaders	Blob_deleteImmutabilityPolicy操作のヘッダーを定義します。
BlobDeleteImmutabilityPolicyOptions	Immutabilityポリシーを削除するオプション BlobClient.deleteImmutabilityPolicy 操作。
BlobDeleteOptions	BlobClient.delete操作の設定オプション。
BlobDownloadHeaders	Blob_download操作のヘッダーを定義します。
BlobDownloadOptionalParams	省略可能なパラメーター。
BlobDownloadOptions	BlobClient.download操作の設定オプション。
BlobDownloadResponseParsed	BlobClient.download操作のレスポンスデータが含まれています。
BlobDownloadToBufferOptions	BlobClient.downloadToBuffer操作のオプションインターフェース。
BlobExistsOptions	BlobClient.exists 操作の設定オプション。
BlobFlatListSegment	BlobFlatListSegment を表すインターフェイス。
BlobFlatListSegmentModel
BlobGenerateSasUrlOptions	BlobClient.generateSasUrl操作の設定オプション。
BlobGetAccountInfoHeaders	Blob_getAccountInfo操作のヘッダーを定義します。
BlobGetAccountInfoOptions	BlobClient.getAccountInfo操作の設定オプション。
BlobGetPropertiesHeaders	Blob_getProperties操作のヘッダーを定義します。
BlobGetPropertiesOptions	BlobClient.getProperties操作を設定するオプション。
BlobGetPropertiesResponse	BlobClient.getProperties操作の応答データが含まれています。
BlobGetTagsHeaders	Blob_getTags操作のヘッダーを定義します。
BlobGetTagsOptions	BlobClient.getTags 操作を設定するオプション。
BlobGetUserDelegationKeyParameters	ユーザー委任キーを取得するためのパラメータ。
BlobHTTPHeaders	パラメーター グループ
BlobHierarchyListSegment	BlobHierarchyListSegment を表すインターフェイス。
BlobHierarchyListSegmentModel
BlobImmutabilityPolicy	BLOB の不変ポリシーについて説明します。
BlobItem	Azure Storage BLOB
BlobItemInternal	Azure Storage BLOB
BlobModifiedAccessConditions	パラメーター グループ
BlobPrefix
BlobProperties	BLOB のプロパティ
BlobQueryArrowConfiguration	Apache Arrow 形式で BLOB にクエリを実行するオプション。 BlockBlobQueryOptions.outputTextConfigurationにのみ有効です。
BlobQueryArrowField	BlobQueryArrowConfigurationのフィールドについて説明します。
BlobQueryCsvTextConfiguration	CSV 形式で BLOB にクエリを実行するオプション。
BlobQueryError	BLOB クエリのエラーの種類。
BlobQueryHeaders	Blob_query操作のヘッダーを定義します。
BlobQueryJsonTextConfiguration	JSON 形式で BLOB にクエリを実行するオプション。
BlobQueryParquetConfiguration	Parquet 形式で BLOB にクエリを実行するオプション。 BlockBlobQueryOptions.inputTextConfigurationでのみ有効です。
BlobReleaseLeaseOptions	BLOB - リリース リース操作を構成するためのオプション。
BlobRenewLeaseOptions	BLOB を構成するためのオプション - リースの更新操作。
BlobRequestConditions	標準の HTTP 条件付きヘッダー、タグの条件、リース条件
BlobSASPermissionsLike	BLOB SAS アクセス許可のような型。 BlobSASPermissions で生オブジェクトからの SAS アクセス許可を解析するために使用されます。
BlobSASSignatureValues	NODE.JSランタイムでのみ使用できます。 BlobSASSignatureValues は、コンテナーまたは BLOB の BLOB サービス SAS トークンの生成に役立ちます。
BlobServiceProperties	ストレージ サービスのプロパティ。
BlobServiceStatistics	ストレージ サービスの統計。
BlobSetHTTPHeadersHeaders	Blob_setHttpHeaders操作のヘッダーを定義します。
BlobSetHTTPHeadersOptions	BlobClient.setHTTPHeaders操作の設定オプション。
BlobSetImmutabilityPolicyHeaders	Blob_setImmutabilityPolicy操作のヘッダーを定義します。
BlobSetImmutabilityPolicyOptions	不可変性ポリシーを設定するオプション BlobClient.setImmutabilityPolicy 操作。
BlobSetLegalHoldHeaders	Blob_setLegalHold操作のヘッダーを定義します。
BlobSetLegalHoldOptions	BlobClient.setLegalHold操作を設定するためのオプション。
BlobSetMetadataHeaders	Blob_setMetadata操作のヘッダーを定義します。
BlobSetMetadataOptions	BlobClient.setMetadata操作の設定オプション。
BlobSetTagsHeaders	Blob_setTags操作のヘッダーを定義します。
BlobSetTagsOptions	BlobClient.setTags操作の設定オプション。
BlobSetTierHeaders	Blob_setTier操作のヘッダーを定義します。
BlobSetTierOptions	BlobClient.setAccessTier 操作を設定するオプション。
BlobStartCopyFromURLHeaders	Blob_startCopyFromURL操作のヘッダーを定義します。
BlobStartCopyFromURLOptions	BlobClient.beginCopyFromURL操作の設定オプション。
BlobSyncCopyFromURLOptions	BlobClient.syncCopyFromURL操作の設定オプション。
BlobTag
BlobTags	BLOB タグ
BlobUndeleteHeaders	Blob_undelete操作のヘッダーを定義します。
BlobUndeleteOptions	BlobClient.undelete操作を設定するオプション。
Block	ブロック BLOB 内の 1 つのブロックを表します。 ブロックの ID とサイズについて説明します。
BlockBlobCommitBlockListHeaders	BlockBlob_commitBlockList操作のヘッダーを定義します。
BlockBlobCommitBlockListOptions	BlockBlobClient.commitBlockList 操作の設定オプション。
BlockBlobGetBlockListHeaders	BlockBlob_getBlockList操作のヘッダーを定義します。
BlockBlobGetBlockListOptions	BlockBlobClient.getBlockList 操作の設定オプション。
BlockBlobParallelUploadOptions	BlockBlobClient.uploadFileと<xref:BlockBlobClient.uploadSeekableStream>のオプションインターフェース。
BlockBlobPutBlobFromUrlHeaders	BlockBlob_putBlobFromUrl操作のヘッダーを定義します。
BlockBlobQueryOptions	BlockBlobClient.query操作の設定オプション。
BlockBlobStageBlockFromURLHeaders	BlockBlob_stageBlockFromURL操作のヘッダーを定義します。
BlockBlobStageBlockFromURLOptions	BlockBlobClient.stageBlockFromURL操作の設定オプション。
BlockBlobStageBlockHeaders	BlockBlob_stageBlock操作のヘッダーを定義します。
BlockBlobStageBlockOptions	BlockBlobClient.stageBlock 操作の設定オプション。
BlockBlobSyncUploadFromURLOptions	BlockBlobClient.syncアップロードFromURL操作の設定オプション。
BlockBlobUploadHeaders	BlockBlob_upload操作のヘッダーを定義します。
BlockBlobUploadOptions	BlockBlobClient.upload操作を設定するオプション。
BlockBlobUploadStreamOptions	BlockBlobClient.uploadStream 操作のオプションインターフェース。
BlockList
ClearRange
CommonGenerateSasUrlOptions	BlobGenerateSasUrlOptions と ContainerGenerateSasUrlOptionsの一般的なオプション。
CommonOptions	すべてのリモート操作に共通するオプションのインターフェイス。
ContainerAcquireLeaseOptions	コンテナーを構成するためのオプション - リース操作を取得します。
ContainerBreakLeaseOptionalParams	省略可能なパラメーター。
ContainerBreakLeaseOptions	コンテナーを構成するためのオプション - リースの中断操作。
ContainerChangeLeaseOptions	コンテナーを構成するためのオプション - リース操作の変更。
ContainerCreateHeaders	Container_create操作のヘッダーを定義します。
ContainerCreateIfNotExistsResponse	ContainerClient.createIfNotExists 操作の応答データが含まれています。
ContainerCreateOptions	ContainerClient.create操作の設定オプション。
ContainerDeleteBlobOptions	ContainerClient.deleteBlob操作の設定オプション。
ContainerDeleteHeaders	Container_delete操作のヘッダーを定義します。
ContainerDeleteIfExistsResponse	ContainerClient.deleteIfExists操作のレスポンスデータが含まれています。
ContainerDeleteMethodOptions	ContainerClient.delete操作を設定するオプション。
ContainerEncryptionScope	パラメーター グループ
ContainerExistsOptions	ContainerClient.exists 操作の設定オプション。
ContainerFilterBlobsHeaders	Container_filterBlobs操作のヘッダーを定義します。
ContainerFindBlobByTagsOptions	BlobServiceClient.findBlobsByTags 操作を設定するオプション。
ContainerGenerateSasUrlOptions	ContainerClient.generateSasUrl操作の設定オプション。
ContainerGetAccessPolicyHeaders	Container_getAccessPolicy操作のヘッダーを定義します。
ContainerGetAccessPolicyOptions	ContainerClient.getAccessPolicy 操作の設定オプション。
ContainerGetAccountInfoHeaders	Container_getAccountInfo操作のヘッダーを定義します。
ContainerGetAccountInfoOptions	ContainerClient.getAccountInfo操作の設定オプション。
ContainerGetPropertiesHeaders	Container_getProperties操作のヘッダーを定義します。
ContainerGetPropertiesOptions	ContainerClient.getProperties操作の設定オプション。
ContainerItem	Azure Storage コンテナー
ContainerListBlobFlatSegmentHeaders	Container_listBlobFlatSegment操作のヘッダーを定義します。
ContainerListBlobHierarchySegmentHeaders	Container_listBlobHierarchySegment操作のヘッダーを定義します。
ContainerListBlobsOptions	コンテナーを構成するためのオプション - BLOB 操作を一覧表示します。 See: ContainerClient.listBlobsFlat ContainerClient.listBlobsByHierarchy
ContainerProperties	コンテナーのプロパティ
ContainerReleaseLeaseOptions	コンテナーを構成するためのオプション - リース操作を解放します。
ContainerRenameHeaders	Container_rename操作のヘッダーを定義します。
ContainerRenewLeaseOptions	コンテナーを構成するためのオプション - リースの更新操作。
ContainerRequestConditions	コンテナーに対して満たす条件。
ContainerSASPermissionsLike	コンテナー SAS アクセス許可のような型。 ContainerSASPermissions で使用され、生オブジェクトからの SAS アクセス許可を解析します。
ContainerSetAccessPolicyHeaders	Container_setAccessPolicy操作のヘッダーを定義します。
ContainerSetAccessPolicyOptions	ContainerClient.setAccessPolicy 操作を設定するオプション。
ContainerSetMetadataHeaders	Container_setMetadata操作のヘッダーを定義します。
ContainerSetMetadataOptions	ContainerClient.setMetadata 操作の設定オプション。
ContainerUndeleteHeaders	Container_restore操作のヘッダーを定義します。
CorsRule	CORS は、あるドメインで実行されている Web アプリケーションが別のドメインのリソースにアクセスできるようにする HTTP 機能です。 Web ブラウザーは、Web ページが別のドメインの API を呼び出さないようにする、同じ配信元ポリシーと呼ばれるセキュリティ制限を実装します。CORS は、あるドメイン (配信元ドメイン) が別のドメインの API を呼び出すことを許可する安全な方法を提供します
CpkInfo	パラメーター グループ
FilterBlobItem	Blob info from a BlobServiceClient.findBlobsByTags
FilterBlobItemModel	フィルター BLOB API 呼び出しからの BLOB 情報
FilterBlobSegment	Segment response of BlobServiceClient.findBlobsByTags operation.
FilterBlobSegmentModel	フィルター BLOB API 呼び出しの結果
GeoReplication	セカンダリ ストレージ サービスの Geo-Replication 情報
HttpAuthorization	Authorization、ProxyAuthorization、WWW-Authenticate、および Proxy-Authenticate ヘッダー値の認証情報を表します。
HttpHeaders	HTTP ヘッダーのキーと値のペアのコレクション。
HttpOperationResponse	core-v1(core-http) と互換性のある Http 応答。
HttpResponse	HTTP 応答を生成した要求への参照を含む HTTP 応答の表現。
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	パラメーター グループ
NodeJSReadableStream	destroy メソッドも含む読み取り可能な Node.js ストリーム。
ObjectReplicationPolicy	オブジェクト レプリケーション ポリシー ID と、objectReplicationRule のそれぞれの一覧含まれています。 これは、ソース BLOB のオブジェクト レプリケーション プロパティを取得するときに使用されます。 宛先 BLOB のポリシー ID は、それぞれのメソッド応答の ObjectReplicationDestinationPolicyId で設定されます (例: <xref:BlobProperties.ObjectReplicationDestinationPolicyId>。
ObjectReplicationRule	BLOB のオブジェクト レプリケーション 規則 ID と ObjectReplicationStatus が含まれます。 ObjectReplicationPolicyの下に、ObjectReplicationRule が複数存在する場合があります。
PageBlobClearPagesHeaders	PageBlob_clearPages操作のヘッダーを定義します。
PageBlobClearPagesOptions	PageBlobClient.clearPages操作を設定するオプション。
PageBlobCopyIncrementalHeaders	PageBlob_copyIncremental操作のヘッダーを定義します。
PageBlobCreateHeaders	PageBlob_create操作のヘッダーを定義します。
PageBlobCreateIfNotExistsOptions	PageBlobClient.createIfNotExists 操作の設定オプション。
PageBlobCreateIfNotExistsResponse	PageBlobClient.createIfNotExists操作の応答データを含みます。
PageBlobCreateOptions	PageBlobClient.create 操作の設定オプション。
PageBlobGetPageRangesDiffHeaders	PageBlob_getPageRangesDiff操作のヘッダーを定義します。
PageBlobGetPageRangesDiffOptions	<xref:PageBlobClient.getRangesDiff> 操作を構成するためのオプション。
PageBlobGetPageRangesDiffResponse	getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions) 操作の応答データが含まれています。
PageBlobGetPageRangesHeaders	PageBlob_getPageRanges操作のヘッダーを定義します。
PageBlobGetPageRangesOptions	PageBlobClient.getPageRanges 操作の設定オプション。
PageBlobGetPageRangesResponse	getPageRanges(number, number, PageBlobGetPageRangesOptions) 操作の応答データが含まれています。
PageBlobListPageRangesDiffOptions	PageBlobClient.listPageRangesDiff操作の設定オプション。
PageBlobListPageRangesOptions	PageBlobClient.listPageRanges 操作の設定オプション。
PageBlobRequestConditions	このページ BLOB の作成に追加する条件。
PageBlobResizeHeaders	PageBlob_resize操作のヘッダーを定義します。
PageBlobResizeOptions	PageBlobClient.resize 操作の設定オプション。
PageBlobStartCopyIncrementalOptions	PageBlobClient.startCopyIncremental 操作の設定オプション。
PageBlobUpdateSequenceNumberHeaders	PageBlob_updateSequenceNumber操作のヘッダーを定義します。
PageBlobUpdateSequenceNumberOptions	PageBlobClient.updateSequenceNumber操作の設定オプション。
PageBlobUploadPagesFromURLHeaders	PageBlob_uploadPagesFromURL操作のヘッダーを定義します。
PageBlobUploadPagesFromURLOptions	PageBlobClient.uploadPagesFromURL操作の設定オプション。
PageBlobUploadPagesHeaders	PageBlob_uploadPages操作のヘッダーを定義します。
PageBlobUploadPagesOptions	PageBlobClient.uploadPages操作を設定するオプション。
PageList	BLOB のページ範囲の一覧。
PageListInternal	ページの一覧
PageRange
PageRangeInfo
ParsedBatchResponse	各サブ要求の応答を含むマルチパート/混合応答。
PipelineLike	HTTP 要求ポリシーを含む Pipeline クラスのインターフェイス。 newPipeline 呼び出すことで、既定のパイプラインを作成できます。 または、Pipeline のコンストラクターによって独自のポリシーを使用してパイプラインを作成することもできます。 カスタマイズしたパイプライン 実装する前に、newPipeline と指定されたポリシーを参照してください。
PipelineOptions	パイプライン コンストラクターのオプション インターフェイス。
PollOperationState	PollOperationState には、実行時間の長い操作ポーリングツールを定義するために必要なプロパティの最小セットの一覧が含まれています。 Poller クラスは、実行時間の長い操作のトリガー、待機、および取り消しを開始するローカル制御メカニズムとして機能しますが、PollOperationState は、実行時間の長いリモート操作の状態を文書化します。 少なくとも操作の開始時、完了時、取り消し時に更新する必要があります。 ただし、実装には、他の理由で更新できる他の数のプロパティを含めることができます。
PollerLike	ユーザーが操作する必要がある最小限の API のみを公開することを目的としたポーリングャーの抽象表現。
PollerLikeWithCancellation	ユーザーが操作する必要がある最小限の API のみを公開することを目的としたポーリングャーの抽象表現。
Range	Blob Service 操作の範囲。 https://learn.microsoft.com/rest/api/storageservices/specifying-the-range-header-for-blob-service-operations を参照してください
RequestPolicy	core-http 要求ポリシーの互換性のあるインターフェイス
RequestPolicyFactory	core-http の RequestPolicyFactory との互換性のためのインターフェイス
RequestPolicyOptions	RequestPolicy との互換性のためのインターフェイス
ResponseLike	単純な_response プロパティを持つオブジェクト。
ResponseWithBody	本文とヘッダーが既に既知の型に解析されている_response プロパティを持つオブジェクト。
ResponseWithHeaders	既に型指定されたオブジェクトにヘッダーが解析されている_response プロパティを持つオブジェクト。
RetentionPolicy	関連付けられたデータを保持する期間を決定するアイテム保持ポリシー
SASQueryParametersOptions	SASQueryParameters 構築するオプション。
SasIPRange	SAS に対して許可される IP 範囲。
SequenceNumberAccessConditions	パラメーター グループ
ServiceClientOptions	@azure/core-http ServiceClientOptions のサブセット
ServiceFilterBlobsHeaders	Service_filterBlobs操作のヘッダーを定義します。
ServiceFindBlobByTagsOptions	BlobServiceClient.findBlobsByTags 操作を設定するオプション。
ServiceGenerateAccountSasUrlOptions	BlobServiceClient.generateAccountSasUrl 操作の設定オプション。
ServiceGetAccountInfoHeaders	Service_getAccountInfo操作のヘッダーを定義します。
ServiceGetAccountInfoOptions	BlobServiceClient.getAccountInfo操作を設定するオプション。
ServiceGetPropertiesHeaders	Service_getProperties操作のヘッダーを定義します。
ServiceGetPropertiesOptions	BlobServiceClient.getProperties操作を設定するオプション。
ServiceGetStatisticsHeaders	Service_getStatistics操作のヘッダーを定義します。
ServiceGetStatisticsOptions	BlobServiceClient.getStatistics操作の設定オプション。
ServiceGetUserDelegationKeyHeaders	Service_getUserDelegationKey操作のヘッダーを定義します。
ServiceGetUserDelegationKeyOptions	サービスを構成するためのオプション - ユーザー委任キーを取得します。
ServiceListContainersOptions	BlobServiceClient.listContainers 操作を設定するオプション。
ServiceListContainersSegmentHeaders	Service_listContainersSegment操作のヘッダーを定義します。
ServiceRenameContainerOptions	<xref:BlobServiceClient.renameContainer> 操作を構成するオプション。
ServiceSetPropertiesHeaders	Service_setProperties操作のヘッダーを定義します。
ServiceSetPropertiesOptions	BlobServiceClient.setProperties操作を設定するオプション。
ServiceSubmitBatchHeaders	Service_submitBatch操作のヘッダーを定義します。
ServiceSubmitBatchOptionalParamsModel	省略可能なパラメーター。
ServiceUndeleteContainerOptions	BlobServiceClient.undeleteContainer 操作の設定オプション。
SignedIdentifier	署名付き識別子。
SignedIdentifierModel	署名付き識別子
StaticWebsite	アカウントが静的 Web サイトをホストできるようにするプロパティ
StoragePipelineOptions	newPipeline 関数のオプション インターフェイス。
StorageRetryOptions	ストレージ BLOB 再試行オプション インターフェイス。
TagConditions	BLOB タグに基づいて条件付き要求の HTTP オプションを指定します。
UserDelegationKey	ユーザー委任キー。
UserDelegationKeyModel	ユーザー委任キー
WebResource	リモート サーバーに対して行われる HTTP 要求の説明。

型エイリアス

AccessTier	AccessTier の値を定義します。
AccountKind	AccountKind の値を定義します。
AppendBlobAppendBlockFromUrlResponse	appendBlockFromUrl 操作の応答データを格納します。
AppendBlobAppendBlockResponse	appendBlock 操作の応答データを格納します。
AppendBlobClientOptions	AppendBlobClientインスタンスを作成するオプション
AppendBlobCreateResponse	作成操作の応答データが含まれています。
ArchiveStatus	ArchiveStatus の値を定義します。
BlobAbortCopyFromURLResponse	abortCopyFromURL 操作の応答データを格納します。
BlobBatchDeleteBlobsResponse	deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions) 操作の応答データが含まれています。
BlobBatchSetBlobsAccessTierResponse	setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions) 操作の応答データが含まれています。
BlobBatchSubmitBatchResponse	BLOB バッチ操作の応答データが含まれています。
BlobClientOptions	BlobClientインスタンスを作成するためのオプション
BlobCopyFromURLResponse	copyFromURL 操作の応答データを格納します。
BlobCopySourceTags	BlobCopySourceTag の値を定義します。
BlobCreateSnapshotResponse	createSnapshot 操作の応答データが含まれています。
BlobDeleteImmutabilityPolicyResponse	deleteImmutabilityPolicy 操作の応答データを格納します。
BlobDeleteResponse	削除操作の応答データが含まれています。
BlobDownloadResponseInternal	ダウンロード操作(内部)の応答データが含まれています。 これはNodeJS.ReadableStreamの代わりにNodeJSReadableStreamを使用した再定義版です。
BlobDownloadResponseModel	ダウンロード操作の応答データが含まれています。
BlobGetAccountInfoResponse	getAccountInfo 操作の応答データが含まれています。
BlobGetPropertiesResponseModel	getProperties 操作の応答データを格納します。
BlobGetTagsResponse	BlobClient.getTags操作の応答データが含まれています。
BlobImmutabilityPolicyMode	BlobImmutabilityPolicyMode の値を定義します。
BlobQueryArrowFieldType	BlobQueryArrowFieldの型。
BlobQueryResponseInternal	クエリ操作(内部)の応答データを含みます。 これはNodeJS.ReadableStreamの代わりにNodeJSReadableStreamを使用した再定義版です。
BlobQueryResponseModel	クエリ操作の応答データが含まれています。
BlobServiceClientOptions	BlobServiceClientインスタンスを作成するためのオプション
BlobSetHTTPHeadersResponse	setHttpHeaders 操作の応答データを格納します。
BlobSetImmutabilityPolicyResponse	setImmutabilityPolicy 操作の応答データを格納します。
BlobSetLegalHoldResponse	setLegalHold 操作の応答データを格納します。
BlobSetMetadataResponse	setMetadata 操作の応答データが含まれています。
BlobSetTagsResponse	setTags 操作の応答データを格納します。
BlobSetTierResponse	setTier 操作の応答データを格納します。
BlobStartCopyFromURLResponse	startCopyFromURL 操作の応答データを格納します。
BlobType	BlobType の値を定義します。
BlobUndeleteResponse	削除取り消し操作の応答データが含まれています。
BlobUploadCommonResponse	BlockBlobClient.uploadFile、BlockBlobClient.uploadStream、<xref:BlockBlobClient.uploadBrowserDate>の応答タイプ。
BlockBlobClientOptions	BlockBlobClient インスタンスを作成するためのオプション
BlockBlobCommitBlockListResponse	commitBlockList 操作の応答データを格納します。
BlockBlobGetBlockListResponse	getBlockList 操作の応答データが含まれています。
BlockBlobGetBlockListResponseInternal	getBlockList 操作の応答データが含まれています。
BlockBlobPutBlobFromUrlResponse	putBlobFromUrl 操作の応答データを格納します。
BlockBlobStageBlockFromURLResponse	stageBlockFromURL 操作の応答データを格納します。
BlockBlobStageBlockResponse	stageBlock 操作の応答データを格納します。
BlockBlobUploadResponse	アップロード操作の応答データが含まれています。
BlockListType	BlockListType の値を定義します。
ContainerClientOptions	ContainerClientインスタンスを作成するオプション
ContainerCreateResponse	作成操作の応答データが含まれています。
ContainerDeleteResponse	削除操作の応答データが含まれています。
ContainerFilterBlobsResponse	filterBlobs 操作の応答データを格納します。
ContainerFindBlobsByTagsSegmentResponse	BlobServiceClient.findBlobsByTags操作の応答。
ContainerGetAccessPolicyResponse	ContainerClient.getAccessPolicy 操作の応答データが含まれています。
ContainerGetAccessPolicyResponseModel	getAccessPolicy 操作の応答データが含まれています。
ContainerGetAccountInfoResponse	getAccountInfo 操作の応答データが含まれています。
ContainerGetPropertiesResponse	getProperties 操作の応答データを格納します。
ContainerListBlobFlatSegmentResponse	listBlobFlatSegment 操作の応答データを格納します。
ContainerListBlobHierarchySegmentResponse	listBlobHierarchySegment 操作の応答データを格納します。
ContainerRenameResponse	名前変更操作の応答データが含まれています。
ContainerSetAccessPolicyResponse	setAccessPolicy 操作の応答データを格納します。
ContainerSetMetadataResponse	setMetadata 操作の応答データが含まれています。
ContainerUndeleteResponse	復元操作の応答データが含まれています。
CopyPollerBlobClient	BlobClient.beginCopyFromURLが返すポーラーを動作させるために必要なBlobClientからの操作を定義します。
CopyStatusType	CopyStatusType の値を定義します。
CredentialPolicyCreator	指定された nextPolicy を使用する新しい CredentialPolicy を作成するファクトリ関数。
DeleteSnapshotsOptionType	DeleteSnapshotsOptionType の値を定義します。
EncryptionAlgorithmType	EncryptionAlgorithmType の値を定義します。 KnownEncryptionAlgorithmType EncryptionAlgorithmType と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 AES256
FileShareTokenIntent	FileShareTokenIntent の値を定義します。 <xref:KnownFileShareTokenIntent> FileShareTokenIntent と同じ意味で使用できるこの列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 backup
GeoReplicationStatusType	GeoReplicationStatusType の値を定義します。
HttpRequestBody	要求でサポートされる本文の種類。 NodeReadableStream と () => NodeReadableStream はノード専用です。 Blob、WebReadableStream<Uint8Array>、および() => WebReadableStream<Uint8Array> はブラウザ専用です。
LeaseDurationType	LeaseDurationType の値を定義します。
LeaseOperationResponse	リースを作成、変更、または削除する操作の応答データを格納します。 「 BlobLeaseClient」を参照してください。
LeaseStateType	LeaseStateType の値を定義します。
LeaseStatusType	LeaseStatusType の値を定義します。
ObjectReplicationStatus	BLOB のレプリケーションの状態を指定します。 これは、ストレージ アカウントにオブジェクト レプリケーション ポリシーが適用されている場合に使用されます。 ObjectReplicationPolicy と ObjectReplicationRule を参照してください。
PageBlobClearPagesResponse	clearPages 操作の応答データを格納します。
PageBlobClientOptions	PageBlobClientインスタンスを作成するためのオプション
PageBlobCopyIncrementalResponse	copyIncremental 操作の応答データを格納します。
PageBlobCreateResponse	作成操作の応答データが含まれています。
PageBlobGetPageRangesDiffResponseInternal	getPageRangesDiff 操作の応答データを格納します。
PageBlobGetPageRangesDiffResponseModel	getPageRangesDiff 操作の応答データを格納します。
PageBlobGetPageRangesResponseInternal	getPageRanges 操作の応答データを格納します。
PageBlobGetPageRangesResponseModel	getPageRanges 操作の応答データを格納します。
PageBlobResizeResponse	サイズ変更操作の応答データが含まれています。
PageBlobUpdateSequenceNumberResponse	updateSequenceNumber 操作の応答データを格納します。
PageBlobUploadPagesFromURLResponse	uploadPagesFromURL 操作の応答データを格納します。
PageBlobUploadPagesResponse	uploadPages 操作の応答データが含まれています。
PublicAccessType	PublicAccessType の値を定義します。
RehydratePriority	RehydratePriority の値を定義します。
RequestHeaders	SASトークン生成に使用されるリクエストヘッダー
RequestQueryParameters	SASトークン生成に用いられるリクエストクエリパラメータ
SequenceNumberActionType	SequenceNumberActionType の値を定義します。
ServiceFindBlobsByTagsSegmentResponse	BlobServiceClient.findBlobsByTags操作の応答。
ServiceGetAccountInfoResponse	getAccountInfo 操作の応答データが含まれています。
ServiceGetPropertiesResponse	getProperties 操作の応答データを格納します。
ServiceGetPropertiesResponseInternal	getProperties 操作の応答データを格納します。
ServiceGetStatisticsResponse	getStatistics 操作の応答データを格納します。
ServiceGetStatisticsResponseInternal	getStatistics 操作の応答データを格納します。
ServiceGetUserDelegationKeyResponse	getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions) 操作の応答データが含まれています。
ServiceListContainersSegmentResponse	listContainersSegment 操作の応答データを格納します。
ServiceListContainersSegmentResponseInternal	listContainersSegment 操作の応答データを格納します。
ServiceSetPropertiesResponse	setProperties 操作の応答データを格納します。
ServiceSubmitBatchResponseInternal	submitBatch操作(内部)の応答データが含まれています。 これはNodeJS.ReadableStreamの代わりにNodeJSReadableStreamを使用した再定義版です。
ServiceSubmitBatchResponseModel	submitBatch 操作の応答データが含まれています。
SkuName	SkuName の値を定義します。
StorageChecksumAlgorithm	コンテンツ検証で使用するチェックサムアルゴリズムを示します。
SyncCopyStatusType	SyncCopyStatusType の値を定義します。
Tags	BLOB タグ。
WithResponse	既知の_response プロパティを持つ操作の結果を表す型。

列挙型

BlockBlobTier	BLOB のアクセス層を表します。 ブロック BLOB レベルの階層化の詳細については、「ホット、クール、アーカイブ ストレージ層」を参照してください。
KnownEncryptionAlgorithmType	サービスが受け入れる EncryptionAlgorithmType の既知の値。
PremiumPageBlobTier	BLOB を設定するページ BLOB 層を指定します。 これは、Premium Storage アカウントのページ BLOB にのみ適用されます。 PageBlobTier あたりの対応する IOPS とスループットの詳細については、の を参照してください。
SASProtocol	生成された SAS のプロトコル。
StorageBlobAudience	Storage の既知のクラウド対象ユーザーを定義します。
StorageRetryPolicyType	RetryPolicy 型。

関数

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	NODE.JSランタイムでのみ使用できます。 実際の REST 要求を行うために必要なすべての SAS クエリ パラメーターを含む、SASQueryParameters オブジェクトを生成します。 https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas を参照してください
generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)	NODE.JSランタイムでのみ使用できます。 SASQueryParameters のインスタンスを作成します。 SAS の作成に必要な設定のみを受け入れます。 オプションの設定については、アクセス許可、startsOn、識別子など、対応するプロパティを直接設定してください。 警告: 識別子が指定されていない場合、アクセス許可と expiresOn が必要です。 このコンストラクターを最初に使用する場合は、識別子または expiresOn & アクセス許可に値を手動で割り当てる必要があります。 次のスニペットを実行する前に、必要な詳細を入力します。 使用例: import { StorageSharedKeyCredential, generateBlobSASQueryParameters, ContainerSASPermissions, SASProtocol, } from "@azure/storage-blob"; const account = "<account>"; const accountKey = "<accountkey>"; const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey); const containerName = "<container name>"; // 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 * 1000), // 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, ).toString(); 識別子の使用例: import { StorageSharedKeyCredential, BlobServiceClient, ContainerSASPermissions, generateBlobSASQueryParameters, } from "@azure/storage-blob"; const account = "<account>"; const accountKey = "<accountkey>"; const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey); const blobServiceClient = new BlobServiceClient( `https://${account}.blob.core.windows.net`, sharedKeyCredential, ); const containerName = "<container name>"; const containerClient = blobServiceClient.getContainerClient(containerName); // 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 * 1000), // Date type permissions: ContainerSASPermissions.parse("racwdl").toString(), startsOn: new Date(), // Date type }, id: identifier, }, ]); const containerSAS = generateBlobSASQueryParameters( { containerName, // Required identifier, // Required }, sharedKeyCredential, ).toString(); BLOB 名の使用例: import { StorageSharedKeyCredential, generateBlobSASQueryParameters, BlobSASPermissions, SASProtocol, } from "@azure/storage-blob"; const account = "<account>"; const accountKey = "<accountkey>"; const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey); const containerName = "<container name>"; const blobName = "<blob name>"; // 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 * 1000), // 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, ).toString();
generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)	NODE.JSランタイムでのみ使用できます。 SASQueryParameters のインスタンスを作成します。 警告: ユーザー委任 SAS を生成するときに識別子は無視されます。アクセス許可と expiresOn が必要です。 使用例: import { BlobServiceClient, generateBlobSASQueryParameters, ContainerSASPermissions, SASProtocol, } from "@azure/storage-blob"; import { DefaultAzureCredential } from "@azure/identity"; const account = "<account>"; const blobServiceClient = new BlobServiceClient( `https://${account}.blob.core.windows.net`, new DefaultAzureCredential(), ); const containerName = "<container name>"; const accountName = "<account name>"; const startsOn = new Date(); const expiresOn = new Date(new Date().valueOf() + 86400 * 1000); // 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();
getBlobServiceAccountAudience(string)	BLOB サービスのストレージ アカウントの OAuth 対象ユーザーを取得します。
isPipelineLike(unknown)	指定された引数がパイプライン コントラクトを満たすかどうかを判断するヘルパー
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	Credential が指定された新しい Pipeline オブジェクトを作成します。

変数

RestError	失敗したパイプライン要求のカスタム エラーの種類。
StorageOAuthScopes	Azure Storageで使うOAuthのスコープについて。
logger	このパッケージの @azure/logger 構成。

関数の詳細

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

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

実際の REST 要求を行うために必要なすべての SAS クエリ パラメーターを含む、SASQueryParameters オブジェクトを生成します。

https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas を参照してください

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

パラメーター

accountSASSignatureValues

AccountSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

返品

SASQueryParameters

generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)

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

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

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

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

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

使用例:

import {
  StorageSharedKeyCredential,
  generateBlobSASQueryParameters,
  ContainerSASPermissions,
  SASProtocol,
} from "@azure/storage-blob";

const account = "<account>";
const accountKey = "<accountkey>";
const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
const containerName = "<container name>";

// 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 * 1000), // 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,
).toString();

識別子の使用例:

import {
  StorageSharedKeyCredential,
  BlobServiceClient,
  ContainerSASPermissions,
  generateBlobSASQueryParameters,
} from "@azure/storage-blob";

const account = "<account>";
const accountKey = "<accountkey>";
const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  sharedKeyCredential,
);

const containerName = "<container name>";
const containerClient = blobServiceClient.getContainerClient(containerName);

// 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 * 1000), // Date type
      permissions: ContainerSASPermissions.parse("racwdl").toString(),
      startsOn: new Date(), // Date type
    },
    id: identifier,
  },
]);

const containerSAS = generateBlobSASQueryParameters(
  {
    containerName, // Required
    identifier, // Required
  },
  sharedKeyCredential,
).toString();

BLOB 名の使用例:

import {
  StorageSharedKeyCredential,
  generateBlobSASQueryParameters,
  BlobSASPermissions,
  SASProtocol,
} from "@azure/storage-blob";

const account = "<account>";
const accountKey = "<accountkey>";
const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);

const containerName = "<container name>";
const blobName = "<blob name>";

// 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 * 1000), // 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,
).toString();

function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

パラメーター

blobSASSignatureValues

BlobSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

返品

SASQueryParameters

generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)

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

SASQueryParameters のインスタンスを作成します。 警告: ユーザー委任 SAS を生成するときに識別子は無視されます。アクセス許可と expiresOn が必要です。

使用例:

import {
  BlobServiceClient,
  generateBlobSASQueryParameters,
  ContainerSASPermissions,
  SASProtocol,
} from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  new DefaultAzureCredential(),
);

const containerName = "<container name>";
const accountName = "<account name>";
const startsOn = new Date();
const expiresOn = new Date(new Date().valueOf() + 86400 * 1000);

// 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): SASQueryParameters

パラメーター

blobSASSignatureValues

BlobSASSignatureValues

userDelegationKey

UserDelegationKey

blobServiceClient.getUserDelegationKey() の戻り値

accountName

string

返品

SASQueryParameters

getBlobServiceAccountAudience(string)

BLOB サービスのストレージ アカウントの OAuth 対象ユーザーを取得します。

function getBlobServiceAccountAudience(storageAccountName: string): string

パラメーター

storageAccountName

string

返品

string

isPipelineLike(unknown)

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

function isPipelineLike(pipeline: unknown): pipeline is PipelineLike

パラメーター

pipeline

unknown

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

返品

pipeline is PipelineLike

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

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

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

パラメーター

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

pipelineOptions

StoragePipelineOptions

Optional. Options.

返品

Pipeline

新しい Pipeline オブジェクト。

変数の詳細

RestError

失敗したパイプライン要求のカスタム エラーの種類。

RestError: RestErrorConstructor

型

RestErrorConstructor

StorageOAuthScopes

Azure Storageで使うOAuthのスコープについて。

StorageOAuthScopes: string | string[]

型

string | string[]

logger

このパッケージの @azure/logger 構成。

logger: AzureLogger

型

AzureLogger