@azure/storage-file-share 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) で使用する要求で使用されます。
BaseRequestPolicy	すべての要求ポリシーの派生元となる基本クラス。
Credential	資格情報は、Azure Storage HTTP 要求の署名のための抽象クラスです。 このクラスは、CredentialPolicy を生成する credentialPolicyCreator ファクトリをホストします。
CredentialPolicy	送信前に HTTP(S) 要求に署名するために使用される資格情報ポリシー。 これは抽象クラスです。
FileSASPermissions	NODE.JSランタイムでのみ使用できます。 これは、ServiceSAS によってファイルに付与されるアクセス許可を表す文字列を構築するヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS にその操作のアクセス許可が付与されます。 すべての値が設定されたら、これを toString でシリアル化し、FileSASSignatureValues オブジェクトの権限フィールドとして設定する必要があります。 このクラスを使用せずにアクセス許可文字列を構築することはできますが、アクセス許可の順序は特定であり、このクラスは正確性を保証します。
FileSystemAttributes	これは、ファイルまたはディレクトリへの NTFS 属性を表す文字列を構築するためのヘルパー クラスです。 https://learn.microsoft.com/rest/api/storageservices/create-file#file-system-attributes を参照してください
Pipeline	HTTP 要求ポリシーを含む Pipeline クラス。 newPipeline 呼び出すことで、既定のパイプラインを作成できます。 または、Pipeline のコンストラクターによって独自のポリシーを使用してパイプラインを作成することもできます。 カスタマイズしたパイプライン 実装する前に、newPipeline と指定されたポリシーを参照してください。
SASQueryParameters	Azure Storage SAS のクエリ パラメーターを構成するコンポーネントを表します。 この型は、ユーザーによって直接構築されるわけではありません。これは、AccountSASSignatureValues および FileSASSignatureValues 型によってのみ生成されます。 生成されると、toString() にエンコードして URL に直接追加できます (ただし、既存のクエリ パラメーターがある場合は注意が必要です。これらのクエリ パラメーターを追加する適切な方法に影響する可能性があります)。 注: このクラスのインスタンスは不変です。
ShareClient	ShareClient は、Azure Storage 共有への URL を表し、そのディレクトリとファイルを操作できます。
ShareDirectoryClient	ShareDirectoryClient は、Azure Storage ディレクトリへの URL を表し、そのファイルとディレクトリを操作できます。
ShareFileClient	ShareFileClient は、Azure Storage ファイルの URL を表します。
ShareLeaseClient	ShareFileClient または ShareClientのリースを管理するクライアント。 https://learn.microsoft.com/rest/api/storageservices/lease-file を参照し、https://learn.microsoft.com/rest/api/storageservices/lease-share を参照してください
ShareSASPermissions	これは、ServiceSAS によって共有に付与されるアクセス許可を表す文字列を作成するヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS にその操作のアクセス許可が付与されます。 すべての値が設定されたら、これを toString でシリアル化し、FileSASSignatureValues オブジェクトの権限フィールドとして設定する必要があります。 このクラスを使用せずにアクセス許可文字列を構築することはできますが、アクセス許可の順序は特定であり、このクラスは正確性を保証します。
ShareServiceClient	ShareServiceClient は、ファイル共有を操作できる Azure Storage ファイル サービスへの URL を表します。
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory は、StorageBrowserPolicy オブジェクトの生成を支援するファクトリ クラスです。
StorageRetryPolicy	指数再試行と線形再試行が実装された再試行ポリシー。
StorageRetryPolicyFactory	StorageRetryPolicyFactory は、StorageRetryPolicy オブジェクト 生成するのに役立つファクトリ クラスです。
StorageSharedKeyCredential	NODE.JSランタイムでのみ使用できます。 Azure Storage サービスのアカウント キー承認用の StorageSharedKeyCredential。
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy は、共有キーを使用して HTTP 要求に署名するために使用されるポリシーです。

インターフェイス

AccessPolicy	アクセス ポリシー。
AccountSASSignatureValues	NODE.JSランタイムでのみ使用できます。 AccountSASSignatureValues は、Azure Storage アカウントの Shared Access Signature (SAS) を生成するために使用されます。 ここでのすべての値が適切に設定されたら、generateAccountSASQueryParameters を呼び出して、ファイル 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 を参照してください。これには、必要なパラメーターが含まれます。
ClearRange
CloseHandlesInfo	Close ハンドルの結果情報。
CommonGenerateSasUrlOptions	ShareGenerateSasUrlOptions と FileGenerateSasUrlOptionsの一般的なオプション。
CommonOptions	すべてのリモート操作に共通するオプションのインターフェイス。
CopyFileSmbInfo	パラメーター グループ
CorsRule	CORS は、あるドメインで実行されている Web アプリケーションが別のドメインのリソースにアクセスできるようにする HTTP 機能です。 Web ブラウザーは、Web ページが別のドメインの API を呼び出さないようにする、同じ配信元ポリシーと呼ばれるセキュリティ制限を実装します。CORS は、あるドメイン (配信元ドメイン) が別のドメインの API を呼び出せるようにする安全な方法を提供します。
DirectoryCloseHandlesHeaders	close handles 要求の追加の応答ヘッダー値。
DirectoryCreateHeaders	Directory_create操作のヘッダーを定義します。
DirectoryCreateIfNotExistsResponse	createIfNotExists(DirectoryCreateOptions) 操作の応答データが含まれています。
DirectoryCreateOptions	ShareDirectoryClient.create操作の設定オプション。
DirectoryDeleteHeaders	Directory_delete操作のヘッダーを定義します。
DirectoryDeleteIfExistsResponse	deleteIfExists(DirectoryDeleteOptions) 操作の応答データが含まれています。
DirectoryDeleteOptions	ShareDirectoryClient.delete操作を設定するオプション。
DirectoryExistsOptions	ShareDirectoryClient.exists操作を設定するオプション。
DirectoryForceCloseHandlesHeaders	Directory_forceCloseHandles操作のヘッダーを定義します。
DirectoryForceCloseHandlesOptions	ShareDirectoryClient.forceCloseHandleの設定オプション。
DirectoryForceCloseHandlesSegmentOptions	ディレクトリを構成するオプション - ハンドル セグメント操作を強制的に閉じます。 See: <xref:ShareDirectoryClient.forceCloseHandlesSegment> ShareDirectoryClient.forceCloseAllHandles
DirectoryGetPropertiesHeaders	Directory_getProperties操作のヘッダーを定義します。
DirectoryGetPropertiesOptions	ShareDirectoryClient.getProperties操作の設定オプション。
DirectoryItem	一覧表示されているディレクトリ項目。
DirectoryListFilesAndDirectoriesOptions	ShareDirectoryClient.listFilesAndDirectories操作の設定オプション。
DirectoryListFilesAndDirectoriesSegmentHeaders	Directory_listFilesAndDirectoriesSegment操作のヘッダーを定義します。
DirectoryListHandlesHeaders	Directory_listHandles操作のヘッダーを定義します。
DirectoryListHandlesOptions	ShareDirectoryClient.listHandles操作の設定オプション。
DirectoryListHandlesSegmentOptions	ディレクトリ - リスト ハンドル セグメント操作を構成するオプション。 See: <xref:ShareDirectoryClient.listHandlesSegment> <xref:ShareDirectoryClient.iterateHandleSegments> <xref:ShareDirectoryClient.listHandleItems>
DirectoryProperties	すべてのリモート操作に共通するオプションのインターフェイス。
DirectoryRenameHeaders	Directory_rename操作のヘッダーを定義します。
DirectoryRenameOptions	ShareDirectoryClient.rename操作の設定オプション。
DirectorySetMetadataHeaders	Directory_setMetadata操作のヘッダーを定義します。
DirectorySetMetadataOptions	ShareDirectoryClient.setMetadata操作の設定オプション。
DirectorySetPropertiesHeaders	Directory_setProperties操作のヘッダーを定義します。
FileAbortCopyFromURLOptions	ShareFileClient.abortCopyFromURL操作の設定オプション。
FileAbortCopyHeaders	File_abortCopy操作のヘッダーを定義します。
FileAndDirectoryCreateCommonOptions
FileAndDirectorySetPropertiesCommonOptions
FileClearRangeOptions	ShareFileClient.clearRange 操作を設定するオプション。
FileCloseHandlesHeaders	close handles 要求の追加の応答ヘッダー値。
FileCreateHardLinkHeaders	File_createHardLink操作のヘッダーを定義します。
FileCreateHardLinkOptions	ファイルを構成するオプション - ハード リンク操作を作成します。 See: ShareFileClient.createHardLink
FileCreateHeaders	File_create操作のヘッダーを定義します。
FileCreateOptions	ShareFileClient.create操作を設定するオプション。
FileCreateSymbolicLinkHeaders	File_createSymbolicLink操作のヘッダーを定義します。
FileCreateSymbolicLinkOptions	「ファイル - シンボリック・リンクの作成」操作を構成するオプション。 See: ShareFileClient.createSymbolicLink
FileDeleteHeaders	File_delete操作のヘッダーを定義します。
FileDeleteIfExistsResponse	ShareFileClient.deleteIfExists操作の応答データが含まれています。
FileDeleteOptions	ShareFileClient.delete操作の設定オプション。
FileDownloadHeaders	File_download操作のヘッダーを定義します。
FileDownloadOptions	ファイル - ダウンロード操作を構成するためのオプション。 See: ShareFileClient.download ShareFileClient.downloadToFile
FileDownloadToBufferOptions	ShareFileClient.downloadToBuffer操作のオプションインターフェース。
FileExistsOptions	ShareFileClient.exists 操作の設定オプション。
FileForceCloseHandlesHeaders	File_forceCloseHandles操作のヘッダーを定義します。
FileForceCloseHandlesOptions	[ファイル] - [ハンドルを強制的に閉じる] 操作を構成するオプション。 See: <xref:ShareFileClient.forceCloseHandlesSegment> ShareFileClient.forceCloseAllHandles ShareFileClient.forceCloseHandle
FileGenerateSasUrlOptions	ShareFileClient.generateSasUrl操作の設定オプション。
FileGetPropertiesHeaders	File_getProperties操作のヘッダーを定義します。
FileGetPropertiesOptions	ShareFileClient.getProperties操作を設定するオプション。
FileGetRangeListHeaders	File_getRangeList操作のヘッダーを定義します。
FileGetRangeListOptions	ShareFileClient.getRangeList 操作の設定オプション。
FileGetSymbolicLinkHeaders	File_getSymbolicLink操作のヘッダーを定義します。
FileGetSymbolicLinkOptions	「ファイル - シンボリック・リンクの取得」操作を構成するオプション。 See: ShareFileClient.getSymbolicLink
FileHttpHeaders
FileItem	一覧表示されているファイル項目。
FileListHandlesHeaders	File_listHandles操作のヘッダーを定義します。
FileListHandlesOptions	すべてのリモート操作に共通するオプションのインターフェイス。
FileListHandlesSegmentOptions	ファイル - リスト ハンドル セグメント操作を構成するオプション。 See: <xref:ShareFileClient.listHandlesSegment> <xref:ShareFileClient.iterateHandleSegments> <xref:ShareFileClient.listHandleItems>
FileListRangesDiffOptions	ShareFileClient.listRangesDiff操作を設定するオプション。
FileListRangesOptions	ShareFileClient.listRanges 操作の設定オプション。
FileListRangesSegment	ShareFileClient.listRangesおよびShareFileClient.listRangesDiff操作の結果がまとめられた1ページの本文です。
FileParallelUploadOptions	ファイルのオプション インターフェイス - アップロード操作 See: ShareFileClient.uploadFile <xref:ShareFileClient.uploadSeekableStream>
FilePosixProperties	NFS プロパティ。 これらのプロパティは、Premium NFS ファイル アカウントのファイルまたはディレクトリにのみ適用されることに注意してください。
FileProperties	すべてのリモート操作に共通するオプションのインターフェイス。
FileProperty	ファイルのプロパティ。
FileRenameHeaders	File_rename操作のヘッダーを定義します。
FileRenameOptions	ShareFileClient.rename操作の設定オプション。
FileResizeOptions	ShareFileClient.resize操作の設定オプション。
FileSASSignatureValues	NODE.JSランタイムでのみ使用できます。 FileSASSignatureValues は、共有またはファイルのファイル サービス SAS トークンの生成に使用されます。
FileServiceProperties	ストレージ サービスのプロパティ。
FileSetHTTPHeadersHeaders	File_setHttpHeaders操作のヘッダーを定義します。
FileSetHttpHeadersOptions	ShareFileClient.setHttpHeaders操作の設定オプション。
FileSetMetadataHeaders	File_setMetadata操作のヘッダーを定義します。
FileSetMetadataOptions	ShareFileClient.setMetadata操作の設定オプション。
FileStartCopyHeaders	File_startCopy操作のヘッダーを定義します。
FileStartCopyOptions	ShareFileClient.startCopyFromURL操作の設定オプション。
FileUploadRangeFromURLHeaders	File_uploadRangeFromURL操作のヘッダーを定義します。
FileUploadRangeFromURLOptions	ShareFileClient.uploadRangeFromURL操作の設定オプション。
FileUploadRangeHeaders	File_uploadRange操作のヘッダーを定義します。
FileUploadRangeOptions	ShareFileClient.uploadRange操作の設定オプション。
FileUploadStreamOptions	ShareFileClient.uploadStream() のオプション インターフェイス。
FilesAndDirectoriesListSegment	ディレクトリから一覧表示できるエントリの要約。
HandleItem	一覧に示されている Azure Storage ハンドル項目。
HttpAuthorization	Authorization、ProxyAuthorization、WWW-Authenticate、および Proxy-Authenticate ヘッダー値の認証情報を表します。
HttpHeaders	HTTP ヘッダーのキーと値のペアのコレクション。
HttpOperationResponse	core-v1(core-http) と互換性のある Http 応答。
HttpResponse	HTTP 応答を生成した要求への参照を含む HTTP 応答の表現。
LeaseAccessConditions	パラメーター グループ
LeaseOperationOptions	リース操作オプション。
LeaseOperationResponseHeaders	特定のリース操作の応答の詳細。
ListFilesAndDirectoriesSegmentResponse	ディレクトリとファイルの列挙。
ListHandlesResponse	ハンドルの列挙。
ListSharesResponse	共有の列挙。
ListSharesResponseModel	共有の列挙。
Metadata
Metrics	ファイル サービスの Storage Analytics メトリック。
NfsFileMode	ファイルまたはディレクトリのモードのアクセス許可。
PipelineLike	HTTP 要求ポリシーを含む Pipeline クラスのインターフェイス。 newPipeline 呼び出すことで、既定のパイプラインを作成できます。 または、Pipeline のコンストラクターによって独自のポリシーを使用してパイプラインを作成することもできます。 カスタマイズしたパイプライン 実装する前に、newPipeline と指定されたポリシーを参照してください。
PipelineOptions	パイプライン コンストラクターのオプション インターフェイス。
PosixRolePermissions	特定のロールに対するファイルのアクセス許可を表します。
Range	サービス操作の範囲。 https://learn.microsoft.com/rest/api/storageservices/specifying-the-range-header-for-file-service-operations を参照してください
RangeModel	Azure Storage ファイルの範囲。
RequestPolicy	core-http 要求ポリシーの互換性のあるインターフェイス
RequestPolicyFactory	core-http の RequestPolicyFactory との互換性のためのインターフェイス
RequestPolicyOptions	RequestPolicy との互換性のためのインターフェイス
ResponseLike	単純な_response プロパティを持つオブジェクト。
ResponseWithBody	本文とヘッダーが既に既知の型に解析されている_response プロパティを持つオブジェクト。
ResponseWithHeaders	既に型指定されたオブジェクトにヘッダーが解析されている_response プロパティを持つオブジェクト。
RetentionPolicy	アイテム保持ポリシー。
SasIPRange	SAS に対して許可される IP 範囲。
ServiceClientOptions	@azure/core-http ServiceClientOptions のサブセット
ServiceGenerateAccountSasUrlOptions	ShareServiceClient.generateAccountSasUrl操作の設定オプション。
ServiceGetPropertiesHeaders	Service_getProperties操作のヘッダーを定義します。
ServiceGetPropertiesOptions	ShareServiceClient.getProperties操作を設定するオプション。
ServiceGetUserDelegationKeyHeaders	Service_getUserDelegationKey操作用のヘッダーを定義します。
ServiceGetUserDelegationKeyOptions	サービス設定のオプション - ユーザー委任キーを取得する。
ServiceListSharesOptions	ShareServiceClient.listShares操作を設定するオプション。
ServiceListSharesSegmentHeaders	Service_listSharesSegment操作のヘッダーを定義します。
ServiceSetPropertiesHeaders	Service_setProperties操作のヘッダーを定義します。
ServiceSetPropertiesOptions	ShareServiceClient.setProperties操作を設定するオプション。
ServiceUndeleteShareOptions	<xref:ShareServiceClient.undelete> 操作を構成するためのオプション。
SetPropertiesResponse	setHttpHeaders 操作の応答データを格納します。
ShareClientConfig
ShareCreateHeaders	Share_create操作のヘッダーを定義します。
ShareCreateIfNotExistsResponse	ShareClient.createIfNotExists操作の応答データが含まれています。
ShareCreateOptions	ShareClient.create操作を設定するオプション。
ShareCreatePermissionHeaders	Share_createPermission操作のヘッダーを定義します。
ShareCreatePermissionOptions	ShareClient.createPermission 操作を設定するオプション。
ShareCreateSnapshotHeaders	Share_createSnapshot操作のヘッダーを定義します。
ShareCreateSnapshotOptions	ShareClient.createSnapshot操作の設定オプション。
ShareDeleteHeaders	Share_delete操作のヘッダーを定義します。
ShareDeleteIfExistsResponse	ShareClient.deleteIfExists操作の応答データが含まれています。
ShareDeleteMethodOptions	ShareClient.delete操作を設定するオプション。
ShareExistsOptions	ShareClient.exists操作の設定オプション。
ShareFileRange	ShareFileClient.listRanges と ShareFileClient.listRangesDiff から返される Azure ファイル内のバイトの範囲です。
ShareFileRangeList	ファイル範囲の一覧
ShareGenerateSasUrlOptions	ShareClient.generateSasUrl操作の設定オプション。
ShareGetAccessPolicyHeaders	Share_getAccessPolicy操作のヘッダーを定義します。
ShareGetAccessPolicyOptions	ShareClient.getAccessPolicy 操作を設定するオプション。
ShareGetPermissionHeaders	Share_getPermission操作のヘッダーを定義します。
ShareGetPermissionOptions	ShareClient.getPerit 操作の設定オプション。
ShareGetPropertiesHeaders	Share_getProperties操作のヘッダーを定義します。
ShareGetPropertiesOptions	ShareClient.getProperties操作を設定するオプション。
ShareGetStatisticsHeaders	Share_getStatistics操作のヘッダーを定義します。
ShareGetStatisticsOptions	ShareClient.getStatistics操作の設定オプション。
ShareGetUserDelegationKeyParameters	ユーザー委任キーを取得するためのパラメータ。
ShareItem	一覧表示されている Azure Storage 共有項目。
ShareItemInternal	一覧表示されている Azure Storage 共有項目。
ShareNfsSettings	SMB プロトコルの設定。
ShareNfsSettingsEncryptionInTransit	輸送中の暗号化を有効または無効にしてください。
SharePermission	共有レベルのアクセス許可 (セキュリティ記述子)。
SharePropertiesInternal	共有のプロパティ。
ShareProtocolSettings	プロトコル設定
ShareProtocols	共有で有効にするプロトコル。 現時点では、SMB または NFS のみをサポートします。
ShareSetAccessPolicyHeaders	Share_setAccessPolicy操作のヘッダーを定義します。
ShareSetAccessPolicyOptions	ShareClient.setAccessPolicy 操作を設定するオプション。
ShareSetMetadataHeaders	Share_setMetadata操作のヘッダーを定義します。
ShareSetMetadataOptions	ShareClient.setMetadata 操作の設定オプション。
ShareSetPropertiesHeaders	Share_setProperties操作のヘッダーを定義します。
ShareSetPropertiesOptions	ShareClient.setProperties操作を設定するオプション。
ShareSetQuotaOptions	ShareClient.setQuota操作を設定するオプション。
ShareSmbSettings	SMB プロトコルの設定。
ShareSmbSettingsEncryptionInTransit	輸送中の暗号化を有効または無効にしてください。
ShareStats	共有の統計。
SignedIdentifier	署名付き識別子
SignedIdentifierModel	署名付き識別子。
SmbMultichannel	SMB マルチチャネルの設定
SourceModifiedAccessConditions	パラメーター グループ
StoragePipelineOptions	newPipeline 関数のオプション インターフェイス。
StorageRetryOptions	ストレージ BLOB 再試行オプション インターフェイス。
UserDelegationKey	ユーザー委任キーです。
UserDelegationKeyModel	ユーザー委任キー
WebResource	リモート サーバーに対して行われる HTTP 要求の説明。

型エイリアス

CopyStatusType	CopyStatusType の値を定義します。
CredentialPolicyCreator	指定された nextPolicy を使用する新しい CredentialPolicy を作成するファクトリ関数。
DeleteSnapshotsOptionType	DeleteSnapshotsOptionType の値を定義します。
DirectoryCreateResponse	作成操作の応答データが含まれています。
DirectoryDeleteResponse	削除操作の応答データが含まれています。
DirectoryForceCloseHandlesResponse	ShareDirectoryClient.forceCloseHandleの応答タイプ。
DirectoryGetPropertiesResponse	getProperties 操作の応答データを格納します。
DirectoryListFilesAndDirectoriesSegmentResponse	listFilesAndDirectoriesSegment 操作の応答データを格納します。
DirectoryListHandlesResponse	listHandles 操作の応答データを格納します。
DirectoryRenameResponse	名前変更操作の応答データが含まれています。
DirectorySetMetadataResponse	setMetadata 操作の応答データが含まれています。
DirectorySetPropertiesResponse	setProperties 操作の応答データを格納します。
FileAbortCopyResponse	abortCopy 操作の応答データを格納します。
FileAttributesPreserveType	既存のファイル属性を変更せずに保持します。
FileCreateHardLinkResponse	ハード リンクの作成操作の応答データが含まれています。
FileCreateResponse	作成操作の応答データが含まれています。
FileCreateSymbolicLinkResponse	ハード リンクの作成操作の応答データが含まれています。
FileDeleteResponse	削除操作の応答データが含まれています。
FileDownloadResponseModel	ダウンロード操作の応答データが含まれています。
FileForceCloseHandlesResponse	ShareFileClient.forceCloseHandleのレスポンスタイプ。
FileGetPropertiesResponse	getProperties 操作の応答データを格納します。
FileGetRangeListDiffResponse	getRangeList 操作の応答データを格納します。
FileGetRangeListResponse	ShareFileClient.getRangeList 操作の応答データが含まれています。
FileGetSymbolicLinkResponse	ハード リンクの作成操作の応答データが含まれています。
FileLastWrittenMode	FileLastWrittenMode の値を定義します。
FileListHandlesResponse	listHandles 操作の応答データを格納します。
FileListRangesSegmentResponse	ShareFileClient.listRangesおよびShareFileClient.listRangesDiff操作の結果が1ページ含まれています。
FilePermissionFormat	FilePermissionFormat の値を定義します。
FilePermissionInheritType	親ディレクトリからのファイルの継承権限を示します。
FilePermissionPreserveType	既存のファイル権限の値を変更せずに保持します。
FileRenameResponse	名前変更操作の応答データが含まれています。
FileSetHTTPHeadersResponse	setHttpHeaders 操作の応答データを格納します。
FileSetMetadataResponse	setMetadata 操作の応答データが含まれています。
FileStartCopyResponse	startCopy 操作の応答データを格納します。
FileUploadRangeFromURLResponse	uploadRangeFromURL 操作の応答データが含まれています。
FileUploadRangeResponse	uploadRange 操作の応答データが含まれています。
HttpRequestBody	要求でサポートされる本文の種類。 NodeReadableStream と () => NodeReadableStream はノード専用です。 Blob、WebReadableStream<Uint8Array>、および() => WebReadableStream<Uint8Array> はブラウザ専用です。
LeaseDurationType	LeaseDurationType の値を定義します。
LeaseOperationResponse	リースを取得、変更、中断、または解放する操作の応答データを格納します。 「 ShareLeaseClient」を参照してください。
LeaseStateType	LeaseStateType の値を定義します。
LeaseStatusType	LeaseStatusType の値を定義します。
ListSharesIncludeType	ListSharesIncludeType の値を定義します。
ModeCopyMode	ModeCopyMode の値を定義します。
NfsFileType	NfsFileType の値を定義します。 NfsFileType と同じ意味で使用できる <xref:KnownNfsFileType>、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 Regular Directory SymLink
OwnerCopyMode	OwnerCopyMode の値を定義します。
PermissionCopyModeType	PermissionCopyModeType の値を定義します。
RawFileDownloadResponse	ダウンロード操作の応答データが含まれています。
ServiceGetPropertiesResponse	getProperties 操作の応答データを格納します。
ServiceGetUserDelegationKeyResponse	getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions) 操作の応答データが含まれています。
ServiceListSharesSegmentResponse	ShareServiceClient.listShares操作の応答データが含まれています。
ServiceSetPropertiesResponse	setProperties 操作の応答データを格納します。
ShareAccessTier	ShareAccessTier の値を定義します。
ShareClientOptions
ShareCreatePermissionResponse	createPermission 操作の応答データが含まれています。
ShareCreateResponse	作成操作の応答データが含まれています。
ShareCreateSnapshotResponse	createSnapshot 操作の応答データが含まれています。
ShareDeleteResponse	削除操作の応答データが含まれています。
ShareFileHandleAccessRights	AccessRight の値を定義します。
ShareGetAccessPolicyResponse
ShareGetPermissionResponse	getPermission 操作の応答データが含まれています。
ShareGetPropertiesResponse	ShareClient.getProperties操作の応答データが含まれています。
ShareGetPropertiesResponseModel	getProperties 操作の応答データを格納します。
ShareGetStatisticsResponse	ShareClient.getStatistics操作の応答データ。
ShareGetStatisticsResponseModel	getStatistics 操作の応答データを格納します。
ShareProperties	共有のプロパティ。
ShareRootSquash	ShareRootSquash の値を定義します。
ShareSetAccessPolicyResponse	setAccessPolicy 操作の応答データを格納します。
ShareSetMetadataResponse	setMetadata 操作の応答データが含まれています。
ShareSetPropertiesResponse	setProperties 操作の応答データを格納します。
ShareSetQuotaHeaders	setQuota 操作のヘッダーを定義します。
ShareSetQuotaResponse	setQuota 操作の応答データを格納します。
ShareTokenIntent	ShareTokenIntent の値を定義します。 KnownShareTokenIntent ShareTokenIntent と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 backup
StorageChecksumAlgorithm	コンテンツ検証で使用されるチェックサムアルゴリズムを示すためです。
TimeNowType	要求の時刻として設定を示します。
TimePreserveType	既存の時刻値を変更せずに保持します。
WithResponse	既知の_response プロパティを持つ操作の結果を表す型。

列挙型

KnownShareTokenIntent	サービス 受け入れる ShareTokenIntent の既知の値。
SASProtocol	生成された SAS のプロトコル。
StorageFileAudience	Storage の既知のクラウド対象ユーザーを定義します。
StorageRetryPolicyType	RetryPolicy 型。

関数

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	NODE.JSランタイムでのみ使用できます。 実際の REST 要求を行うために必要なすべての SAS クエリ パラメーターを含む、SASQueryParameters オブジェクトを生成します。 https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas を参照してください
generateFileSASQueryParameters(FileSASSignatureValues, UserDelegationKey, string)
generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)
getFileServiceAccountAudience(string)	ファイル サービスのストレージ アカウントの OAuth 対象ユーザーを取得します。
isPipelineLike(unknown)	指定された引数がパイプライン コントラクトを満たすかどうかを判断するヘルパー
isRestError(unknown)	RestError の Typeguard
newPipeline(Credential | TokenCredential, StoragePipelineOptions)	Credential が指定された新しい Pipeline オブジェクトを作成します。
parseOctalFileMode(string)	ファイル モードの 4 桁の 8 進数文字列表現を NfsFileMode 構造体に解析します。
parseSymbolicFileMode(string)	ファイル モードの 9 文字のシンボリック文字列表現を NfsFileMode 構造体に解析します。
toOctalFileMode(NfsFileMode)	NfsFileMode 構造体 4 桁の 8 進数文字列の再表現に変換します。
toSymbolicFileMode(NfsFileMode)	NfsFileMode をシンボリック表記で文字列に変換します。

変数

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

generateFileSASQueryParameters(FileSASSignatureValues, UserDelegationKey, string)

function generateFileSASQueryParameters(fileSASSignatureValues: FileSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters

パラメーター

fileSASSignatureValues

FileSASSignatureValues

userDelegationKey

UserDelegationKey

accountName

string

返品

SASQueryParameters

generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)

function generateFileSASQueryParameters(fileSASSignatureValues: FileSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

パラメーター

fileSASSignatureValues

FileSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

返品

SASQueryParameters

getFileServiceAccountAudience(string)

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

function getFileServiceAccountAudience(storageAccountName: string): string

パラメーター

storageAccountName

string

返品

string

isPipelineLike(unknown)

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

function isPipelineLike(pipeline: unknown): pipeline is PipelineLike

パラメーター

pipeline

unknown

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

返品

pipeline is PipelineLike

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

isRestError(unknown)

RestError の Typeguard

function isRestError(e: unknown): e is RestError

パラメーター

e

unknown

catch 句によってキャッチされる何か。

返品

e is RestError

newPipeline(Credential | TokenCredential, StoragePipelineOptions)

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

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

パラメーター

credential

Credential | TokenCredential

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

pipelineOptions

StoragePipelineOptions

Optional. Options.

返品

Pipeline

新しい Pipeline オブジェクト。

parseOctalFileMode(string)

ファイル モードの 4 桁の 8 進数文字列表現を NfsFileMode 構造体に解析します。

function parseOctalFileMode(input?: string): NfsFileMode | undefined

パラメーター

input

string

返品

NfsFileMode | undefined

parseSymbolicFileMode(string)

ファイル モードの 9 文字のシンボリック文字列表現を NfsFileMode 構造体に解析します。

function parseSymbolicFileMode(input?: string): NfsFileMode | undefined

パラメーター

input

string

返品

NfsFileMode | undefined

toOctalFileMode(NfsFileMode)

NfsFileMode 構造体 4 桁の 8 進数文字列の再表現に変換します。

function toOctalFileMode(input?: NfsFileMode): string | undefined

パラメーター

input

NfsFileMode

返品

string | undefined

toSymbolicFileMode(NfsFileMode)

NfsFileMode をシンボリック表記で文字列に変換します。

function toSymbolicFileMode(input?: NfsFileMode): string | undefined

パラメーター

input

NfsFileMode

返品

string | undefined

変数の詳細

RestError

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

RestError: RestErrorConstructor

型

RestErrorConstructor

StorageOAuthScopes

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

StorageOAuthScopes: string | string[]

型

string | string[]

logger

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

logger: AzureLogger

型

AzureLogger