次の方法で共有

@azure/storage-file-datalake package

  • リファレンス

クラス

AccountSASPermissions

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

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

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

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

失敗したパイプライン要求のカスタム エラーの種類。
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 ヘッダーを削除する
StorageBrowserPolicyFactory

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

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

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

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

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

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

インターフェイス

AccessControlChangeCounters

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

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

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

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

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

https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 SAS の概念の詳細については、パラメーターの説明 (必須を含む) を参照してくださいhttps://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas。
BlobHierarchyListSegment
BlobItemModel

Azure Storage BLOB
BlobPrefix
BlobPropertiesModel

BLOB のプロパティ
CommonGenerateSasUrlOptions

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

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

パラメーター グループ
DataLakeRequestConditions

パラメーター グループ
DataLakeSASSignatureValues

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

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

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

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

createIfNotExists 操作の応答データを格納します。
DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions

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

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

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

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

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

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

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

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

参照トピック
FileQueryCsvTextConfiguration

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

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

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

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

参照トピック
FileQueryParquetConfiguration

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

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

参照トピック
FileSetExpiryHeaders

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

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

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

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

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

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

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

参照トピック
FileSystemGenerateSasUrlOptions

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 応答。
IHttpClient

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

特定のリースの詳細。
LeaseAccessConditions

パラメーター グループ
LeaseOperationOptions

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

BLOB の列挙
ListDeletedPathsOptions

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

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

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

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

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

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

、updateAccessControlRecursiveおよび removeAccessControlRecursiveの応答のsetAccessControlRecursive種類。
PathCreateHeaders

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

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

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

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

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

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

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

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

参照トピック
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操作のヘッダーを定義します。
PipelineLike

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

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

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

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

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

SASQueryParameters を構築するためのオプション。
SasIPRange

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

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

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

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

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

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

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

ユーザー委任キー
WebResource

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

型エイリアス

AccessControlType
CopyStatusType
DataLakeServiceGetPropertiesResponse

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

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

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

なし
AES256
FileAppendResponse
FileExpiryMode

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

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

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

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

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

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

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

PathGetPropertiesAction の値を定義します。
PathGetPropertiesResponse
PathMoveResponse
PathRenameModeModel

PathRenameMode の値を定義します。
PathResourceTypeModel

PathResourceType の値を定義します。
PathSetAccessControlResponse
PathSetHttpHeadersResponse
PathSetMetadataResponse
PathSetPermissionsResponse
PublicAccessType
ServiceGetUserDelegationKeyResponse
ServiceListContainersSegmentResponse

listContainersSegment 操作の応答データが含まれます。
ServiceListFileSystemsSegmentResponse
ServiceRenameFileSystemOptions

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

列挙型

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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas」を参照してください。
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

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

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

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

警告: 識別子が指定されていない場合は、アクセス許可と 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();
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

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

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

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

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

関数の詳細

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

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

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

「https://docs.microsoft.com/en-us/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、identifier などの対応するプロパティを直接設定してください。

警告: 識別子が指定されていない場合は、アクセス許可と 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();

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

パラメーター

dataLakeSASSignatureValues
DataLakeSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

戻り値

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

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

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

パラメーター

pipeline

unknown

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

戻り値

pipeline

引数がパイプライン コントラクトを満たす場合は 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

省略可能。 オプション。

戻り値

Pipeline

新しい Pipeline オブジェクト。