@azure/storage-file-datalake 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) で使用する要求で使用されます。
Credential	資格情報は、Azure Storage HTTP 要求の署名のための抽象クラスです。 このクラスは、CredentialPolicy を生成する credentialPolicyCreator ファクトリをホストします。
CredentialPolicy	送信前に HTTP(S) 要求に署名するために使用される資格情報ポリシー。 これは抽象クラスです。
DataLakeAclChangeFailedError	操作が中断されたときにスローされ、後で続行できるエラー。
DataLakeDirectoryClient	DataLakeDirectoryClient は、Azure Storage ディレクトリへの URL を表します。
DataLakeFileClient	DataLakeFileClient は、Azure Storage ファイルの URL を表します。
DataLakeFileSystemClient	DataLakeFileSystemClient は、Azure Storage ファイル システムへの URL を表し、ディレクトリとファイルを操作できます。
DataLakeLeaseClient
DataLakePathClient	DataLakePathClient は、Azure Storage パス (ディレクトリまたはファイル) への URL を表します。
DataLakeSASPermissions	NODE.JSランタイムでのみ使用できます。 これは、ServiceSAS によって付与されるアクセス許可を表す文字列を構築するためのヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS にその操作のアクセス許可が付与されます。 すべての値が設定されたら、これを toString でシリアル化し、<xref:DataLakeSASSignatureValues> オブジェクトの権限フィールドとして設定する必要があります。 このクラスを使用せずにアクセス許可文字列を構築することはできますが、アクセス許可の順序は特定であり、このクラスは正確性を保証します。
DataLakeServiceClient	DataLakeServiceClient を使用すると、Azure Data Lake サービスのリソースとファイル システムを操作できます。 ストレージ アカウントは、Data Lake サービスの最上位レベルの名前空間を提供します。
DirectorySASPermissions	これは、ServiceSAS によってディレクトリに付与されるアクセス許可を表す文字列を構築するためのヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS にその操作のアクセス許可が付与されます。 すべての値が設定されたら、これを toString でシリアル化し、<xref:DataLakeSASSignatureValues> オブジェクトの権限フィールドとして設定する必要があります。 このクラスを使用せずにアクセス許可文字列を構築することはできますが、アクセス許可の順序は特定であり、このクラスは正確性を保証します。
FileSystemSASPermissions	これは、ServiceSAS によってコンテナーに付与されるアクセス許可を表す文字列を構築するためのヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS にその操作のアクセス許可が付与されます。 すべての値が設定されたら、これを toString でシリアル化し、<xref:DataLakeSASSignatureValues> オブジェクトの権限フィールドとして設定する必要があります。 このクラスを使用せずにアクセス許可文字列を構築することはできますが、アクセス許可の順序は特定であり、このクラスは正確性を保証します。
Pipeline	HTTP 要求ポリシーを含む Pipeline クラス。 <xref:newPipeline>を呼び出すことで、既定のパイプラインを作成できます。 または、Pipeline のコンストラクターによって独自のポリシーを使用してパイプラインを作成することもできます。 カスタマイズしたパイプラインを実装する前に、<xref:newPipeline> および指定されたポリシーを参照してください。
SASQueryParameters	Azure Storage SAS のクエリ パラメーターを構成するコンポーネントを表します。 この型は、ユーザーによって直接構築されるわけではありません。これは、<xref:AccountSASSignatureValues> 型と <xref:BlobSASSignatureValues> 型によってのみ生成されます。 生成されると、<xref:String> にエンコードして URL に直接追加できます (ただし、既存のクエリ パラメーターがある場合は注意が必要です。これらのクエリ パラメーターを追加する適切な方法に影響する可能性があります)。 注: このクラスのインスタンスは不変です。
StorageBrowserPolicy	StorageBrowserPolicy は、次のような Node.js とブラウザー ランタイムの違いを処理します。 ブラウザーは、"IF_MODIFIED_SINCE" などの条件付きヘッダーを追加して GET/HEAD 要求をキャッシュします。 StorageBrowserPolicy は、GET/HEAD 要求 URL にタイムスタンプ クエリを追加するために使用されるポリシーであり、ブラウザーのキャッシュを回避します。 セキュリティのために Cookie ヘッダーを削除する ブラウザーの警告を回避するために content-length ヘッダーを削除する
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 要求に署名するために使用されるポリシーです。

インターフェイス

AccessControlChangeCounters	AccessControlChangeCounters には、アクセス制御リストを再帰的に変更する操作の数が含まれています。
AccessControlChangeError	setAccessControlRecursive、updateAccessControlRecursive、および removeAccessControlRecursive中にアクセス制御リストの更新に失敗したエントリを表します。
AccessControlChanges	AccessControlChanges には、アクセス制御リストを再帰的に変更する操作のバッチ数と累積カウントが含まれています。 さらに、これらの操作の進行中に更新に失敗したパス エントリも公開されます。
AccessPolicy
AccountSASSignatureValues	NODE.JSランタイムでのみ使用できます。 AccountSASSignatureValues は、Azure Storage アカウントの Shared Access Signature (SAS) を生成するために使用されます。 ここでのすべての値が適切に設定されたら、<xref:generateAccountSASQueryParameters> を呼び出して、実際にデータ レイク URL に適用できる SAS の表現を取得します。 注: 前者は変更可能であり、論理表現であるのに対し、後者は不変であり、実際の REST 要求の生成に使用されるため、このクラスと <xref:SASQueryParameters> の両方が存在します。
BlobHierarchyListSegment
BlobItemModel	Azure Storage BLOB
BlobPrefix
BlobPropertiesModel	BLOB のプロパティ
CommonGenerateSasUrlOptions	<xref:FileSystemGenerateSasUrlOptions>、<xref:DirectoryGenerateSasUrlOptions>、<xref:FileGenerateSasUrlOptions>の一般的なオプション。
CommonOptions	すべてのリモート操作に共通するオプションのインターフェイス。
DataLakeRequestConditions
DataLakeSASSignatureValues	NODE.JSランタイムでのみ使用できます。 DataLakeSASSignatureValues は、コンテナー、BLOB、ファイルシステム、ディレクトリ、ファイルの BLOB および DataLake サービス SAS トークンの生成に使用されます。
DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions
DirectoryCreateIfNotExistsResponse
DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions	<xref:DataLakeDirectoryClient.generateSasUrl> 操作を構成するオプション。
FileAppendOptions
FileCreateIfNotExistsOptions
FileCreateIfNotExistsResponse
FileCreateOptions
FileCreateResponse
FileFlushOptions
FileGenerateSasUrlOptions	<xref:DataLakeFileClient.generateSasUrl> 操作を構成するオプション。
FileParallelUploadOptions	Data Lake ファイルのオプション インターフェイス - アップロード操作については、次を参照してください。 <xref:DataLakeFileClient.upload> <xref:DataLakeFileClient.uploadFile> <xref:DataLakeFileClient.uploadStream>
FileQueryCsvTextConfiguration	CSV 形式でファイルにクエリを実行するオプション。
FileQueryError	ファイル クエリエラーの種類。
FileQueryJsonTextConfiguration	JSON 形式でファイルにクエリを実行するオプション。
FileQueryOptions	Data Lake ファイルのオプション インターフェイス - クエリ操作: <xref:DataLakeFileClient.query>
FileQueryParquetConfiguration	Parquet 形式でファイルにクエリを実行するオプション。
FileReadHeaders
FileReadOptions
FileReadToBufferOptions	Data Lake ファイルのオプション インターフェイス - readToBuffer 操作 次を参照してください。 <xref:DataLakeFileClient.readToBuffer>
FileSetExpiryHeaders	Path_setExpiry操作のヘッダーを定義します。
FileSetExpiryOptions	<xref:DataLakeFileClient.setExpiry> 操作のオプション インターフェイス。
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse	<xref:DataLakeFileSystemClient.createIfNotExists> 操作の応答データが含まれています。
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse	<xref:DataLakeFileSystemClient.deleteIfExists> 操作の応答データが含まれています。
FileSystemDeleteOptions
FileSystemExistsOptions	Data Lake ファイル システムのオプション インターフェイスが存在する操作については、次を参照してください。 <xref:DataLakeFileSystemClient.exists>
FileSystemGenerateSasUrlOptions	<xref:DataLakeFileSystemClient.generateSasUrl> 操作を構成するオプション。
FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions
FileSystemGetPropertiesHeaders
FileSystemGetPropertiesOptions
FileSystemItem
FileSystemListBlobHierarchySegmentHeaders	FileSystem_listBlobHierarchySegment操作のヘッダーを定義します。
FileSystemListPathsHeaders	FileSystem_listPaths操作のヘッダーを定義します。
FileSystemProperties
FileSystemSetAccessPolicyHeaders
FileSystemSetAccessPolicyOptions
FileSystemSetMetadataHeaders
FileSystemSetMetadataOptions
FileSystemUndeletePathOption
ListBlobsHierarchySegmentResponse	BLOB の列挙
ListDeletedPathsOptions
ListDeletedPathsSegmentOptions
ListFileSystemsSegmentResponse
ListPathsOptions
ListPathsSegmentOptions
Metadata
Path
PathAccessControl
PathAccessControlItem
PathAppendDataHeaders	Path_appendData操作のヘッダーを定義します。
PathChangeAccessControlRecursiveOptions	setAccessControlRecursive、updateAccessControlRecursive、および removeAccessControlRecursiveのオプションの種類。
PathChangeAccessControlRecursiveResponse	setAccessControlRecursive、updateAccessControlRecursive、removeAccessControlRecursiveの応答の種類。
PathCreateHeaders	Path_create操作のヘッダーを定義します。
PathCreateHttpHeaders
PathCreateIfNotExistsOptions
PathCreateIfNotExistsResponse	<xref:DataLakePathClient.createIfNotExists> 操作の応答データが含まれています。
PathCreateOptions
PathDeleteHeaders	Path_delete操作のヘッダーを定義します。
PathDeleteIfExistsResponse	<xref:DataLakePathClient.deleteIfExists> 操作の応答データが含まれています。
PathDeleteOptions
PathExistsOptions	Data Lake ディレクトリ/ファイルのオプション インターフェイスの操作については、次を参照してください。 <xref:DataLakePathClient.exists>
PathFlushDataHeaders	Path_flushData操作のヘッダーを定義します。
PathGetAccessControlHeaders
PathGetAccessControlOptions
PathGetPropertiesHeaders
PathGetPropertiesHeadersModel	Path_getProperties操作のヘッダーを定義します。
PathGetPropertiesOptions
PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions
PathPermissions
PathRemoveHeaders
PathSetAccessControlHeaders	Path_setAccessControl操作のヘッダーを定義します。
PathSetAccessControlOptions
PathSetHttpHeadersHeaders
PathSetHttpHeadersOptions
PathSetMetadataHeaders
PathSetMetadataOptions
PathSetPermissionsOptions
PathUndeleteHeaders	Path_undelete操作のヘッダーを定義します。
PathUpdateHeaders	Path_update操作のヘッダーを定義します。
PipelineOptions	パイプライン コンストラクターのオプション インターフェイス。
RawAccessPolicy
RemovePathAccessControlItem
RolePermissions
SASQueryParametersOptions	<xref:SASQueryParameters>を構築するオプション。
SasIPRange	SAS に対して許可される IP 範囲。
ServiceGenerateAccountSasUrlOptions	<xref:DataLakeServiceClient.generateAccountSasUrl> 操作を構成するオプション。
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions
ServiceListFileSystemsSegmentHeaders
ServiceUndeleteFileSystemOptions	<xref:DataLakeServiceClient.undeleteFileSystem>を構成するオプション。
SignedIdentifier
StorageClientOptionalParams	省略可能なパラメーター。
StoragePipelineOptions	<xref:newPipeline> 関数のオプション インターフェイス。
StorageRetryOptions	ストレージ BLOB 再試行オプション インターフェイス。
UserDelegationKey

型エイリアス

AccessControlType
CopyStatusType
CredentialPolicyCreator	指定された nextPolicy を使用する新しい CredentialPolicy を作成するファクトリ関数。
FileAppendResponse	appendData 操作の応答データを格納します。
FileExpiryMode	PathExpiryOptions の値を定義します。
FileQueryArrowConfiguration	Apache Arrow 形式でファイルにクエリを実行するオプション。 <xref:FileQueryOptions.outputTextConfiguration>でのみ有効です。
FileReadResponse
FileSetExpiryResponse	setExpiry 操作の応答データを格納します。
FileSystemCreateResponse
FileSystemDeleteResponse
FileSystemGetAccessPolicyResponse
FileSystemGetPropertiesResponse
FileSystemListDeletedPathsResponse
FileSystemListPathsResponse
FileSystemRenameResponse	<xref:DataLakeServiceClient.renameFileSystem> 操作の応答データが含まれています。
FileSystemSetAccessPolicyResponse
FileSystemSetMetadataResponse
FileSystemUndeletePathResponse
FileSystemUndeleteResponse	<xref:DataLakeServiceClient.undeleteFileSystem> 操作の応答データが含まれています。
LeaseDurationType
LeaseStateType
LeaseStatusType
ListPathsSegmentResponse	listPaths 操作の応答データを格納します。
ModifiedAccessConditions
PathCreateResponse	作成操作の応答データが含まれています。
PathDeleteResponse	削除操作の応答データが含まれています。
PathFlushDataResponse	flushData 操作の応答データを格納します。
PathGetAccessControlResponse
PathGetPropertiesActionModel	PathGetPropertiesAction の値を定義します。
PathGetPropertiesResponse
PathMoveResponse
PathRenameModeModel	PathRenameMode の値を定義します。
PathResourceTypeModel	PathResourceType の値を定義します。
PathSetAccessControlResponse	setAccessControl 操作の応答データを格納します。
PathSetHttpHeadersResponse
PathSetMetadataResponse
PublicAccessType
ServiceGetUserDelegationKeyResponse
ServiceListFileSystemsSegmentResponse
ServiceRenameFileSystemOptions	<xref:DataLakeServiceClient.renameFileSystem>を構成するオプション。

列挙型

PathGetPropertiesAction	PathGetPropertiesAction の値を定義します。 使用可能な値は、'getAccessControl'、'getStatus' です。
PathRenameMode	PathRenameMode の値を定義します。 使用可能な値は、'legacy'、'posix' です。
PathResourceType	PathResourceType の値を定義します。 指定できる値は、'directory'、'file' です。
SASProtocol	生成された SAS のプロトコル。
StorageRetryPolicyType	RetryPolicy 型。

関数

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	NODE.JSランタイムでのみ使用できます。 実際の REST 要求を行うために必要なすべての SAS クエリ パラメーターを含む <xref:SASQueryParameters> オブジェクトを生成します。
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)	NODE.JSランタイムでのみ使用できます。 SASQueryParameters のインスタンスを作成します。 SAS の作成に必要な設定のみを受け入れます。 オプションの設定については、アクセス許可、startsOn、識別子など、対応するプロパティを直接設定してください。 警告: 識別子が指定されていない場合、アクセス許可と expiresOn が必要です。 このコンストラクターを最初に使用する場合は、識別子または expiresOn & アクセス許可に値を手動で割り当てる必要があります。 次のスニペットを実行する前に、必要な詳細を入力します。
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)	NODE.JSランタイムでのみ使用できます。 SASQueryParameters のインスタンスを作成します。 警告: ユーザー委任 SAS を生成するときに識別子は無視されます。アクセス許可と expiresOn が必要です。
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	Credential が指定された新しい Pipeline オブジェクトを作成します。

関数の詳細

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

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

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

パラメーター

accountSASSignatureValues

AccountSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

戻り値

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

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

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

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

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

function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

パラメーター

dataLakeSASSignatureValues

DataLakeSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

戻り値

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

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

function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string)

パラメーター

dataLakeSASSignatureValues

DataLakeSASSignatureValues

userDelegationKey

UserDelegationKey

blobServiceClient.getUserDelegationKey() の戻り値

accountName

string

戻り値

SASQueryParameters

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

新しい Pipeline オブジェクト。