共用方式為


@azure/storage-file-share 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) 要求的認證原則。 這是 abstract 類別。

FileSASPermissions

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

這是協助程序類別,用來建構字串,代表 ServiceSAS 授與給檔案的許可權。 將值設定為 true 表示任何使用這些許可權的 SAS 都會授與該作業的許可權。 設定所有值之後,這應該使用 toString 串行化,並設定為 FileSASSignatureValues 對象的許可權欄位。 可以建構沒有這個類別的許可權字串,但許可權的順序是特定的,而且這個類別保證正確性。

FileSystemAttributes

這是協助程序類別,可建構代表檔案或目錄之NTFS屬性的字串。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/create-file#file-system-attributes

Pipeline

包含 HTTP 要求原則的 Pipeline 類別。 您可以呼叫 newPipeline 來建立預設管線。 或者,您也可以使用管線的建構函式,使用自己的原則建立管線。

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

RestError

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

SASQueryParameters

表示組成 Azure 記憶體 SAS 查詢參數的元件。 此類型不是由使用者直接建構;它只會由 AccountSASSignatureValuesFileSASSignatureValues 類型產生。 一旦產生,就可以將它編碼為 toString() ,並直接附加至 URL (不過,如果存在現有的查詢參數,則應該注意這裡,這可能會影響附加這些查詢參數的適當方法) 。

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

ShareClient

ShareClient 代表 Azure 記憶體共用的 URL,可讓您操作其目錄和檔案。

ShareDirectoryClient

ShareDirectoryClient 代表 Azure 記憶體目錄的 URL,可讓您操作其檔案和目錄。

ShareFileClient

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

ShareLeaseClient

管理 ShareFileClientShareClient 租用的用戶端。

請參閱 https://docs.microsoft.com/rest/api/storageservices/lease-file 和查看 https://docs.microsoft.com/rest/api/storageservices/lease-share

ShareSASPermissions

這是協助程序類別,用來建構字串,代表 ServiceSAS 授與給共用的許可權。 將值設定為 true 表示任何使用這些許可權的 SAS 都會授與該作業的許可權。 設定所有值之後,這應該使用 toString 串行化,並設定為 FileSASSignatureValues 對象的許可權欄位。 可以建構沒有這個類別的許可權字串,但許可權的順序是特定的,而且這個類別保證正確性。

ShareServiceClient

ShareServiceClient 代表 Azure 記憶體檔案服務的 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 要求的原則。

介面

AccessPolicy

存取原則。

AccountSASSignatureValues

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

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

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

ClearRange
CloseHandlesInfo

關閉處理結果資訊。

CommonGenerateSasUrlOptions

ShareGenerateSasUrlOptionsFileGenerateSasUrlOptions 的常見選項。

CommonOptions

每個遠端作業通用選項的介面。

CopyFileSmbInfo

參數群組

CorsRule

CORS 是一項 HTTP 功能,可讓 Web 應用程式在某個網域下執行,以存取其他網域中的資源。 網頁瀏覽器會實作稱為同源原則的安全性限制,其可防止網頁呼叫不同網域中的 API;CORS 則提供了一個安全的方式,可讓一個網域 (原始網域) 能夠呼叫其他網域中的 API。

DirectoryCloseHandlesHeaders

關閉處理要求的其他回應標頭值。

DirectoryCreateHeaders

定義Directory_create作業的標頭。

DirectoryCreateIfNotExistsResponse

包含作業的 createIfNotExists(DirectoryCreateOptions) 回應數據。

DirectoryCreateOptions

設定 建立 作業的選項。

DirectoryDeleteHeaders

定義Directory_delete作業的標頭。

DirectoryDeleteIfExistsResponse

包含作業的 deleteIfExists(DirectoryDeleteOptions) 回應數據。

DirectoryDeleteOptions

設定 刪除 作業的選項。

DirectoryExistsOptions

設定 存在 作業的選項。

DirectoryForceCloseHandlesHeaders

定義Directory_forceCloseHandles作業的標頭。

DirectoryForceCloseHandlesOptions

設定 forceCloseHandle 的選項。

DirectoryForceCloseHandlesSegmentOptions

設定目錄的選項 - 強制關閉句柄區段作業。

請參閱:

DirectoryGetPropertiesHeaders

定義Directory_getProperties作業的標頭。

DirectoryGetPropertiesOptions

設定 getProperties 作業的選項。

DirectoryItem

列出的目錄專案。

DirectoryListFilesAndDirectoriesOptions

設定 listFilesAndDirectories 作業的選項。

DirectoryListFilesAndDirectoriesSegmentHeaders

定義Directory_listFilesAndDirectoriesSegment作業的標頭。

DirectoryListHandlesHeaders

定義Directory_listHandles作業的標頭。

DirectoryListHandlesOptions

設定 listHandles 作業的選項。

DirectoryListHandlesSegmentOptions

設定目錄的選項 - 清單句柄區段作業。

請參閱:

  • <xref:ShareDirectoryClient.listHandlesSegment>
  • <xref:ShareDirectoryClient.iterateHandleSegments>
  • <xref:ShareDirectoryClient.listHandleItems>
DirectoryProperties

每個遠端作業通用選項的介面。

DirectoryRenameHeaders

定義Directory_rename作業的標頭。

DirectoryRenameOptions

設定 重新命名 作業的選項。

DirectorySetMetadataHeaders

定義Directory_setMetadata作業的標頭。

DirectorySetMetadataOptions

設定 setMetadata 作業的選項。

DirectorySetPropertiesHeaders

定義Directory_setProperties作業的標頭。

FileAbortCopyFromURLOptions

設定 abortCopyFromURL 作業的選項。

FileAbortCopyHeaders

定義File_abortCopy作業的標頭。

FileAndDirectoryCreateCommonOptions
FileAndDirectorySetPropertiesCommonOptions
FileClearRangeOptions

設定 clearRange 作業的選項。

FileCloseHandlesHeaders

關閉處理要求的其他回應標頭值。

FileCreateHeaders

定義File_create作業的標頭。

FileCreateOptions

設定 建立 作業的選項。

FileDeleteHeaders

定義File_delete作業的標頭。

FileDeleteIfExistsResponse

包含 deleteIfExists 作業的響應數據。

FileDeleteOptions

設定 刪除 作業的選項。

FileDownloadHeaders

定義File_download作業的標頭。

FileDownloadOptionalParams

選用參數。

FileDownloadOptions

配置檔案 - 下載作業的選項。

請參閱:

FileDownloadToBufferOptions

downloadToBuffer 作業的選項介面。

FileExistsOptions

設定 存在 作業的選項。

FileForceCloseHandlesHeaders

定義File_forceCloseHandles作業的標頭。

FileForceCloseHandlesOptions

配置檔案的選項 - 強制關閉句柄作業。

請參閱:

FileGenerateSasUrlOptions

設定 generateSasUrl 作業的選項。

FileGetPropertiesHeaders

定義File_getProperties作業的標頭。

FileGetPropertiesOptions

設定 getProperties 作業的選項。

FileGetRangeListHeaders

定義File_getRangeList作業的標頭。

FileGetRangeListOptions

設定 getRangeList 作業的選項。

FileHttpHeaders
FileItem

列出的檔案專案。

FileListHandlesHeaders

定義File_listHandles作業的標頭。

FileListHandlesOptions

每個遠端作業通用選項的介面。

FileListHandlesSegmentOptions

配置檔案的選項 - 列出句柄區段作業。

請參閱:

  • <xref:ShareFileClient.listHandlesSegment>
  • <xref:ShareFileClient.iterateHandleSegments>
  • <xref:ShareFileClient.listHandleItems>
FileParallelUploadOptions

檔案的選項介面 - 上傳作業

請參閱:

  • uploadFile
  • <xref:ShareFileClient.uploadSeekableStream>
FileProperties

每個遠端作業通用選項的介面。

FileProperty

檔案屬性。

FileRenameHeaders

定義File_rename作業的標頭。

FileRenameOptions

設定 重新命名 作業的選項。

FileResizeOptions

設定 重設大小 作業的選項。

FileSASSignatureValues

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

FileSASSignatureValues 可用來協助產生共用或檔案的檔案服務 SAS 令牌。

FileServiceProperties

記憶體服務屬性。

FileSetHTTPHeadersHeaders

定義File_setHttpHeaders作業的標頭。

FileSetHttpHeadersOptions

設定 setHttpHeaders 作業的選項。

FileSetMetadataHeaders

定義File_setMetadata作業的標頭。

FileSetMetadataOptions

設定 setMetadata 作業的選項。

FileStartCopyHeaders

定義File_startCopy作業的標頭。

FileStartCopyOptions

設定 startCopyFromURL 作業的選項。

FileUploadRangeFromURLHeaders

定義File_uploadRangeFromURL作業的標頭。

FileUploadRangeFromURLOptionalParams

選用參數。

FileUploadRangeFromURLOptions

設定 uploadRangeFromURL 作業的選項。

FileUploadRangeHeaders

定義File_uploadRange作業的標頭。

FileUploadRangeOptions

設定 uploadRange 作業的選項。

FileUploadStreamOptions

ShareFileClient.uploadStream () 的選項介面。

FilesAndDirectoriesListSegment

可從 Directory 列出之專案的抽象概觀。

HandleItem

列出的 Azure 記憶體句柄專案。

HttpAuthorization

表示 Authorization、ProxyAuthorization、WWW-Authenticate 和 Proxy 驗證標頭值中的驗證資訊。

HttpHeaders

HTTP 標頭索引鍵/值組的集合。

HttpOperationResponse

與 core-v1 相容的 Http 回應 (core-http) 。

HttpResponse

HTTP 回應的表示法,其中包含產生要求的參考。

IHttpClient

core-HTTP 要求原則的相容介面

LeaseAccessConditions

參數群組

LeaseOperationOptions

租用作業選項。

LeaseOperationResponseHeaders

特定租用作業之回應的詳細數據。

ListFilesAndDirectoriesSegmentResponse

目錄和檔案的列舉。

ListHandlesResponse

句柄的列舉。

ListSharesResponse

共用的列舉。

ListSharesResponseModel

共用的列舉。

Metadata
Metrics

檔案服務的記憶體分析計量。

PipelineLike

管線類別的介面,包含 HTTP 要求原則。 您可以呼叫 newPipeline 來建立預設管線。 或者,您也可以使用管線的建構函式,使用自己的原則建立管線。

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

PipelineOptions

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

Range

服務作業的範圍。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-file-service-operations

RangeModel

Azure 記憶體檔案範圍。

RequestPolicyFactory

與 core-http 的 RequestPolicyFactory 相容介面

RequestPolicyOptions

與 RequestPolicy 相容的介面

ResponseLike

具有簡單_response屬性的物件。

ResponseWithBody

具有已剖析為已知型別之主體和標頭之_response屬性的物件。

ResponseWithHeaders

具有已剖析為具型別物件之標頭之_response屬性的物件。

RetentionPolicy

保留原則。

SasIPRange

SAS 允許的IP範圍。

ServiceClientOptions

ServiceClientOptions 的 @azure/core-http 子集

ServiceGenerateAccountSasUrlOptions

設定 generateAccountSasUrl 作業的選項。

ServiceGetPropertiesHeaders

定義Service_getProperties作業的標頭。

ServiceGetPropertiesOptions

設定 getProperties 作業的選項。

ServiceListSharesOptions

設定 listShares 作業的選項。

ServiceListSharesSegmentHeaders

定義Service_listSharesSegment作業的標頭。

ServiceSetPropertiesHeaders

定義Service_setProperties作業的標頭。

ServiceSetPropertiesOptions

設定 setProperties 作業的選項。

ServiceUndeleteShareOptions

設定 <xref:ShareServiceClient.undelete> 作業的選項。

SetPropertiesResponse

包含 setHttpHeaders 作業的響應數據。

ShareClientConfig
ShareCreateHeaders

定義Share_create作業的標頭。

ShareCreateIfNotExistsResponse

包含 createIfNotExists 作業的響應數據。

ShareCreateOptions

設定 建立 作業的選項。

ShareCreatePermissionHeaders

定義Share_createPermission作業的標頭。

ShareCreatePermissionOptions

設定 createPermission 作業的選項。

ShareCreateSnapshotHeaders

定義Share_createSnapshot作業的標頭。

ShareCreateSnapshotOptions

設定 createSnapshot 作業的選項。

ShareDeleteHeaders

定義Share_delete作業的標頭。

ShareDeleteIfExistsResponse

包含 deleteIfExists 作業的響應數據。

ShareDeleteMethodOptions

設定 刪除 作業的選項。

ShareExistsOptions

設定 存在 作業的選項。

ShareFileRangeList

檔案範圍清單

ShareGenerateSasUrlOptions

設定 generateSasUrl 作業的選項。

ShareGetAccessPolicyHeaders

定義Share_getAccessPolicy作業的標頭。

ShareGetAccessPolicyOptions

設定 getAccessPolicy 作業的選項。

ShareGetPermissionHeaders

定義Share_getPermission作業的標頭。

ShareGetPermissionOptions

設定 getPermission 作業的選項。

ShareGetPropertiesHeaders

定義Share_getProperties作業的標頭。

ShareGetPropertiesOptions

設定 getProperties 作業的選項。

ShareGetStatisticsHeaders

定義Share_getStatistics作業的標頭。

ShareGetStatisticsOptions

設定 getStatistics 作業的選項。

ShareItem

列出的 Azure 記憶體共享專案。

ShareItemInternal

列出的 Azure 記憶體共享專案。

SharePermission

許可權 (共用層級的安全性描述元) 。

SharePropertiesInternal

共用的屬性。

ShareProtocolSettings

通訊協定設定

ShareProtocols

在共用上啟用的通訊協定。 目前,僅支援SMB或NFS。

ShareSetAccessPolicyHeaders

定義Share_setAccessPolicy作業的標頭。

ShareSetAccessPolicyOptions

設定 setAccessPolicy 作業的選項。

ShareSetMetadataHeaders

定義Share_setMetadata作業的標頭。

ShareSetMetadataOptions

設定 setMetadata 作業的選項。

ShareSetPropertiesHeaders

定義Share_setProperties作業的標頭。

ShareSetPropertiesOptions

設定 setProperties 作業的選項。

ShareSetQuotaOptions

設定 setQuota 作業的選項。

ShareSmbSettings

SMB 通訊協議的設定。

ShareStats

共用的統計數據。

SignedIdentifier

帶正負號的標識碼

SignedIdentifierModel

帶正負號的標識碼。

SmbMultichannel

SMB 多重通道的設定

SourceModifiedAccessConditions

參數群組

StoragePipelineOptions

newPipeline 函式的選項介面。

StorageRetryOptions

記憶體 Blob 重試選項介面。

WebResource

要對遠端伺服器提出 HTTP 要求的描述。

類型別名

CopyStatusType

定義 CopyStatusType 的值。

CredentialPolicyCreator

Factory 函式,會建立使用所提供 nextPolicy 的新 CredentialPolicy。

DeleteSnapshotsOptionType

定義DeleteSnapshotsOptionType的值。

DirectoryCreateResponse

包含建立作業的響應數據。

DirectoryDeleteResponse

包含刪除作業的回應數據。

DirectoryForceCloseHandlesResponse

forceCloseHandle 的回應類型。

DirectoryGetPropertiesResponse

包含 getProperties 作業的響應數據。

DirectoryListFilesAndDirectoriesSegmentResponse

包含 listFilesAndDirectoriesSegment 作業的響應數據。

DirectoryListHandlesResponse

包含 listHandles 作業的響應數據。

DirectoryRenameResponse

包含重新命名作業的響應數據。

DirectorySetMetadataResponse

包含 setMetadata 作業的響應數據。

DirectorySetPropertiesResponse

包含 setProperties 作業的響應數據。

FileAbortCopyResponse

包含abortCopy作業的響應數據。

FileAttributesPreserveType

表示保留現有的檔案屬性不變。

FileCreateResponse

包含建立作業的響應數據。

FileDeleteResponse

包含刪除作業的回應數據。

FileDownloadResponseModel

包含下載作業的回應數據。

FileForceCloseHandlesResponse

forceCloseHandle 的回應類型。

FileGetPropertiesResponse

包含 getProperties 作業的響應數據。

FileGetRangeListDiffResponse

包含 getRangeList 作業的響應數據。

FileGetRangeListResponse

包含 getRangeList 作業的響應數據。

FileLastWrittenMode

定義 FileLastWrittenMode 的值。

FileListHandlesResponse

包含 listHandles 作業的響應數據。

FilePermissionInheritType

表示繼承父目錄中的檔案許可權。

FilePermissionPreserveType

表示保留現有的檔案許可權值不變。

FileRenameResponse

包含重新命名作業的響應數據。

FileSetHTTPHeadersResponse

包含 setHttpHeaders 作業的響應數據。

FileSetMetadataResponse

包含 setMetadata 作業的響應數據。

FileStartCopyResponse

包含 startCopy 作業的響應數據。

FileUploadRangeFromURLResponse

包含 uploadRangeFromURL 作業的響應數據。

FileUploadRangeResponse

包含 uploadRange 作業的響應數據。

HttpRequestBody

要求上支持的主體類型。 NodeJS.ReadableStream 和 () => NodeJS.ReadableStream 僅限 Node。 Blob、ReadableStream 和 () => ReadableStream 僅供瀏覽器使用。

LeaseDurationType

定義 LeaseDurationType 的值。

LeaseOperationResponse

包含取得、變更、中斷或釋放租用之作業的響應數據。

請參閱 ShareLeaseClient

LeaseStateType

定義 LeaseStateType 的值。

LeaseStatusType

定義 LeaseStatusType 的值。

ListSharesIncludeType

定義 ListSharesIncludeType 的值。

PermissionCopyModeType

定義 PermissionCopyModeType 的值。

RawFileDownloadResponse

包含下載作業的回應數據。

ServiceGetPropertiesResponse

包含 getProperties 作業的響應數據。

ServiceListSharesSegmentResponse

包含 listShares 作業的響應數據。

ServiceSetPropertiesResponse

包含 setProperties 作業的響應數據。

ShareAccessTier

定義 ShareAccessTier 的值。

ShareClientOptions
ShareCreatePermissionResponse

包含 createPermission 作業的響應數據。

ShareCreateResponse

包含建立作業的響應數據。

ShareCreateSnapshotResponse

包含 createSnapshot 作業的響應數據。

ShareDeleteResponse

包含刪除作業的回應數據。

ShareFileHandleAccessRights

定義 AccessRight 的值。

ShareGetAccessPolicyResponse
ShareGetPermissionResponse

包含 getPermission 作業的響應數據。

ShareGetPropertiesResponse

包含 getProperties 作業的響應數據。

ShareGetPropertiesResponseModel

包含 getProperties 作業的響應數據。

ShareGetStatisticsResponse

getStatistics 作業的響應數據。

ShareGetStatisticsResponseModel

包含 getStatistics 作業的響應數據。

ShareProperties

共用的屬性。

ShareRootSquash

定義 ShareRootSquash 的值。

ShareSetAccessPolicyResponse

包含 setAccessPolicy 作業的響應數據。

ShareSetMetadataResponse

包含 setMetadata 作業的響應數據。

ShareSetPropertiesResponse

包含 setProperties 作業的響應數據。

ShareSetQuotaHeaders

定義 setQuota 作業的標頭。

ShareSetQuotaResponse

包含 setQuota 作業的響應數據。

ShareTokenIntent

定義 ShareTokenIntent 的值。
KnownShareTokenIntent 可以與 ShareTokenIntent 交換使用,此列舉包含服務支援的已知值。

服務支援的已知值

備份

TimeNowType

表示將 設定為要求的時間。

TimePreserveType

表示保留現有的時間值不變。

WithResponse

型別,表示具有已知_response屬性的作業結果。

列舉

KnownShareTokenIntent

服務接受的 ShareTokenIntent 已知值。

SASProtocol

所產生 SAS 的通訊協定。

StorageFileAudience

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

StorageRetryPolicyType

RetryPolicy 類型。

函數

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

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

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

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

generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)

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

建立 SASQueryParameters 的實例。

只接受建立 SAS 所需的必要設定。 如需選擇性設定,請直接設定對應的屬性,例如許可權、startsOn 和標識符。

警告:未提供標識符時,需要許可權和 expiresOn。 如果您一開始使用此建構函式,則必須手動將值指派給標識碼或 expiresOn & 許可權。

getFileServiceAccountAudience(string)

若要取得檔案服務的記憶體帳戶 OAuth 物件。

isPipelineLike(unknown)

判斷給定自變數是否符合管線合約的協助程式

newPipeline(Credential_2 | TokenCredential, StoragePipelineOptions)

使用提供的 Credential 建立新的 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

傳回

generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)

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

建立 SASQueryParameters 的實例。

只接受建立 SAS 所需的必要設定。 如需選擇性設定,請直接設定對應的屬性,例如許可權、startsOn 和標識符。

警告:未提供標識符時,需要許可權和 expiresOn。 如果您一開始使用此建構函式,則必須手動將值指派給標識碼或 expiresOn & 許可權。

function generateFileSASQueryParameters(fileSASSignatureValues: FileSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

參數

fileSASSignatureValues
FileSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

傳回

getFileServiceAccountAudience(string)

若要取得檔案服務的記憶體帳戶 OAuth 物件。

function getFileServiceAccountAudience(storageAccountName: string): string

參數

storageAccountName

string

傳回

string

isPipelineLike(unknown)

判斷給定自變數是否符合管線合約的協助程式

function isPipelineLike(pipeline: unknown): pipeline

參數

pipeline

unknown

可能是管線的自變數

傳回

pipeline

當自變數滿足管線合約時為 true

newPipeline(Credential_2 | TokenCredential, StoragePipelineOptions)

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

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

參數

credential

Credential | TokenCredential

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

pipelineOptions
StoragePipelineOptions

選擇性。 選項。

傳回

新的 Pipeline 物件。