@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 與瀏覽器運行時間之間的差異，包括：
|
| StorageBrowserPolicyFactory |
StorageBrowserPolicyFactory 是一種處理站類別，可協助產生 StorageBrowserPolicy 物件。 |
| StorageRetryPolicy |
重試原則，並實作指數重試和線性重試。 |
| StorageRetryPolicyFactory |
StorageRetryPolicyFactory 是一種處理站類別，可協助產生 StorageRetryPolicy 物件。 |
| StorageSharedKeyCredential |
僅適用於運行時間NODE.JS。 Azure 記憶體服務帳戶密鑰授權的 StorageSharedKeyCredential。 |
| StorageSharedKeyCredentialPolicy |
StorageSharedKeyCredentialPolicy 是用來使用共用密鑰簽署 HTTP 要求的原則。 |
介面
類型別名
列舉
| PathGetPropertiesAction |
定義 PathGetPropertiesAction 的值。 可能的值包括：'getAccessControl'、'getStatus' |
| PathRenameMode |
定義 PathRenameMode 的值。 可能的值包括：'legacy'、'posix' |
| PathResourceType |
定義 PathResourceType 的值。 可能的值包括：'directory'、'file' |
| SASProtocol |
產生的 SAS 通訊協定。 |
| StorageDataLakeAudience |
定義記憶體的已知雲端物件。 |
| StorageRetryPolicyType |
RetryPolicy 類型。 |
函式
| generate |
僅適用於運行時間NODE.JS。 產生 SASQueryParameters 物件，其中包含發出實際 REST 要求所需的所有 SAS 查詢參數。 請參閱 https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas |
| generate |
僅適用於運行時間NODE.JS。 建立 SASQueryParameters 的實例。 只接受建立 SAS 所需的必要設定。 如需選擇性設定，請直接設定對應的屬性，例如許可權、startsOn 和標識符。 警告：未提供標識符時，需要許可權和 expiresOn。 如果您以這個建構函式初始，您必須將值指派給標識碼或 expiresOn & 許可權。 在執行下列代碼段之前，請先填入必要的詳細數據。 範例 在執行代碼段之前，請先填入必要的詳細數據。 範例 |
| generate |
僅適用於運行時間NODE.JS。 建立 SASQueryParameters 的實例。 警告：產生使用者委派 SAS 時，需要有許可權和到期日時，將會忽略標識符。 範例 |
| get |
若要取得 Datalake 服務記憶體帳戶的 OAuth 物件。 |
| is |
判斷給定自變數是否符合管線合約的協助程式 |
| new |
使用提供的認證建立新的 Pipeline 物件。 |
函式詳細資料
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)
僅適用於運行時間NODE.JS。
產生 SASQueryParameters 物件，其中包含發出實際 REST 要求所需的所有 SAS 查詢參數。
請參閱 https://learn.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 物件。