@azure/storage-file-share package

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

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

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

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

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

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

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

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

すべての要求ポリシーの派生元となる基底クラス。

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

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

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

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

これは、ファイルまたはディレクトリへの NTFS 属性を表す文字列を構築するためのヘルパー クラスです。

「https://docs.microsoft.com/en-us/rest/api/storageservices/create-file#file-system-attributes」を参照してください。

HTTP 要求ポリシーを含む Pipeline クラス。 newPipeline を呼び出すことで、既定のパイプラインを作成できます。 または、Pipeline のコンストラクターを使用して、独自のポリシーを使用してパイプラインを作成することもできます。

カスタマイズしたパイプラインを実装する前に、 newPipeline と指定されたポリシーを参照してください。

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

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

注: このクラスのインスタンスは不変です。

ShareClient は、Azure Storage 共有への URL を表し、ディレクトリとファイルを操作できます。

ShareDirectoryClient は、Azure Storage ディレクトリへの URL を表し、そのファイルとディレクトリを操作できます。

ShareFileClient は、Azure Storage ファイルの URL を表します。

ShareFileClient または ShareClient のリースを管理するクライアント。

参照 https://docs.microsoft.com/rest/api/storageservices/lease-file と参照 https://docs.microsoft.com/rest/api/storageservices/lease-share

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

ShareServiceClient は、ファイル共有を操作できる Azure Storage ファイル サービスへの URL を表します。

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

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

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

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

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

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

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

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

Azure Storage サービスのアカウント キー承認用の StorageSharedKeyCredential。

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

アクセス ポリシー。

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

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

SAS の詳細な概念情報についてはhttps://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1、必要なパラメーターを含むパラメーターの説明に関するページを参照してくださいhttps://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

Close は結果情報を処理します。

ShareGenerateSasUrlOptions および FileGenerateSasUrlOptions の一般的なオプション。

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

パラメーター グループ

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

閉じるハンドル要求の追加の応答ヘッダー値。

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

操作の応答データが createIfNotExists(DirectoryCreateOptions) 含まれます。

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

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

操作の応答データが deleteIfExists(DirectoryDeleteOptions) 含まれます。

削除操作を構成するためのオプション。

exists 操作を構成するためのオプション。

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

forceCloseHandle を構成するためのオプション。

ディレクトリを構成するためのオプション - セグメント操作を強制的に閉じるハンドル。

参照トピック

• <xref:ShareDirectoryClient.forceCloseHandlesSegment>
• forceCloseAllHandles

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

getProperties 操作を構成するためのオプション。

一覧表示されているディレクトリ項目。

listFilesAndDirectories 操作を構成するためのオプション。

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

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

listHandles 操作を構成するためのオプション。

ディレクトリを構成するためのオプション - セグメント操作を処理する一覧。

参照トピック

• <xref:ShareDirectoryClient.listHandlesSegment>
• <xref:ShareDirectoryClient.iterateHandleSegments>
• <xref:ShareDirectoryClient.listHandleItems>

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

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

名前変更操作を構成するためのオプション。

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

setMetadata 操作を構成するためのオプション。

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

abortCopyFromURL 操作を構成するためのオプション。

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

clearRange 操作を構成するためのオプション。

閉じるハンドル要求の追加の応答ヘッダー値。

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

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

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

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

削除操作を構成するためのオプション。

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

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

ファイル - ダウンロード操作を構成するためのオプション。

参照トピック

• download
• downloadToFile

downloadToBuffer 操作のオプション インターフェイス。

exists 操作を構成するためのオプション。

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

[ファイル] - [ハンドルを強制的に閉じる] 操作を構成するオプション。

参照トピック

• <xref:ShareFileClient.forceCloseHandlesSegment>
• forceCloseAllHandles
• forceCloseHandle

generateSasUrl 操作を構成するためのオプション。

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

getProperties 操作を構成するためのオプション。

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

getRangeList 操作を構成するためのオプション。

一覧表示されているファイル項目。

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

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

[ファイル] - [リスト ハンドル] セグメント操作を構成するためのオプション。

参照トピック

• <xref:ShareFileClient.listHandlesSegment>
• <xref:ShareFileClient.iterateHandleSegments>
• <xref:ShareFileClient.listHandleItems>

ファイルのオプション インターフェイス - アップロード操作

参照トピック

• Uploadfile
• <xref:ShareFileClient.uploadSeekableStream>

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

ファイルのプロパティ。

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

名前変更操作を構成するためのオプション。

サイズ変更操作を構成するためのオプション。

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

FileSASSignatureValues は、共有またはファイルのファイル サービス SAS トークンの生成に使用されます。

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

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

setHttpHeaders 操作を構成するためのオプション。

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

setMetadata 操作を構成するためのオプション。

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

startCopyFromURL 操作を構成するためのオプション。

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

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

uploadRangeFromURL 操作を構成するためのオプション。

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

uploadRange 操作を構成するためのオプション。

ShareFileClient.uploadStream() のオプション インターフェイス。

ディレクトリから一覧表示できるエントリの抽象。

一覧表示されている Azure Storage ハンドル項目。

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

HTTP ヘッダーのキーと値のペアのコレクション。

core-v1(core-http) と互換性のある Http 応答。

生成された要求への参照を含む HTTP 応答の表現。

core-http 要求ポリシーの互換性のあるインターフェイス

パラメーター グループ

リース操作オプション。

特定のリース操作の応答の詳細。

ディレクトリとファイルの列挙。

ハンドルの列挙。

共有の列挙。

共有の列挙。

ファイル サービスの Storage Analytics メトリック。

HTTP 要求ポリシーを含む Pipeline クラスのインターフェイス。 newPipeline を呼び出すことで、既定のパイプラインを作成できます。 または、Pipeline のコンストラクターを使用して、独自のポリシーを使用してパイプラインを作成することもできます。

カスタマイズしたパイプラインを実装する前に、 newPipeline と指定されたポリシーを参照してください。

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

サービス操作の範囲。

「https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-file-service-operations」を参照してください。

Azure Storage ファイル範囲。

core-http の RequestPolicyFactory との互換性のためのインターフェイス

RequestPolicy との互換性のためのインターフェイス

単純な_response プロパティを持つ オブジェクト。

本文とヘッダーが既に既知の型に解析されている_response プロパティを持つ オブジェクト。

ヘッダーが既に型指定されたオブジェクトに解析されている_response プロパティを持つ オブジェクト。

アイテム保持ポリシー。

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

ServiceClientOptions の @azure/core-http サブセット

generateAccountSasUrl 操作を構成するためのオプション。

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

getProperties 操作を構成するためのオプション。

listShares 操作を構成するためのオプション。

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

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

setProperties 操作を構成するためのオプション。

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

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

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

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

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

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

createPermission 操作を構成するためのオプション。

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

createSnapshot 操作を構成するためのオプション。

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

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

削除操作を構成するためのオプション。

exists 操作を構成するためのオプション。

ファイル範囲の一覧

generateSasUrl 操作を構成するためのオプション。

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

getAccessPolicy 操作を構成するためのオプション。

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

getPermission 操作を構成するためのオプション。

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

getProperties 操作を構成するためのオプション。

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

getStatistics 操作を構成するためのオプション。

一覧表示されている Azure Storage 共有項目。

一覧表示されている Azure Storage 共有項目。

共有レベルでのアクセス許可 (セキュリティ記述子)。

共有のプロパティ。

プロトコル設定

共有で有効にするプロトコル。 現時点では、SMB または NFS のみをサポートしています。

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

setAccessPolicy 操作を構成するためのオプション。

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

setMetadata 操作を構成するためのオプション。

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

setProperties 操作を構成するためのオプション。

setQuota 操作を構成するためのオプション。

SMB プロトコルの設定。

共有の統計。

署名付き識別子

署名付き識別子。

SMB マルチチャネルの設定

パラメーター グループ

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

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

リモート サーバーに対して行われる HTTP 要求の説明。

CopyStatusType の値を定義します。

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

DeleteSnapshotsOptionType の値を定義します。

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

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

forceCloseHandle の応答の種類。

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

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

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

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

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

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

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

既存のファイル属性を変更せずに保持します。

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

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

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

forceCloseHandle の応答の種類。

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

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

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

FileLastWrittenMode の値を定義します。

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

親ディレクトリからのファイルの継承アクセス許可を示します。

既存のファイル権限の値を変更せずに保持します。

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

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

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

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

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

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

要求でサポートされる本文の種類。 NodeJS.ReadableStream と () => NodeJS.ReadableStream は Node のみです。 BLOB、ReadableStream、および () => ReadableStream はブラウザーのみです。

LeaseDurationType の値を定義します。

リースを取得、変更、中断、または解放する操作の応答データが含まれます。

「ShareLeaseClient」を参照してください。

LeaseStateType の値を定義します。

LeaseStatusType の値を定義します。

ListSharesIncludeType の値を定義します。

PermissionCopyModeType の値を定義します。

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

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

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

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

ShareAccessTier の値を定義します。

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

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

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

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

AccessRight の値を定義します。

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

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

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

getStatistics 操作の応答データ。

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

共有のプロパティ。

ShareRootSquash の値を定義します。

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

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

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

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

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

ShareTokenIntent の値を定義します。
KnownShareTokenIntent は ShareTokenIntent と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

backup

要求の時刻として設定を示します。

既存の時刻値を変更せずに保持します。

既知の_response プロパティを持つ操作結果を表す型。

サービスが受け入れる ShareTokenIntent の既知の値。

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

Storage の既知のクラウド 対象ユーザーを定義します。

RetryPolicy 型。

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

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

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

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

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

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

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

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

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

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