@azure/storage-blob 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) 。

AppendBlobClient

AppendBlobClient 會定義一組適用於附加 Blob 的作業。

BaseRequestPolicy

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

BlobBatch

BlobBatch 代表 Blob 上的一組匯總作業。 目前僅 delete 支援 和 setAccessTier

BlobBatchClient

BlobBatchClient 可讓您對 Azure 記憶體 Blob 服務提出批次要求。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch

BlobClient

BlobClient 代表 Azure 記憶體 Blob 的 URL;Blob 可能是區塊 Blob、附加 Blob 或分頁 Blob。

BlobLeaseClient

管理 ContainerClientBlobClient 租用的用戶端。

BlobSASPermissions

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

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

BlobServiceClient

BlobServiceClient 代表 Azure 記憶體 Blob 服務的用戶端,可讓您操作 Blob 容器。

BlockBlobClient

BlockBlobClient 會定義一組適用於區塊 Blob 的作業。

ContainerClient

ContainerClient 代表 Azure 記憶體容器的 URL,可讓您操作其 Blob。

ContainerSASPermissions

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

Credential

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

CredentialPolicy

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

HttpHeaders

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

PageBlobClient

PageBlobClient 會定義一組適用於分頁 Blob 的作業。

Pipeline

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

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

RequestPolicyOptions

建立 RequestPolicy 時可以使用的選擇性屬性。

RestError

從 HTTP 要求到服務端點所產生的錯誤。

SASQueryParameters

代表組成 Azure 記憶體 SAS 查詢參數的元件。 使用者不會直接建構此類型;它只會由 AccountSASSignatureValuesBlobSASSignatureValues 類型產生。 產生之後,就可以將它編碼為 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 要求的原則。

WebResource

建立新的 WebResource 物件。

這個類別提供 REST 呼叫的抽象概念,其方式是連結庫/實作無關,並包裝必要的屬性來起始要求。

介面

AccessPolicy

存取原則

AccountSASPermissionsLike

看起來像帳戶 SAS 許可權的類型。 在 AccountSASPermissions 中用來剖析原始物件的 SAS 許可權。

AccountSASSignatureValues

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

AccountSASSignatureValues 可用來產生 Azure 記憶體帳戶的共用存取簽章 (SAS) 。 一旦適當地設定這裡的所有值,請呼叫 generateAccountSASQueryParameters 以取得 SAS 的表示法,而 SAS 實際上可以套用至 Blob 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 請參閱 以取得參數的描述,包括必要參數

AppendBlobAppendBlockFromURLOptions

設定 appendBlockFromURL 作業的選項。

AppendBlobAppendBlockFromUrlHeaders

定義AppendBlob_appendBlockFromUrl作業的標頭。

AppendBlobAppendBlockHeaders

定義AppendBlob_appendBlock作業的標頭。

AppendBlobAppendBlockOptions

設定 appendBlock 作業的選項。

AppendBlobCreateHeaders

定義AppendBlob_create作業的標頭。

AppendBlobCreateIfNotExistsOptions

設定 createIfNotExists 作業的選項。

AppendBlobCreateIfNotExistsResponse

包含作業的 <xref:appendBlobClient.createIfNotExists> 回應數據。

AppendBlobCreateOptions

設定 建立 作業的選項。

AppendBlobRequestConditions

要新增至此附加 Blob 建立的條件。

AppendBlobSealOptions

設定 密封 作業的選項。

AppendPositionAccessConditions

參數群組

BatchSubRequest

與批次作業相關聯的要求。

BatchSubResponse

與批次作業內單一要求相關聯的響應數據。

BlobAbortCopyFromURLHeaders

定義Blob_abortCopyFromURL作業的標頭。

BlobAbortCopyFromURLOptions

設定 abortCopyFromURL 作業的選項。

BlobAcquireLeaseOptions

設定 Blob - 取得租用作業的選項。

BlobBatchSubmitBatchOptionalParams

設定服務的選項 - 提交 Batch 選擇性參數。

BlobBeginCopyFromURLOptions

設定 beginCopyFromURL 作業的選項。

BlobBeginCopyFromURLResponse

包含 beginCopyFromURL 作業的響應數據。

BlobBeginCopyFromUrlPollState

beginCopyFromURL 傳迴的輪詢器所使用的狀態。

每當偵測到複製進度時,此狀態會傳遞至使用者指定的 onProgress 回呼。

BlobBreakLeaseOptions

設定 Blob - 中斷租用作業的選項。

BlobChangeLeaseOptions

設定 Blob - 變更租用作業的選項。

BlobCopyFromURLHeaders

定義Blob_copyFromURL作業的標頭。

BlobCreateSnapshotHeaders

定義Blob_createSnapshot作業的標頭。

BlobCreateSnapshotOptions

設定 createSnapshot 作業的選項。

BlobDeleteHeaders

定義Blob_delete作業的標頭。

BlobDeleteIfExistsResponse

包含 deleteIfExists 作業的響應數據。

BlobDeleteImmutabilityPolicyHeaders

定義Blob_deleteImmutabilityPolicy作業的標頭。

BlobDeleteImmutabilityPolicyOptions

刪除不變性原則 deleteImmutabilityPolicy 作業的選項。

BlobDeleteOptions

設定 刪除 作業的選項。

BlobDownloadHeaders

定義Blob_download作業的標頭。

BlobDownloadOptionalParams

選用參數。

BlobDownloadOptions

設定 下載 作業的選項。

BlobDownloadResponseParsed

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

BlobDownloadToBufferOptions

downloadToBuffer 作業的選項介面。

BlobExistsOptions

設定 存在 作業的選項。

BlobFlatListSegment

代表 BlobFlatListSegment 的介面。

BlobFlatListSegmentModel
BlobGenerateSasUrlOptions

設定 generateSasUrl 作業的選項。

BlobGetPropertiesHeaders

定義Blob_getProperties作業的標頭。

BlobGetPropertiesOptions

設定 getProperties 作業的選項。

BlobGetPropertiesResponse

包含 getProperties 作業的響應數據。

BlobGetTagsHeaders

定義Blob_getTags作業的標頭。

BlobGetTagsOptions

設定 getTags 作業的選項。

BlobHTTPHeaders

參數群組

BlobHierarchyListSegment

代表 BlobHierarchyListSegment 的介面。

BlobHierarchyListSegmentModel
BlobImmutabilityPolicy

描述 Blob 的不可變原則。

BlobItem

Azure 記憶體 Blob

BlobItemInternal

Azure 記憶體 Blob

BlobPrefix
BlobProperties

Blob 的屬性

BlobQueryArrowConfiguration

使用 Apache Arrow 格式查詢 Blob 的選項。 僅適用於 outputTextConfiguration

BlobQueryArrowField

描述 BlobQueryArrowConfiguration 中的字段。

BlobQueryCsvTextConfiguration

使用 CSV 格式查詢 Blob 的選項。

BlobQueryError

Blob 查詢錯誤類型。

BlobQueryHeaders

定義Blob_query作業的標頭。

BlobQueryJsonTextConfiguration

使用 JSON 格式查詢 Blob 的選項。

BlobQueryParquetConfiguration

使用 Parquet 格式查詢 Blob 的選項。 僅適用於 inputTextConfiguration

BlobReleaseLeaseOptions

設定 Blob - 發行租用作業的選項。

BlobRenewLeaseOptions

設定 Blob - 更新租用作業的選項。

BlobRequestConditions

標準 HTTP 條件標頭、標籤條件和租用條件

BlobSASPermissionsLike

看起來像 Blob SAS 許可權的類型。 用於 BlobSASPermissions ,以剖析原始物件的 SAS 許可權。

BlobSASSignatureValues

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

BlobSASSignatureValues 可用來協助產生容器或 Blob 的 Blob 服務 SAS 令牌。

BlobServiceProperties

記憶體服務屬性。

BlobServiceStatistics

記憶體服務的統計數據。

BlobSetHTTPHeadersHeaders

定義Blob_setHttpHeaders作業的標頭。

BlobSetHTTPHeadersOptions

設定 setHTTPHeaders 作業的選項。

BlobSetImmutabilityPolicyHeaders

定義Blob_setImmutabilityPolicy作業的標頭。

BlobSetImmutabilityPolicyOptions

設定不變性原則 setImmutabilityPolicy 作業的選項。

BlobSetLegalHoldHeaders

定義Blob_setLegalHold作業的標頭。

BlobSetLegalHoldOptions

設定合法保留 setLegalHold 作業的選項。

BlobSetMetadataHeaders

定義Blob_setMetadata作業的標頭。

BlobSetMetadataOptions

設定 setMetadata 作業的選項。

BlobSetTagsHeaders

定義Blob_setTags作業的標頭。

BlobSetTagsOptions

設定 setTags 作業的選項。

BlobSetTierHeaders

定義Blob_setTier作業的標頭。

BlobSetTierOptions

設定 setAccessTier 作業的選項。

BlobStartCopyFromURLHeaders

定義Blob_startCopyFromURL作業的標頭。

BlobStartCopyFromURLOptions

設定 beginCopyFromURL 作業的選項。

BlobSyncCopyFromURLOptions

設定 syncCopyFromURL 作業的選項。

BlobTag
BlobTags

Blob 標籤

BlobUndeleteHeaders

定義Blob_undelete作業的標頭。

BlobUndeleteOptions

設定 取消刪除 作業的選項。

Block

表示區塊 Blob 中的單一區塊。 它會描述區塊的識別碼和大小。

BlockBlobCommitBlockListHeaders

定義BlockBlob_commitBlockList作業的標頭。

BlockBlobCommitBlockListOptions

設定 commitBlockList 作業的選項。

BlockBlobGetBlockListHeaders

定義BlockBlob_getBlockList作業的標頭。

BlockBlobGetBlockListOptions

設定 getBlockList 作業的選項。

BlockBlobParallelUploadOptions

uploadFile 和 <xref:BlockBlobClient.uploadSeekableStream>的選項介面。

BlockBlobPutBlobFromUrlHeaders

定義BlockBlob_putBlobFromUrl作業的標頭。

BlockBlobQueryOptions

設定 查詢 作業的選項。

BlockBlobStageBlockFromURLHeaders

定義BlockBlob_stageBlockFromURL作業的標頭。

BlockBlobStageBlockFromURLOptions

設定 stageBlockFromURL 作業的選項。

BlockBlobStageBlockHeaders

定義BlockBlob_stageBlock作業的標頭。

BlockBlobStageBlockOptions

設定 stageBlock 作業的選項。

BlockBlobSyncUploadFromURLOptions

設定 syncUploadFromURL 作業的選項。

BlockBlobUploadHeaders

定義BlockBlob_upload作業的標頭。

BlockBlobUploadOptions

設定 上傳 作業的選項。

BlockBlobUploadStreamOptions

uploadStream 作業的選項介面。

BlockList
CommonGenerateSasUrlOptions

BlobGenerateSasUrlOptionsContainerGenerateSasUrlOptions 的常見選項。

CommonOptions

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

ContainerAcquireLeaseOptions

設定容器 - 取得租用作業的選項。

ContainerBreakLeaseOptionalParams

選用參數。

ContainerBreakLeaseOptions

設定容器 - 中斷租用作業的選項。

ContainerChangeLeaseOptions

設定容器 - 變更租用作業的選項。

ContainerCreateHeaders

定義Container_create作業的標頭。

ContainerCreateIfNotExistsResponse

包含 createIfNotExists 作業的響應數據。

ContainerCreateOptions

設定 建立 作業的選項。

ContainerDeleteBlobOptions

設定 deleteBlob 作業的選項。

ContainerDeleteHeaders

定義Container_delete作業的標頭。

ContainerDeleteIfExistsResponse

包含 deleteIfExists 作業的響應數據。

ContainerDeleteMethodOptions

設定 刪除 作業的選項。

ContainerEncryptionScope

參數群組

ContainerExistsOptions

設定 存在 作業的選項。

ContainerFilterBlobsHeaders

定義Container_filterBlobs作業的標頭。

ContainerFindBlobByTagsOptions

設定 findBlobsByTags 作業的選項。

ContainerGenerateSasUrlOptions

設定 generateSasUrl 作業的選項。

ContainerGetAccessPolicyHeaders

定義Container_getAccessPolicy作業的標頭。

ContainerGetAccessPolicyOptions

設定 getAccessPolicy 作業的選項。

ContainerGetPropertiesHeaders

定義Container_getProperties作業的標頭。

ContainerGetPropertiesOptions

設定 getProperties 作業的選項。

ContainerItem

Azure 記憶體容器

ContainerListBlobFlatSegmentHeaders

定義Container_listBlobFlatSegment作業的標頭。

ContainerListBlobHierarchySegmentHeaders

定義Container_listBlobHierarchySegment作業的標頭。

ContainerListBlobsOptions

設定容器 - 列出 Blob 作業的選項。

請參閱:

ContainerProperties

容器的屬性

ContainerReleaseLeaseOptions

設定容器 - 發行租用作業的選項。

ContainerRenameHeaders

定義Container_rename作業的標頭。

ContainerRenewLeaseOptions

設定容器 - 更新租用作業的選項。

ContainerRequestConditions

容器符合的條件。

ContainerSASPermissionsLike

看起來像容器 SAS 許可權的類型。 在 ContainerSASPermissions 中用來剖析原始物件的 SAS 許可權。

ContainerSetAccessPolicyHeaders

定義Container_setAccessPolicy作業的標頭。

ContainerSetAccessPolicyOptions

設定 setAccessPolicy 作業的選項。

ContainerSetMetadataHeaders

定義Container_setMetadata作業的標頭。

ContainerSetMetadataOptions

設定 setMetadata 作業的選項。

ContainerUndeleteHeaders

定義Container_restore作業的標頭。

CorsRule

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

CpkInfo

參數群組

FilterBlobItem

findBlobsByTags 中的 Blob 資訊

FilterBlobItemModel

來自篩選 Blob API 呼叫的 Blob 資訊

FilterBlobSegment

findBlobsByTags 作業的區段回應。

FilterBlobSegmentModel

篩選 Blob API 呼叫的結果

GeoReplication

Geo-Replication 次要記憶體服務的資訊

HttpAuthorization

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

HttpOperationResponse

HTTP 要求和回應的包裝函式物件。 當響應主體以 JSON 或 XML 接收時, parsedBody 還原串行化物件會儲存在屬性中。

IHttpClient

介面,可傳送 HttpRequests 並接收承諾的 HttpResponses。

Lease

特定租用的詳細數據。

LeaseAccessConditions

參數群組

LeaseOperationOptions

設定租用作業。

ListBlobsFlatSegmentResponse

Blob 的列舉

ListBlobsFlatSegmentResponseModel

Blob 的列舉

ListBlobsHierarchySegmentResponse

Blob 的列舉

ListBlobsHierarchySegmentResponseModel

Blob 的列舉

ListContainersSegmentResponse

容器的列舉

Logging

Azure 分析記錄設定。

MatchConditions

根據ETag比對,指定條件式要求的 HTTP 選項。

Metadata

要與資源建立關聯的名稱/值組對應。

Metrics

依 API 分組的要求統計數據摘要,以小時或分鐘為單位的 Blob 匯總

ModificationConditions

根據修改時間指定條件式要求的 HTTP 選項。

ModifiedAccessConditions

標準 HTTP 條件式標頭和標記條件。

ModifiedAccessConditionsModel

參數群組

ObjectReplicationPolicy

包含物件復寫策略標識碼和 個別的 ObjectReplicationRule 清單。 這是在擷取來源 Blob 上的物件復寫屬性時使用。 目的地 Blob 的原則標識碼是在個別方法回應的 ObjectReplicationDestinationPolicyId 中設定 (,例如 。 <xref:BlobProperties.ObjectReplicationDestinationPolicyId>

ObjectReplicationRule

包含 Blob 的物件複寫規則標識碼和 ObjectReplicationStatusObjectReplicationPolicy 下可以有多個 ObjectReplicationRule

PageBlobClearPagesHeaders

定義PageBlob_clearPages作業的標頭。

PageBlobClearPagesOptions

設定 clearPages 作業的選項。

PageBlobCopyIncrementalHeaders

定義PageBlob_copyIncremental作業的標頭。

PageBlobCreateHeaders

定義PageBlob_create作業的標頭。

PageBlobCreateIfNotExistsOptions

設定 createIfNotExists 作業的選項。

PageBlobCreateIfNotExistsResponse

包含 createIfNotExists 作業的響應數據。

PageBlobCreateOptions

設定 建立 作業的選項。

PageBlobGetPageRangesDiffHeaders

定義PageBlob_getPageRangesDiff作業的標頭。

PageBlobGetPageRangesDiffOptions

設定 <xref:PageBlobClient.getRangesDiff> 作業的選項。

PageBlobGetPageRangesDiffResponse

包含作業的 getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions) 回應數據。

PageBlobGetPageRangesHeaders

定義PageBlob_getPageRanges作業的標頭。

PageBlobGetPageRangesOptions

設定 getPageRanges 作業的選項。

PageBlobGetPageRangesResponse

包含作業的 getPageRanges(number, number, PageBlobGetPageRangesOptions) 回應數據。

PageBlobListPageRangesDiffOptions

設定 listPageRangesDiff 作業的選項。

PageBlobListPageRangesOptions

設定 listPageRanges 作業的選項。

PageBlobRequestConditions

要新增至這個分頁 Blob 建立的條件。

PageBlobResizeHeaders

定義PageBlob_resize作業的標頭。

PageBlobResizeOptions

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

PageBlobStartCopyIncrementalOptions

設定 startCopyIncremental 作業的選項。

PageBlobUpdateSequenceNumberHeaders

定義PageBlob_updateSequenceNumber作業的標頭。

PageBlobUpdateSequenceNumberOptions

設定 updateSequenceNumber 作業的選項。

PageBlobUploadPagesFromURLHeaders

定義PageBlob_uploadPagesFromURL作業的標頭。

PageBlobUploadPagesFromURLOptions

設定 uploadPagesFromURL 作業的選項。

PageBlobUploadPagesHeaders

定義PageBlob_uploadPages作業的標頭。

PageBlobUploadPagesOptions

設定 uploadPages 作業的選項。

PageList

Blob 的頁面範圍清單。

PageRangeInfo
ParsedBatchResponse

多部分/混合回應,其中包含每個子查詢的回應。

PipelineLike

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

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

PipelineOptions

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

PollOperationState

PollOperationState 包含定義任何長時間執行之作業輪詢器所需的最小屬性集意見清單。

雖然 Poller 類別可作為開始觸發、等候及可能取消長時間執行作業的本機控制機制,但 PollOperationState 會記載遠端長時間執行作業的狀態。

它應該至少在作業啟動時、完成時以及取消時更新。 不過,實作可以有任何其他數目的屬性,這些屬性可能會因為其他原因而更新。

PollerLike

輪詢器的抽象表示法,旨在只公開使用者所需的最小 API。

PollerLikeWithCancellation

輪詢器的抽象表示法,旨在只公開使用者所需的最小 API。

Range

Blob 服務作業的範圍。

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

RequestPolicy

要求原則的基礎結構。

RetentionPolicy

決定關聯數據應保存多久的保留原則

SASQueryParametersOptions

建構 SASQueryParameters 的選項。

SasIPRange

SAS 允許的IP範圍。

SequenceNumberAccessConditions

參數群組

ServiceFilterBlobsHeaders

定義Service_filterBlobs作業的標頭。

ServiceFindBlobByTagsOptions

設定 findBlobsByTags 作業的選項。

ServiceGenerateAccountSasUrlOptions

設定 generateAccountSasUrl 作業的選項。

ServiceGetAccountInfoHeaders

定義Service_getAccountInfo作業的標頭。

ServiceGetAccountInfoOptions

設定 getAccountInfo 作業的選項。

ServiceGetPropertiesHeaders

定義Service_getProperties作業的標頭。

ServiceGetPropertiesOptions

設定 getProperties 作業的選項。

ServiceGetStatisticsHeaders

定義Service_getStatistics作業的標頭。

ServiceGetStatisticsOptions

設定 getStatistics 作業的選項。

ServiceGetUserDelegationKeyHeaders

定義Service_getUserDelegationKey作業的標頭。

ServiceGetUserDelegationKeyOptions

設定服務的選項 - 取得使用者委派金鑰。

ServiceListContainersOptions

設定 listContainers 作業的選項。

ServiceListContainersSegmentHeaders

定義Service_listContainersSegment作業的標頭。

ServiceRenameContainerOptions

設定 <xref:BlobServiceClient.renameContainer> 作業的選項。

ServiceSetPropertiesHeaders

定義Service_setProperties作業的標頭。

ServiceSetPropertiesOptions

設定 setProperties 作業的選項。

ServiceSubmitBatchHeaders

定義Service_submitBatch作業的標頭。

ServiceSubmitBatchOptionalParamsModel

選用參數。

ServiceUndeleteContainerOptions

設定 undeleteContainer 作業的選項。

SignedIdentifier

帶正負號的標識碼。

SignedIdentifierModel

帶正負號的標識碼

StaticWebsite

可讓帳戶裝載靜態網站的屬性

StoragePipelineOptions

newPipeline 函式的選項介面。

StorageRetryOptions

記憶體 Blob 重試選項介面。

TagConditions

根據 Blob 標記指定條件式要求的 HTTP 選項。

UserDelegationKey

使用者委派金鑰。

UserDelegationKeyModel

使用者委派金鑰

類型別名

AccessTier

定義 AccessTier 的值。

AccountKind

定義 AccountKind 的值。

AppendBlobAppendBlockFromUrlResponse

包含 appendBlockFromUrl 作業的響應數據。

AppendBlobAppendBlockResponse

包含 appendBlock 作業的響應數據。

AppendBlobCreateResponse

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

ArchiveStatus

定義 ArchiveStatus 的值。

BlobAbortCopyFromURLResponse

包含 abortCopyFromURL 作業的響應數據。

BlobBatchDeleteBlobsResponse

包含作業的 deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions) 回應數據。

BlobBatchSetBlobsAccessTierResponse

包含作業的 setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions) 回應數據。

BlobBatchSubmitBatchResponse

包含 Blob 批次作業的響應數據。

BlobCopyFromURLResponse

包含 copyFromURL 作業的響應數據。

BlobCopySourceTags

定義 BlobCopySourceTags 的值。

BlobCreateSnapshotResponse

包含 createSnapshot 作業的響應數據。

BlobDeleteImmutabilityPolicyResponse

包含 deleteImmutabilityPolicy 作業的響應數據。

BlobDeleteResponse

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

BlobDownloadResponseModel

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

BlobGetPropertiesResponseModel

包含 getProperties 作業的響應數據。

BlobGetTagsResponse

包含 getTags 作業的響應數據。

BlobImmutabilityPolicyMode

定義 BlobImmutabilityPolicyMode 的值。

BlobQueryArrowFieldType

BlobQueryArrowField 的類型。

BlobQueryResponseModel

包含查詢作業的回應數據。

BlobSetHTTPHeadersResponse

包含 setHttpHeaders 作業的響應數據。

BlobSetImmutabilityPolicyResponse

包含 setImmutabilityPolicy 作業的響應數據。

BlobSetLegalHoldResponse

包含 setLegalHold 作業的響應數據。

BlobSetMetadataResponse

包含 setMetadata 作業的響應數據。

BlobSetTagsResponse

包含 setTags 作業的響應數據。

BlobSetTierResponse

包含 setTier 作業的響應數據。

BlobStartCopyFromURLResponse

包含 startCopyFromURL 作業的響應數據。

BlobType

定義 BlobType 的值。

BlobUndeleteResponse

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

BlobUploadCommonResponse

uploadFileuploadStream 和的<xref:BlockBlobClient.uploadBrowserDate>回應類型。

BlockBlobCommitBlockListResponse

包含 commitBlockList 作業的響應數據。

BlockBlobGetBlockListResponse

包含 getBlockList 作業的響應數據。

BlockBlobPutBlobFromUrlResponse

包含 putBlobFromUrl 作業的響應數據。

BlockBlobStageBlockFromURLResponse

包含 stageBlockFromURL 作業的響應數據。

BlockBlobStageBlockResponse

包含 stageBlock 作業的響應數據。

BlockBlobUploadResponse

包含上傳作業的回應數據。

BlockListType

定義 BlockListType 的值。

ContainerCreateResponse

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

ContainerDeleteResponse

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

ContainerFindBlobsByTagsSegmentResponse

findBlobsByTags 作業的回應。

ContainerGetAccessPolicyResponse

包含 getAccessPolicy 作業的響應數據。

ContainerGetPropertiesResponse

包含 getProperties 作業的響應數據。

ContainerListBlobFlatSegmentResponse

包含 listBlobFlatSegment 作業的響應數據。

ContainerListBlobHierarchySegmentResponse

包含 listBlobHierarchySegment 作業的響應數據。

ContainerRenameResponse

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

ContainerSetAccessPolicyResponse

包含 setAccessPolicy 作業的響應數據。

ContainerSetMetadataResponse

包含 setMetadata 作業的響應數據。

ContainerUndeleteResponse

包含還原作業的回應數據。

CopyPollerBlobClient

beginCopyFromURL 傳迴的輪詢器所需的 BlobClient 定義作業,以便運作。

CopyStatusType

定義 CopyStatusType 的值。

CredentialPolicyCreator

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

DeleteSnapshotsOptionType

定義DeleteSnapshotsOptionType的值。

EncryptionAlgorithmType

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

知道服務支援的值

AES256

GeoReplicationStatusType

定義 GeoReplicationStatusType 的值。

HttpRequestBody

可能的 HTTP 要求本文類型

LeaseDurationType

定義 LeaseDurationType 的值。

LeaseOperationResponse

包含建立、修改或刪除租用之作業的響應數據。

請參閱 BlobLeaseClient

LeaseStateType

定義 LeaseStateType 的值。

LeaseStatusType

定義 LeaseStatusType 的值。

ObjectReplicationStatus

指定 Blob 的複寫狀態。 當記憶體帳戶套用物件復寫原則 () 時,就會使用此功能。 請參閱 ObjectReplicationPolicyObjectReplicationRule

PageBlobClearPagesResponse

包含 clearPages 作業的響應數據。

PageBlobCopyIncrementalResponse

包含 copyIncremental 作業的響應數據。

PageBlobCreateResponse

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

PageBlobGetPageRangesDiffResponseModel

包含 getPageRangesDiff 作業的響應數據。

PageBlobGetPageRangesResponseModel

包含 getPageRanges 作業的響應數據。

PageBlobResizeResponse

包含重設大小作業的響應數據。

PageBlobUpdateSequenceNumberResponse

包含 updateSequenceNumber 作業的響應數據。

PageBlobUploadPagesFromURLResponse

包含 uploadPagesFromURL 作業的響應數據。

PageBlobUploadPagesResponse

包含 uploadPages 作業的響應數據。

PublicAccessType

定義 PublicAccessType 的值。

RehydratePriority

定義 RehydratePriority 的值。

RequestPolicyFactory

建立使用所提供 nextPolicy 的新 RequestPolicy 每個要求。

SequenceNumberActionType

定義 SequenceNumberActionType 的值。

ServiceFindBlobsByTagsSegmentResponse

findBlobsByTags 作業的回應。

ServiceGetAccountInfoResponse

包含 getAccountInfo 作業的響應數據。

ServiceGetPropertiesResponse

包含 getProperties 作業的響應數據。

ServiceGetStatisticsResponse

包含 getStatistics 作業的響應數據。

ServiceGetUserDelegationKeyResponse

包含作業的 getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions) 回應數據。

ServiceListContainersSegmentResponse

包含 listContainersSegment 作業的響應數據。

ServiceSetPropertiesResponse

包含 setProperties 作業的響應數據。

ServiceSubmitBatchResponseModel

包含 submitBatch 作業的響應數據。

SkuName

定義 SkuName 的值。

SyncCopyStatusType

定義 SyncCopyStatusType 的值。

Tags

Blob 標記。

列舉

BlockBlobTier

表示 Blob 上的存取層。 如需區塊 Blob 層級階層處理的詳細資訊 ,請參閱經常性存取、非經常性存取和封存儲存層。

KnownEncryptionAlgorithmType

服務接受的 EncryptionAlgorithmType 已知值。

PremiumPageBlobTier

指定要設定 Blob 的分頁 Blob 層。 這僅適用於進階記憶體帳戶上的分頁 Blob。 如需每個PageBlobTier對應IOPS和輸送量的詳細資訊,請參閱 這裡

SASProtocol

所產生 SAS 的通訊協定。

StorageBlobAudience

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

StorageRetryPolicyType

RetryPolicy 類型。

函數

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

建立新的串行化 RequestPolicyCreator,以在通過 HTTP 管線時串行化 HTTP 要求主體。

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

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

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

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

generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)

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

建立 SASQueryParameters 的實例。

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

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

在執行下列代碼段之前,請先填寫必要的詳細數據。

使用方式範例:

// Generate service level SAS for a container
const containerSAS = generateBlobSASQueryParameters({
    containerName, // 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 container with identifier
// startsOn & permissions are optional when identifier is provided
const identifier = "unique-id";
await containerClient.setAccessPolicy(undefined, [
  {
    accessPolicy: {
      expiresOn: new Date(new Date().valueOf() + 86400), // Date type
      permissions: ContainerSASPermissions.parse("racwdl").toString(),
      startsOn: new Date() // Date type
    },
    id: identifier
  }
]);

const containerSAS = generateBlobSASQueryParameters(
  {
    containerName, // Required
    identifier // Required
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

使用 Blob 名稱的範例:

// Generate service level SAS for a blob
const blobSAS = generateBlobSASQueryParameters({
    containerName, // Required
    blobName, // Required
    permissions: BlobSASPermissions.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();
generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)

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

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

使用方式範例:

// Generate user delegation SAS for a container
const userDelegationKey = await blobServiceClient.getUserDelegationKey(startsOn, expiresOn);
const containerSAS = generateBlobSASQueryParameters({
    containerName, // Required
    permissions: ContainerSASPermissions.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();
getBlobServiceAccountAudience(string)
isPipelineLike(unknown)

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

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

函式詳細資料

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

建立新的串行化 RequestPolicyCreator,以在通過 HTTP 管線時串行化 HTTP 要求主體。

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory

參數

deserializationContentTypes
DeserializationContentTypes
parsingOptions
SerializerOptions

傳回

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

傳回

generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)

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

建立 SASQueryParameters 的實例。

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

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

在執行下列代碼段之前,請先填寫必要的詳細數據。

使用方式範例:

// Generate service level SAS for a container
const containerSAS = generateBlobSASQueryParameters({
    containerName, // 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 container with identifier
// startsOn & permissions are optional when identifier is provided
const identifier = "unique-id";
await containerClient.setAccessPolicy(undefined, [
  {
    accessPolicy: {
      expiresOn: new Date(new Date().valueOf() + 86400), // Date type
      permissions: ContainerSASPermissions.parse("racwdl").toString(),
      startsOn: new Date() // Date type
    },
    id: identifier
  }
]);

const containerSAS = generateBlobSASQueryParameters(
  {
    containerName, // Required
    identifier // Required
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

使用 Blob 名稱的範例:

// Generate service level SAS for a blob
const blobSAS = generateBlobSASQueryParameters({
    containerName, // Required
    blobName, // Required
    permissions: BlobSASPermissions.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 generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

參數

blobSASSignatureValues
BlobSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

傳回

generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)

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

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

使用方式範例:

// Generate user delegation SAS for a container
const userDelegationKey = await blobServiceClient.getUserDelegationKey(startsOn, expiresOn);
const containerSAS = generateBlobSASQueryParameters({
    containerName, // Required
    permissions: ContainerSASPermissions.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 generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters

參數

blobSASSignatureValues
BlobSASSignatureValues
userDelegationKey
UserDelegationKey

的傳回值 blobServiceClient.getUserDelegationKey()

accountName

string

傳回

getBlobServiceAccountAudience(string)

function getBlobServiceAccountAudience(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 物件。