@azure/storage-file-datalake 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 Signature (SAS) で使用する要求で使用されます。

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

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

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

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

操作が中断されたときにスローされ、後で続行できるエラー。

DataLakeDirectoryClient は、Azure Storage ディレクトリへの URL を表します。

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

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

DataLakePathClient は、Azure Storage パス (ディレクトリまたはファイル) への URL を表します。

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

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

DataLakeServiceClient を使用すると、Azure Data Lake サービスのリソースとファイル システムを操作できます。 ストレージ アカウントは、Data Lake サービスの最上位レベルの名前空間を提供します。

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

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

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

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

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

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

StorageBrowserPolicy は、次のような Node.js とブラウザー ランタイムの違いを処理します。

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

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

3. ブラウザーの警告を回避するために content-length ヘッダーを削除する

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

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

StorageRetryPolicyFactory は、StorageRetryPolicy オブジェクト 生成するのに役立つファクトリ クラスです。

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

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

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

AccessControlChangeCounters には、アクセス制御リストを再帰的に変更する操作の数が含まれています。

setAccessControlRecursive、updateAccessControlRecursive、および removeAccessControlRecursive中にアクセス制御リストの更新に失敗したエントリを表します。

AccessControlChanges には、アクセス制御リストを再帰的に変更する操作のバッチ数と累積カウントが含まれています。 さらに、これらの操作の進行中に更新に失敗したパス エントリも公開されます。

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

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

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

Azure Storage BLOB

BLOB のプロパティ

FileSystemGenerateSasUrlOptions、DirectoryGenerateSasUrlOptions、FileGenerateSasUrlOptionsの一般的なオプション。

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

パラメーター グループ

パラメーター グループ

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

DataLakeSASSignatureValues は、コンテナー、BLOB、ファイルシステム、ディレクトリ、ファイルの BLOB および DataLake サービス SAS トークンの生成に使用されます。

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

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

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

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

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

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

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

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

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

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

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

見る：

• アップロードする
• uploadFile を する
• uploadStream を する

CSV 形式でファイルにクエリを実行するオプション。

ファイル クエリエラーの種類。

JSON 形式でファイルにクエリを実行するオプション。

Data Lake ファイルのオプション インターフェイス - クエリ操作

見る：

• クエリ

Parquet 形式でファイルにクエリを実行するオプション。

Data Lake ファイルのオプション インターフェイス - readToBuffer 操作

見る：

• readToBuffer を する

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

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

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

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

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

ファイル システムで暗号化スコープを指定するオプション。

Data Lake ファイル システムのオプション インターフェイスが存在する操作

見る：

• が存在

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

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

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

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

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

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

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

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

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

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

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

特定のリースの詳細。

パラメーター グループ

リース操作を構成します。

BLOB の列挙

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

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

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

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

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

setAccessControlRecursive、updateAccessControlRecursive、および removeAccessControlRecursiveのオプションの種類。

setAccessControlRecursive、updateAccessControlRecursive、removeAccessControlRecursiveの応答の種類。

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

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

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

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

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

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

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

Data Lake ディレクトリ/ファイルのオプション インターフェイスが存在する操作

見る：

• が存在

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

SASQueryParameters 構築するオプション。

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

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

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

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

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

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

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

ユーザー委任キー

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

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

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

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

なし
AES256

PathExpiryOptions の値を定義します。

Apache Arrow 形式でファイルにクエリを実行するオプション。 outputTextConfigurationでのみ有効です。

<xref:DataLakeServiceClient.renameFileSystem> 操作の応答データが含まれています。

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

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

リースを作成、変更、または削除する操作の応答データを格納します。

<xref:BlobLeaseClient>を参照してください。

PathGetPropertiesAction の値を定義します。

PathRenameMode の値を定義します。

PathResourceType の値を定義します。

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

<xref:DataLakeServiceClient.renameFileSystem>を構成するオプション。

PathGetPropertiesAction の値を定義します。 使用可能な値は、'getAccessControl'、'getStatus' です。

PathRenameMode の値を定義します。 使用可能な値は、'legacy'、'posix' です。

PathResourceType の値を定義します。 指定できる値は、'directory'、'file' です。

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

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

RetryPolicy 型。

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

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

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

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

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

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

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

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

例

// Generate service level SAS for a file system
const containerSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

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

例

// Generate service level SAS for a file
const fileSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    fileName, // Required
    permissions: DataLakeSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

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

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

例

// Generate user delegation SAS for a file system
const userDelegationKey = await dataLakeServiceClient.getUserDelegationKey(startsOn, expiresOn);
const fileSystemSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: FileSystemSASPermissions.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();

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

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

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