@azure/storage-file-datalake 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) 要求に署名するために使用される資格情報ポリシー。 これは抽象クラスです。
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 でシリアル化し、DataLakeSASSignatureValues オブジェクトの権限フィールドとして設定する必要があります。 このクラスを使用せずにアクセス許可文字列を構築することはできますが、アクセス許可の順序は特定であり、このクラスは正確性を保証します。
DataLakeServiceClient

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

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

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

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

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

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

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

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

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

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

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

Node.jsでは、このポリシーは no-op パススルーです。
StorageBrowserPolicyFactory

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

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

StorageRetryPolicyFactory は、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) を生成するために使用されます。 ここでのすべての値が適切に設定されたら、generateAccountSASQueryParameters を呼び出して、Data Lake 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 を参照してください。これには、必要なパラメーターが含まれます。
BlobHierarchyListSegment
BlobItemModel

Azure Storage BLOB
BlobPrefix
BlobPropertiesModel

BLOB のプロパティ
CommonGenerateSasUrlOptions

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

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

パラメーター グループ
DataLakeClientConfig

Datalakeクライアントインスタンスの作成に使われる設定。
DataLakeGetUserDelegationKeyParameters

ユーザー委任キーを取得するためのパラメータ。
DataLakeRequestConditions

パラメーター グループ
DataLakeSASSignatureValues

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

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

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

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

DataLakePathClient.createIfNotExists操作の応答データが含まれています。
DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions

DataLakeDirectoryClient.generateSasUrl操作の設定オプション。
FileAppendOptions

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

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

DataLakePathClient.createIfNotExists操作の応答データが含まれています。
FileCreateOptions

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

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

DataLakeFileClient.generateSasUrl操作の設定オプション。
FileParallelUploadOptions

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

See:
FileQueryCsvTextConfiguration

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

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

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

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

See:
FileQueryParquetConfiguration

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

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

See:
FileSetExpiryHeaders

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

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

DataLakeFileSystemClient.createIfNotExists操作のレスポンスデータが含まれています。
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse

DataLakeFileSystemClient.deleteIfExists操作のレスポンスデータが含まれています。
FileSystemDeleteOptions

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

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

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

See:
FileSystemGenerateSasUrlOptions

DataLakeFileSystemClient.generateSasUrl操作の設定オプション。
FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions

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

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

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

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

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

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

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

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

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

特定のリースの詳細。
LeaseAccessConditions

パラメーター グループ
LeaseOperationOptions

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

BLOB の列挙
ListDeletedPathsOptions

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

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

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

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

destroy メソッドも含む読み取り可能な Node.js ストリーム。
Path
PathAccessControl
PathAccessControlItem
PathAppendDataHeaders

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

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

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

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

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

DataLakePathClient.createIfNotExists操作の応答データが含まれています。
PathCreateOptions

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

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

DataLakePathClient.deleteIfExists操作の応答データが含まれています。
PathDeleteOptions

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

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

See:
PathFlushDataHeaders

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

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

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

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

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

DataLakePathClient.getSystemProperties 操作の設定オプション。
PathGetTagsHeaders

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

DataLakePathClient.getTags操作の設定オプション。
PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions

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

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

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

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

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

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

Path_setTags操作のためのヘッダーを定義します。
PathSetTagsOptions

DataLakePathClient.setTags操作の設定オプション。
PathUndeleteHeaders

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

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

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

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

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

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

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

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

SASQueryParameters 構築するオプション。
SasIPRange

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

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

DataLakeServiceClient.generateAccountSasUrl 操作の設定オプション。
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions

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

DataLakeServiceClient.undeleteFileSystemの設定オプション。
SignedIdentifier
StoragePipelineOptions

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

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

パスタグに基づく条件付き要求のHTTPオプションを指定します。
UserDelegationKey

ユーザー委任キー。
UserDelegationKeyModel

ユーザー委任キー
WebResource

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

型エイリアス

AccessControlType
CopyStatusType
CredentialPolicyCreator

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

DataLakeFileClientインスタンスを作成するオプション
DataLakeFileSystemClientOptions

DataLakeFileSystemClientインスタンスを作成するオプション
DataLakePathClientOptions

DataLakePathClientインスタンスを作成するためのオプション
DataLakeServiceClientOptions

DataLakeServiceClientインスタンスを作成するためのオプション
DataLakeServiceGetPropertiesResponse

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

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

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

None
AES256
FileAppendResponse
FileExpiryMode

PathExpiryOptions の値を定義します。
FileFlushResponse
FileQueryArrowConfiguration

Apache Arrow 形式でファイルにクエリを実行するオプション。 FileQueryOptions.outputTextConfigurationでのみ有効です。
FileReadResponse
FileSetExpiryResponse
FileSystemCreateResponse
FileSystemDeleteResponse
FileSystemGetAccessPolicyResponse
FileSystemGetPropertiesResponse
FileSystemListDeletedPathsResponse
FileSystemListPathsResponse
FileSystemRenameResponse

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

DataLakeServiceClient.undeleteFileSystem操作の応答データが含まれています。
FileUploadResponse
HttpRequestBody

要求でサポートされる本文の種類。 NodeReadableStream と () => NodeReadableStream はノード専用です。 Blob、WebReadableStream<Uint8Array>、および() => WebReadableStream<Uint8Array> はブラウザ専用です。
LeaseDurationType
LeaseOperationResponse

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

<xref:BlobLeaseClient>を参照してください。
LeaseStateType
LeaseStatusType
ModifiedAccessConditions
PathCreateResponse
PathDeleteResponse
PathGetAccessControlResponse
PathGetPropertiesActionModel

PathGetPropertiesAction の値を定義します。
PathGetPropertiesResponse
PathGetSystemPropertiesResponse

DataLakePathClient.getSystemProperties操作の応答データが含まれています。
PathGetTagsResponse

DataLakePathClient.getTags操作の応答データが含まれています。
PathMoveResponse
PathRenameModeModel

PathRenameMode の値を定義します。
PathResourceTypeModel

PathResourceType の値を定義します。
PathSetAccessControlResponse
PathSetHttpHeadersResponse
PathSetMetadataResponse
PathSetPermissionsResponse
PathSetTagsResponse

DataLakePathClient.setTags操作の応答データが含まれています。
PublicAccessType
RequestHeaders

SASトークン生成に使用されるリクエストヘッダー
RequestQueryParameters

SASトークン生成に用いられるリクエストクエリパラメータ
ServiceGetUserDelegationKeyResponse
ServiceListContainersSegmentResponse

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

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

コンテンツ検証で使用されるチェックサムアルゴリズムを示すためです。

列挙型

PathGetPropertiesAction

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

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

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

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

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

RetryPolicy 型。

関数

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

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

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

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

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

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

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

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

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

Example

// 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();

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

Example

// 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();
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

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

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

Example

// 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();
getDataLakeServiceAccountAudience(string)

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

指定された引数がパイプライン コントラクトを満たすかどうかを判断するヘルパー
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

変数

RestError

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

Azure Storageで使うOAuthのスコープについて。
ToBlobEndpointHostMappings
ToDfsEndpointHostMappings
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

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

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

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

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

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

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

Example

// 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();

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

Example

// 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();

function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

パラメーター

dataLakeSASSignatureValues
DataLakeSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

返品

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

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

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

Example

// 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();

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

パラメーター

dataLakeSASSignatureValues
DataLakeSASSignatureValues
userDelegationKey
UserDelegationKey

blobServiceClient.getUserDelegationKey() の戻り値

accountName

string

返品

SASQueryParameters

getDataLakeServiceAccountAudience(string)

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

function getDataLakeServiceAccountAudience(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[]

ToBlobEndpointHostMappings 

ToBlobEndpointHostMappings: string[][]

型

string[][]

ToDfsEndpointHostMappings 

ToDfsEndpointHostMappings: string[][]

型

string[][]

logger

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

logger: AzureLogger

型

AzureLogger