共用方式為


@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 提供 credentialPolicyCreator 成員,用來建立 AnonymousCredentialPolicy 物件。 AnonymousCredentialPolicy 會與讀取公用資源的 HTTP(S) 要求搭配使用,或用於共用存取簽章(SAS)。

AnonymousCredentialPolicy

AnonymousCredentialPolicy 會與讀取公用資源的 HTTP(S) 要求搭配使用,或用於共用存取簽章(SAS)。

BaseRequestPolicy

所有要求原則衍生自的基類。

Credential

Credential 是 Azure 記憶體 HTTP 要求簽署的抽象類。 此類別會裝載一個 credentialPolicyCreator Factory,其會產生 CredentialPolicy。

CredentialPolicy

在傳送之前,用來簽署 HTTP(S) 要求的認證原則。 這是抽象類。

DataLakeAclChangeFailedError

作業中斷且稍後可以繼續時擲回的錯誤。

DataLakeDirectoryClient

DataLakeDirectoryClient 代表 Azure 記憶體目錄的 URL。

DataLakeFileClient

DataLakeFileClient 代表 Azure 記憶體檔案的 URL。

DataLakeFileSystemClient

DataLakeFileSystemClient 代表 Azure 記憶體文件系統的 URL,可讓您作其目錄和檔案。

DataLakeLeaseClient
DataLakePathClient

DataLakePathClient 代表 Azure 記憶體路徑(目錄或檔案)的 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 來建立預設管線。 或者,您可以透過管線的建構函式,使用您自己的原則建立管線。

請參閱 newPipeline,並在實作自定義管線之前提供原則。

RestError

失敗管線要求的自定義錯誤類型。

SASQueryParameters

表示組成 Azure 記憶體 SAS 查詢參數的元件。 使用者不會直接建構此類型;它只會由 AccountSASSignatureValues 和 <xref:BlobSASSignatureValues> 類型產生。 產生之後,它可以編碼成 toString() 並直接附加至 URL(不過,如果現有的查詢參數存在,則應該在這裡小心,這可能會影響附加這些查詢參數的適當方法)。

注意:這個類別的實例是不可變的。

StorageBrowserPolicy

StorageBrowserPolicy 會處理 Node.js 與瀏覽器運行時間之間的差異,包括:

  1. 瀏覽器會藉由新增條件式標頭,例如 『IF_MODIFIED_SINCE』,來快取 GET/HEAD 要求。 StorageBrowserPolicy 是用來將時間戳查詢新增至 GET/HEAD 要求 URL 的原則,因此可避免瀏覽器快取。

  2. 拿掉安全性的 Cookie 標頭

  3. 拿掉內容長度標頭以避免瀏覽器警告

StorageBrowserPolicyFactory

StorageBrowserPolicyFactory 是一種處理站類別,可協助產生 StorageBrowserPolicy 物件。

StorageRetryPolicy

重試原則,並實作指數重試和線性重試。

StorageRetryPolicyFactory

StorageRetryPolicyFactory 是一種處理站類別,可協助產生 StorageRetryPolicy 物件。

StorageSharedKeyCredential

僅適用於運行時間NODE.JS。

Azure 記憶體服務帳戶密鑰授權的 StorageSharedKeyCredential。

StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy 是用來使用共用密鑰簽署 HTTP 要求的原則。

介面

AccessControlChangeCounters

AccessControlChangeCounters 包含遞歸變更訪問控制清單的作業計數。

AccessControlChangeError

表示在 setAccessControlRecursiveupdateAccessControlRecursiveremoveAccessControlRecursive期間無法更新訪問控制清單的專案。

AccessControlChanges

AccessControlChanges 包含遞歸變更訪問控制清單的批次和累計作業計數。 此外,它會公開在這些作業進行時無法更新的路徑專案。

AccessPolicy
AccountSASSignatureValues

僅適用於運行時間NODE.JS。

AccountSASSignatureValues 可用來產生 Azure 記憶體帳戶的共用存取簽章(SAS)。 一旦適當地設定這裡的所有值,請呼叫 generateAccountSASQueryParameters,以取得實際可以套用至 Data Lake URL 的 SAS 表示法。 注意:這個類別和 SASQueryParameters 存在,因為前者是可變的,而邏輯表示則為不可變,並且用來產生實際的 REST 要求。

如需 SAS 的詳細資訊,請參閱 https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 如需參數描述 https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas,包括必要參數的說明

BlobHierarchyListSegment
BlobItemModel

Azure 記憶體 Blob

BlobPrefix
BlobPropertiesModel

Blob 的屬性

CommonGenerateSasUrlOptions

FileSystemGenerateSasUrlOptionsDirectoryGenerateSasUrlOptionsFileGenerateSasUrlOptions的常見選項。

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

setAccessControlRecursiveupdateAccessControlRecursiveremoveAccessControlRecursive的選項類型。

PathChangeAccessControlRecursiveResponse

setAccessControlRecursiveupdateAccessControlRecursiveremoveAccessControlRecursive的回應類型。

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 來建立預設管線。 或者,您可以透過管線的建構函式,使用您自己的原則建立管線。

請參閱 newPipeline,並在實作自定義管線之前提供原則。

PipelineOptions

管線建構函式的選項介面。

RawAccessPolicy
RemovePathAccessControlItem
RequestPolicyFactory

與 core-http 的 RequestPolicyFactory 相容介面

RequestPolicyOptions

與 RequestPolicy 相容性的介面

RolePermissions
SASQueryParametersOptions

建構SASQueryParameters 的選項。

SasIPRange

SAS 允許的IP範圍。

ServiceClientOptions

@azure/core-http ServiceClientOptions 的子集

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

定義記憶體的已知雲端物件。

StorageRetryPolicyType

RetryPolicy 類型。

函式

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

僅適用於運行時間NODE.JS。

產生 SASQueryParameters 物件,其中包含發出實際 REST 要求所需的所有 SAS 查詢參數。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

僅適用於運行時間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();
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

僅適用於運行時間NODE.JS。

建立 SASQueryParameters 的實例。 警告:產生使用者委派 SAS 時,需要有許可權和到期日時,將會忽略標識符。

範例

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

使用提供的認證建立新的 Pipeline 物件。

函式詳細資料

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

僅適用於運行時間NODE.JS。

產生 SASQueryParameters 物件,其中包含發出實際 REST 要求所需的所有 SAS 查詢參數。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

參數

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

傳回

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

僅適用於運行時間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();
function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

參數

dataLakeSASSignatureValues
DataLakeSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

傳回

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

僅適用於運行時間NODE.JS。

建立 SASQueryParameters 的實例。 警告:產生使用者委派 SAS 時,需要有許可權和到期日時,將會忽略標識符。

範例

// 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

傳回

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)

使用提供的認證建立新的 Pipeline 物件。

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

參數

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

例如 AnonymousCredential、StorageSharedKeyCredential 或任何來自 @azure/identity 套件的認證,以驗證對服務的要求。 您也可以提供實作 TokenCredential 介面的物件。 如果未指定,則會使用 AnonymousCredential。

pipelineOptions
StoragePipelineOptions

自選。 選項。

傳回

新的 Pipeline 物件。