@azure/storage-blob package

參考

類別

AccountSASPermissions	僅適用於運行時間NODE.JS。這是協助程序類別，用來建構代表 AccountSAS 授與之許可權的字串。將值設定為 true 表示任何使用這些許可權的 SAS 都會授與該作業的許可權。設定所有值之後，應該使用 toString 串行化，並設定為 <xref:AccountSASSignatureValues> 對象的許可權欄位。可以建構沒有這個類別的許可權字串，但許可權的順序是特定的，而且這個類別保證正確性。
AccountSASResourceTypes	僅適用於運行時間NODE.JS。這是協助程序類別，用來建構代表 AccountSAS 可存取之資源的字串。將值設定為 true 表示任何使用這些許可權的 SAS 都會授與該資源類型的存取權。設定所有值之後，應該使用 toString 串行化，並設定為 <xref:AccountSASSignatureValues> 物件上的資源欄位。可以建構沒有這個類別的資源字串，但資源的順序是特定的，而且這個類別保證正確性。
AccountSASServices	僅適用於運行時間NODE.JS。這是協助程序類別，用來建構代表 AccountSAS 可存取之服務的字串。將值設定為 true 表示任何使用這些許可權的 SAS 都會授與該服務的存取權。設定所有值之後，應該使用 toString 串行化，並將設定為 <xref:AccountSASSignatureValues> 物件上的服務欄位。可以建構沒有這個類別的服務字串，但服務的順序是特別的，而這個類別保證正確性。
AnonymousCredential	AnonymousCredential 提供 credentialPolicyCreator 成員，用來建立 AnonymousCredentialPolicy 物件。 AnonymousCredentialPolicy 會與讀取公用資源的 HTTP（S）要求搭配使用，或用於共用存取簽章（SAS）。
AnonymousCredentialPolicy	AnonymousCredentialPolicy 會與讀取公用資源的 HTTP（S）要求搭配使用，或用於共用存取簽章（SAS）。
AppendBlobClient	AppendBlobClient 會定義一組適用於附加 Blob 的作業。
BlobBatch	BlobBatch 代表 Blob 上的一組匯總作業。目前僅支援 `delete` 和 `setAccessTier`。
BlobBatchClient	BlobBatchClient 可讓您對 Azure 記憶體 Blob 服務提出批次要求。
BlobClient	BlobClient 代表 Azure 記憶體 Blob 的 URL;Blob 可能是區塊 Blob、附加 Blob 或分頁 Blob。
BlobLeaseClient	管理 <xref:ContainerClient> 或 <xref:BlobClient>租用的用戶端。
BlobSASPermissions	僅適用於運行時間NODE.JS。這是協助程序類別，用來建構字串，代表 ServiceSAS 授與給 Blob 的許可權。將值設定為 true 表示任何使用這些許可權的 SAS 都會授與該作業的許可權。設定所有值之後，應該使用 toString 串行化，並設定為 <xref:BlobSASSignatureValues> 對象的許可權欄位。可以建構沒有這個類別的許可權字串，但許可權的順序是特定的，而且這個類別保證正確性。
BlobServiceClient	BlobServiceClient 代表 Azure 記憶體 Blob 服務的用戶端，可讓您作 Blob 容器。
BlockBlobClient	BlockBlobClient 會定義一組適用於區塊 Blob 的作業。
ContainerClient	ContainerClient 代表 Azure 記憶體容器的 URL，可讓您作其 Blob。
ContainerSASPermissions	這是協助程序類別，用來建構字串，代表 ServiceSAS 授與給容器的許可權。將值設定為 true 表示任何使用這些許可權的 SAS 都會授與該作業的許可權。設定所有值之後，應該使用 toString 串行化，並設定為 <xref:BlobSASSignatureValues> 對象的許可權欄位。可以建構沒有這個類別的許可權字串，但許可權的順序是特定的，而且這個類別保證正確性。
Credential	Credential 是 Azure 記憶體 HTTP 要求簽署的抽象類。此類別會裝載一個 credentialPolicyCreator Factory，其會產生 CredentialPolicy。
CredentialPolicy	在傳送之前，用來簽署 HTTP（S）要求的認證原則。這是抽象類。
PageBlobClient	PageBlobClient 會定義一組適用於分頁 Blob 的作業。
Pipeline	包含 HTTP 要求原則的 Pipeline 類別。您可以呼叫 <xref:newPipeline>來建立預設管線。或者，您可以透過管線的建構函式，使用您自己的原則建立管線。在實作自定義管線之前，請參閱 <xref:newPipeline> 和提供的原則。
SASQueryParameters	表示組成 Azure 記憶體 SAS 查詢參數的元件。使用者不會直接建構此類型;它只會由 <xref:AccountSASSignatureValues> 和 <xref:BlobSASSignatureValues> 類型產生。產生之後，它可以編碼成 <xref:String> 並直接附加至 URL（不過，如果現有的查詢參數存在，則應該在這裡小心，這可能會影響附加這些查詢參數的適當方法）。注意：這個類別的實例是不可變的。
StorageBrowserPolicy	StorageBrowserPolicy 會處理 Node.js 與瀏覽器運行時間之間的差異，包括：瀏覽器會藉由新增條件式標頭，例如『IF_MODIFIED_SINCE』，來快取 GET/HEAD 要求。 StorageBrowserPolicy 是用來將時間戳查詢新增至 GET/HEAD 要求 URL 的原則，因此可避免瀏覽器快取。拿掉安全性的 Cookie 標頭拿掉內容長度標頭以避免瀏覽器警告
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory 是一種處理站類別，可協助產生 StorageBrowserPolicy 物件。
StorageClient	StorageClient 代表 <xref:BlobServiceClient>、<xref:ContainerClient> 等的URL類別。
StorageClientContext
StorageRetryPolicy	重試原則，並實作指數重試和線性重試。
StorageRetryPolicyFactory	StorageRetryPolicyFactory 是一種處理站類別，可協助產生 <xref:StorageRetryPolicy> 物件。
StorageSharedKeyCredential	僅適用於運行時間NODE.JS。 Azure 記憶體服務帳戶密鑰授權的 StorageSharedKeyCredential。
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy 是用來使用共用密鑰簽署 HTTP 要求的原則。

介面

AccessPolicy	存取原則
AccountSASPermissionsLike	看起來像帳戶 SAS 許可權的類型。用於 <xref:AccountSASPermissions> 剖析原始物件的 SAS 許可權。
AccountSASSignatureValues	僅適用於運行時間NODE.JS。 AccountSASSignatureValues 可用來產生 Azure 記憶體帳戶的共用存取簽章（SAS）。一旦適當地設定這裡的所有值，請呼叫 <xref:generateAccountSASQueryParameters> 以取得實際可以套用至 Blob URL 的 SAS 表示法。注意：此類別和 <xref:SASQueryParameters> 都存在，因為前者是可變的，而邏輯表示法則是固定的，而且用來產生實際的 REST 要求。
AppendBlobAppendBlockFromURLOptions	設定 <xref:AppendBlobClient.appendBlockFromURL> 作業的選項。
AppendBlobAppendBlockFromUrlHeaders	定義AppendBlob_appendBlockFromUrl作業的標頭。
AppendBlobAppendBlockHeaders	定義AppendBlob_appendBlock作業的標頭。
AppendBlobAppendBlockOptions	設定 <xref:AppendBlobClient.appendBlock> 作業的選項。
AppendBlobCreateHeaders	定義AppendBlob_create作業的標頭。
AppendBlobCreateIfNotExistsOptions	設定 <xref:AppendBlobClient.createIfNotExists> 作業的選項。
AppendBlobCreateIfNotExistsResponse	包含 <xref:appendBlobClient.createIfNotExists> 作業的響應數據。
AppendBlobCreateOptions	設定 <xref:AppendBlobClient.create> 作業的選項。
AppendBlobRequestConditions	要新增至建立這個附加 Blob 的條件。
AppendBlobSealOptions	設定 <xref:AppendBlobClient.seal> 作業的選項。
AppendPositionAccessConditions	參數群組
BatchSubRequest	與批次作業相關聯的要求。
BatchSubResponse	與批次作業內單一要求相關聯的響應數據。
BlobAbortCopyFromURLHeaders	定義Blob_abortCopyFromURL作業的標頭。
BlobAbortCopyFromURLOptions	設定 <xref:BlobClient.abortCopyFromURL> 作業的選項。
BlobAcquireLeaseOptions	設定 Blob 的選項 - 取得租用作業。
BlobBatchSubmitBatchOptionalParams	設定服務的選項 - 提交批次選擇性參數。
BlobBeginCopyFromURLOptions	設定 <xref:BlobClient.beginCopyFromURL> 作業的選項。
BlobBeginCopyFromURLResponse	包含 <xref:BlobClient.beginCopyFromURL> 作業的響應數據。
BlobBeginCopyFromUrlPollState	從 <xref:BlobClient.beginCopyFromURL>傳迴的輪詢器所使用的狀態。每當偵測到複製進度時，此狀態會傳遞至使用者指定的 `onProgress` 回呼。
BlobBreakLeaseOptions	設定 Blob - 中斷租用作業的選項。
BlobChangeLeaseOptions	設定 Blob 的選項 - 變更租用作業。
BlobCopyFromURLHeaders	定義Blob_copyFromURL作業的標頭。
BlobCreateSnapshotHeaders	定義Blob_createSnapshot作業的標頭。
BlobCreateSnapshotOptions	設定 <xref:BlobClient.createSnapshot> 作業的選項。
BlobDeleteHeaders	定義Blob_delete作業的標頭。
BlobDeleteIfExistsResponse	包含 <xref:BlobClient.deleteIfExists> 作業的響應數據。
BlobDeleteImmutabilityPolicyHeaders	定義Blob_deleteImmutabilityPolicy作業的標頭。
BlobDeleteImmutabilityPolicyOptions	刪除不變性原則的選項 <xref:BlobClient.deleteImmutabilityPolicy> 作業。
BlobDeleteOptions	設定 <xref:BlobClient.delete> 作業的選項。
BlobDownloadHeaders	定義Blob_download作業的標頭。
BlobDownloadOptionalParams	選擇性參數。
BlobDownloadOptions	設定 <xref:BlobClient.download> 作業的選項。
BlobDownloadResponseParsed	包含 <xref:BlobClient.download> 作業的響應數據。
BlobDownloadToBufferOptions	<xref:BlobClient.downloadToBuffer> 作業的選項介面。
BlobExistsOptions	設定 <xref:BlobClient.exists> 作業的選項。
BlobFlatListSegment	代表 BlobFlatListSegment 的介面。
BlobFlatListSegmentModel
BlobGenerateSasUrlOptions	設定 <xref:BlobClient.generateSasUrl> 作業的選項。
BlobGetPropertiesHeaders	定義Blob_getProperties作業的標頭。
BlobGetPropertiesOptions	設定 <xref:BlobClient.getProperties> 作業的選項。
BlobGetPropertiesResponse	包含 <xref:BlobClient.getProperties> 作業的響應數據。
BlobGetTagsHeaders	定義Blob_getTags作業的標頭。
BlobGetTagsOptions	設定 <xref:BlobClient.getTags> 作業的選項。
BlobHTTPHeaders	參數群組
BlobHierarchyListSegment	代表 BlobHierarchyListSegment 的介面。
BlobHierarchyListSegmentModel
BlobImmutabilityPolicy	描述 Blob 的不可變原則。
BlobItem	Azure 記憶體 Blob
BlobItemInternal	Azure 記憶體 Blob
BlobPrefix
BlobProperties	Blob 的屬性
BlobQueryArrowConfiguration	使用 Apache Arrow 格式查詢 Blob 的選項。只適用於 <xref:BlockBlobQueryOptions.outputTextConfiguration>。
BlobQueryArrowField	描述 <xref:BlobQueryArrowConfiguration>中的欄位。
BlobQueryCsvTextConfiguration	使用 CSV 格式查詢 Blob 的選項。
BlobQueryError	Blob 查詢錯誤類型。
BlobQueryHeaders	定義Blob_query作業的標頭。
BlobQueryJsonTextConfiguration	使用 JSON 格式查詢 Blob 的選項。
BlobQueryParquetConfiguration	使用 Parquet 格式查詢 Blob 的選項。只適用於 <xref:BlockBlobQueryOptions.inputTextConfiguration>。
BlobReleaseLeaseOptions	設定 Blob - 發行租用作業的選項。
BlobRenewLeaseOptions	設定 Blob 的選項 - 更新租用作業。
BlobRequestConditions	標準 HTTP 條件標頭、標記條件和租用條件
BlobSASPermissionsLike	看起來像 Blob SAS 許可權的類型。用於 <xref:BlobSASPermissions> 剖析原始物件的 SAS 許可權。
BlobSASSignatureValues	僅適用於運行時間NODE.JS。 BlobSASSignatureValues 可用來協助產生容器或 Blob 的 Blob 服務 SAS 令牌。
BlobServiceProperties	記憶體服務屬性。
BlobServiceStatistics	記憶體服務的統計數據。
BlobSetHTTPHeadersHeaders	定義Blob_setHttpHeaders作業的標頭。
BlobSetHTTPHeadersOptions	設定 <xref:BlobClient.setHTTPHeaders> 作業的選項。
BlobSetImmutabilityPolicyHeaders	定義Blob_setImmutabilityPolicy作業的標頭。
BlobSetImmutabilityPolicyOptions	設定不變性原則的選項 <xref:BlobClient.setImmutabilityPolicy> 作業。
BlobSetLegalHoldHeaders	定義Blob_setLegalHold作業的標頭。
BlobSetLegalHoldOptions	設定法律保留 <xref:BlobClient.setLegalHold> 作業的選項。
BlobSetMetadataHeaders	定義Blob_setMetadata作業的標頭。
BlobSetMetadataOptions	設定 <xref:BlobClient.setMetadata> 作業的選項。
BlobSetTagsHeaders	定義Blob_setTags作業的標頭。
BlobSetTagsOptions	設定 <xref:BlobClient.setTags> 作業的選項。
BlobSetTierHeaders	定義Blob_setTier作業的標頭。
BlobSetTierOptions	設定 <xref:BlobClient.setAccessTier> 作業的選項。
BlobStartCopyFromURLHeaders	定義Blob_startCopyFromURL作業的標頭。
BlobStartCopyFromURLOptions	設定 <xref:BlobClient.beginCopyFromURL> 作業的選項。
BlobSyncCopyFromURLOptions	設定 <xref:BlobClient.syncCopyFromURL> 作業的選項。
BlobTag
BlobTags	Blob 標籤
BlobUndeleteHeaders	定義Blob_undelete作業的標頭。
BlobUndeleteOptions	設定 <xref:BlobClient.undelete> 作業的選項。
Block	表示區塊 Blob 中的單一區塊。它描述區塊的識別碼和大小。
BlockBlobCommitBlockListHeaders	定義BlockBlob_commitBlockList作業的標頭。
BlockBlobCommitBlockListOptions	設定 <xref:BlockBlobClient.commitBlockList> 作業的選項。
BlockBlobGetBlockListHeaders	定義BlockBlob_getBlockList作業的標頭。
BlockBlobGetBlockListOptions	設定 <xref:BlockBlobClient.getBlockList> 作業的選項。
BlockBlobParallelUploadOptions	<xref:BlockBlobClient.uploadFile> 和 <xref:BlockBlobClient.uploadSeekableStream>的選項介面。
BlockBlobPutBlobFromUrlHeaders	定義BlockBlob_putBlobFromUrl作業的標頭。
BlockBlobQueryOptions	設定 <xref:BlockBlobClient.query> 作業的選項。
BlockBlobStageBlockFromURLHeaders	定義BlockBlob_stageBlockFromURL作業的標頭。
BlockBlobStageBlockFromURLOptions	設定 <xref:BlockBlobClient.stageBlockFromURL> 作業的選項。
BlockBlobStageBlockHeaders	定義BlockBlob_stageBlock作業的標頭。
BlockBlobStageBlockOptions	設定 <xref:BlockBlobClient.stageBlock> 作業的選項。
BlockBlobSyncUploadFromURLOptions	設定 <xref:BlockBlobClient.syncUploadFromURL> 作業的選項。
BlockBlobUploadHeaders	定義BlockBlob_upload作業的標頭。
BlockBlobUploadOptions	設定 <xref:BlockBlobClient.upload> 作業的選項。
BlockBlobUploadStreamOptions	<xref:BlockBlobClient.uploadStream> 作業的選項介面。
BlockList
CommonGenerateSasUrlOptions	<xref:BlobGenerateSasUrlOptions> 和 <xref:ContainerGenerateSasUrlOptions>的常見選項。
CommonOptions	每個遠端作業通用選項的介面。
ContainerAcquireLeaseOptions	設定容器的選項 - 取得租用作業。
ContainerBreakLeaseOptionalParams	選擇性參數。
ContainerBreakLeaseOptions	設定容器 - 中斷租用作業的選項。
ContainerChangeLeaseOptions	設定容器 - 變更租用作業的選項。
ContainerCreateHeaders	定義Container_create作業的標頭。
ContainerCreateIfNotExistsResponse	包含 <xref:ContainerClient.createIfNotExists> 作業的響應數據。
ContainerCreateOptions	設定 <xref:ContainerClient.create> 作業的選項。
ContainerDeleteBlobOptions	設定 <xref:ContainerClient.deleteBlob> 作業的選項。
ContainerDeleteHeaders	定義Container_delete作業的標頭。
ContainerDeleteIfExistsResponse	包含 <xref:ContainerClient.deleteIfExists> 作業的響應數據。
ContainerDeleteMethodOptions	設定 <xref:ContainerClient.delete> 作業的選項。
ContainerEncryptionScope	參數群組
ContainerExistsOptions	設定 <xref:ContainerClient.exists> 作業的選項。
ContainerGenerateSasUrlOptions	設定 <xref:ContainerClient.generateSasUrl> 作業的選項。
ContainerGetAccessPolicyHeaders	定義Container_getAccessPolicy作業的標頭。
ContainerGetAccessPolicyOptions	設定 <xref:ContainerClient.getAccessPolicy> 作業的選項。
ContainerGetPropertiesHeaders	定義Container_getProperties作業的標頭。
ContainerGetPropertiesOptions	設定 <xref:ContainerClient.getProperties> 作業的選項。
ContainerItem	Azure 記憶體容器
ContainerListBlobFlatSegmentHeaders	定義Container_listBlobFlatSegment作業的標頭。
ContainerListBlobHierarchySegmentHeaders	定義Container_listBlobHierarchySegment作業的標頭。
ContainerListBlobsOptions	設定容器的選項 - 列出 Blob 作業。看： <xref:ContainerClient.listBlobsFlat> <xref:ContainerClient.listBlobsByHierarchy>
ContainerProperties	容器的屬性
ContainerReleaseLeaseOptions	設定容器 - 發行租用作業的選項。
ContainerRenameHeaders	定義Container_rename作業的標頭。
ContainerRenewLeaseOptions	設定容器 - 更新租用作業的選項。
ContainerRequestConditions	容器符合的條件。
ContainerSASPermissionsLike	看起來像容器 SAS 許可權的類型。用於 <xref:ContainerSASPermissions> 剖析原始物件的 SAS 許可權。
ContainerSetAccessPolicyHeaders	定義Container_setAccessPolicy作業的標頭。
ContainerSetAccessPolicyOptions	設定 <xref:ContainerClient.setAccessPolicy> 作業的選項。
ContainerSetMetadataHeaders	定義Container_setMetadata作業的標頭。
ContainerSetMetadataOptions	設定 <xref:ContainerClient.setMetadata> 作業的選項。
ContainerUndeleteHeaders	定義Container_restore作業的標頭。
CorsRule	CORS 是一項 HTTP 功能，可讓一個網域下執行的 Web 應用程式存取另一個網域中的資源。網頁瀏覽器會實作稱為相同來源原則的安全性限制，以防止網頁在不同的網域中呼叫 API;CORS 提供安全的方式，允許一個網域（原始網域）在另一個網域中呼叫 API
CpkInfo	參數群組
FilterBlobItem	來自 <xref:BlobServiceClient.findBlobsByTags> 的 Blob 資訊
FilterBlobItemModel	篩選 Blob API 呼叫中的 Blob 資訊
FilterBlobSegment	<xref:BlobServiceClient.findBlobsByTags> 作業的區段回應。
FilterBlobSegmentModel	篩選 Blob API 呼叫的結果
GeoReplication	次要記憶體服務的 Geo-Replication 資訊
HttpAuthorization	代表 Authorization、ProxyAuthorization、WWW-Authenticate 和 Proxy-Authenticate 標頭值中的驗證資訊。
Lease	特定租用的詳細數據。
LeaseAccessConditions	參數群組
LeaseOperationOptions	設定租用作業。
ListBlobsFlatSegmentResponse	Blob 的列舉
ListBlobsFlatSegmentResponseModel	Blob 的列舉
ListBlobsHierarchySegmentResponse	Blob 的列舉
ListBlobsHierarchySegmentResponseModel	Blob 的列舉
ListContainersSegmentResponse	容器的列舉
Logging	Azure Analytics 記錄設定。
MatchConditions	根據ETag比對，指定條件式要求的 HTTP 選項。
Metadata	要與資源產生關聯的名稱/值組對應。
Metrics	依 API 分組的要求統計數據摘要，以小時或分鐘為單位匯總 Blob
ModificationConditions	根據修改時間指定條件式要求的 HTTP 選項。
ModifiedAccessConditions	標準 HTTP 條件標頭和標記條件。
ModifiedAccessConditionsModel	參數群組
ObjectReplicationPolicy	包含物件複寫策略標識碼和個別 <xref:ObjectReplicationRule>清單。擷取來源 Blob 上的物件複寫屬性時，會使用此屬性。目的地 Blob 的原則標識碼是在個別方法回應的 ObjectReplicationDestinationPolicyId 中設定的（例如 <xref:BlobProperties.ObjectReplicationDestinationPolicyId>。
ObjectReplicationRule	包含 Blob 的物件複寫規則標識碼和 <xref:ObjectReplicationStatus>。在 <xref:ObjectReplicationPolicy>下可以有多個 <xref:ObjectReplicationRule>。
PageBlobClearPagesHeaders	定義PageBlob_clearPages作業的標頭。
PageBlobClearPagesOptions	設定 <xref:PageBlobClient.clearPages> 作業的選項。
PageBlobCopyIncrementalHeaders	定義PageBlob_copyIncremental作業的標頭。
PageBlobCreateHeaders	定義PageBlob_create作業的標頭。
PageBlobCreateIfNotExistsOptions	設定 <xref:PageBlobClient.createIfNotExists> 作業的選項。
PageBlobCreateIfNotExistsResponse	包含 <xref:PageBlobClient.createIfNotExists> 作業的響應數據。
PageBlobCreateOptions	設定 <xref:PageBlobClient.create> 作業的選項。
PageBlobGetPageRangesDiffHeaders	定義PageBlob_getPageRangesDiff作業的標頭。
PageBlobGetPageRangesDiffOptions	設定 <xref:PageBlobClient.getRangesDiff> 作業的選項。
PageBlobGetPageRangesDiffResponse	包含 <xref:BlobClient.getPageRangesDiff> 作業的響應數據。
PageBlobGetPageRangesHeaders	定義PageBlob_getPageRanges作業的標頭。
PageBlobGetPageRangesOptions	設定 <xref:PageBlobClient.getPageRanges> 作業的選項。
PageBlobGetPageRangesResponse	包含 <xref:BlobClient.getPageRanges> 作業的響應數據。
PageBlobRequestConditions	要新增至建立此分頁 Blob 的條件。
PageBlobResizeHeaders	定義PageBlob_resize作業的標頭。
PageBlobResizeOptions	設定 <xref:PageBlobClient.resize> 作業的選項。
PageBlobStartCopyIncrementalOptions	設定 <xref:PageBlobClient.startCopyIncremental> 作業的選項。
PageBlobUpdateSequenceNumberHeaders	定義PageBlob_updateSequenceNumber作業的標頭。
PageBlobUpdateSequenceNumberOptions	設定 <xref:PageBlobClient.updateSequenceNumber> 作業的選項。
PageBlobUploadPagesFromURLHeaders	定義PageBlob_uploadPagesFromURL作業的標頭。
PageBlobUploadPagesFromURLOptions	設定 <xref:PageBlobClient.uploadPagesFromURL> 作業的選項。
PageBlobUploadPagesHeaders	定義PageBlob_uploadPages作業的標頭。
PageBlobUploadPagesOptions	設定 <xref:PageBlobClient.uploadPages> 作業的選項。
PageList	Blob 的頁面範圍清單。
ParsedBatchResponse	多部分/混合回應，其中包含每個子查詢的回應。
PipelineLike	包含 HTTP 要求原則之 <xref:Pipeline> 類別的介面。您可以呼叫 <xref:newPipeline>來建立預設管線。或者，您可以透過管線的建構函式，使用您自己的原則建立管線。在實作自定義管線之前，請參閱 <xref:newPipeline> 和提供的原則。
PipelineOptions	管線建構函式的選項介面。
Range	Blob 服務作業的範圍。
RetentionPolicy	決定相關聯數據應保存多久的保留原則
SASQueryParametersOptions	建構 <xref:SASQueryParameters>的選項。
SasIPRange	SAS 允許的IP範圍。
SequenceNumberAccessConditions	參數群組
ServiceFilterBlobsHeaders	定義Service_filterBlobs作業的標頭。
ServiceFindBlobByTagsOptions	設定 <xref:BlobServiceClient.findBlobsByTags> 作業的選項。
ServiceGenerateAccountSasUrlOptions	設定 <xref:BlobServiceClient.generateAccountSasUrl> 作業的選項。
ServiceGetAccountInfoHeaders	定義Service_getAccountInfo作業的標頭。
ServiceGetAccountInfoOptions	設定 <xref:BlobServiceClient.getAccountInfo> 作業的選項。
ServiceGetPropertiesHeaders	定義Service_getProperties作業的標頭。
ServiceGetPropertiesOptions	設定 <xref:BlobServiceClient.getProperties> 作業的選項。
ServiceGetStatisticsHeaders	定義Service_getStatistics作業的標頭。
ServiceGetStatisticsOptions	設定 <xref:BlobServiceClient.getStatistics> 作業的選項。
ServiceGetUserDelegationKeyHeaders	定義Service_getUserDelegationKey作業的標頭。
ServiceGetUserDelegationKeyOptions	設定服務的選項 - 取得使用者委派金鑰。
ServiceListContainersOptions	設定 <xref:BlobServiceClient.listContainers> 作業的選項。
ServiceListContainersSegmentHeaders	定義Service_listContainersSegment作業的標頭。
ServiceRenameContainerOptions	設定 <xref:BlobServiceClient.renameContainer> 作業的選項。
ServiceSetPropertiesHeaders	定義Service_setProperties作業的標頭。
ServiceSetPropertiesOptions	設定 <xref:BlobServiceClient.setProperties> 作業的選項。
ServiceSubmitBatchHeaders	定義Service_submitBatch作業的標頭。
ServiceSubmitBatchOptionalParamsModel	選擇性參數。
ServiceUndeleteContainerOptions	設定 <xref:BlobServiceClient.undeleteContainer> 作業的選項。
SignedIdentifier	帶正負號的標識碼。
SignedIdentifierModel	帶正負號的標識碼
StaticWebsite	可讓帳戶裝載靜態網站的屬性
StorageClientOptionalParams	選擇性參數。
StoragePipelineOptions	<xref:newPipeline> 函式的選項介面。
StorageRetryOptions	記憶體 Blob 重試選項介面。
TagConditions	根據 Blob 標記指定條件式要求的 HTTP 選項。
UserDelegationKey	使用者委派金鑰。
UserDelegationKeyModel	使用者委派金鑰

類型別名

AccessTier	定義 AccessTier 的值。
AccountKind	定義 AccountKind 的值。
AppendBlobAppendBlockFromUrlResponse	包含 appendBlockFromUrl 作業的響應數據。
AppendBlobAppendBlockResponse	包含 appendBlock 作業的響應數據。
AppendBlobCreateResponse	包含建立作業的響應數據。
ArchiveStatus	定義 ArchiveStatus 的值。
BlobAbortCopyFromURLResponse	包含 abortCopyFromURL 作業的響應數據。
BlobBatchDeleteBlobsResponse	包含 <xref:deleteBlobs> 作業的響應數據。
BlobBatchSetBlobsAccessTierResponse	包含 <xref:setBlobsAccessTier> 作業的響應數據。
BlobBatchSubmitBatchResponse	包含 Blob 批次作業的響應數據。
BlobCopyFromURLResponse	包含 copyFromURL 作業的響應數據。
BlobCreateSnapshotResponse	包含 createSnapshot 作業的響應數據。
BlobDeleteImmutabilityPolicyResponse	包含 deleteImmutabilityPolicy 作業的響應數據。
BlobDeleteResponse	包含刪除作業的回應數據。
BlobDownloadResponseModel	包含下載作業的回應數據。
BlobGetPropertiesResponseModel	包含 getProperties 作業的響應數據。
BlobGetTagsResponse	包含 <xref:BlobClient.getTags> 作業的響應數據。
BlobImmutabilityPolicyMode	定義 BlobImmutabilityPolicyMode 的值。
BlobQueryArrowFieldType	<xref:BlobQueryArrowField>的類型。
BlobQueryResponseModel	包含查詢作業的回應數據。
BlobSetHTTPHeadersResponse	包含 setHttpHeaders 作業的響應數據。
BlobSetImmutabilityPolicyResponse	包含 setImmutabilityPolicy 作業的響應數據。
BlobSetLegalHoldResponse	包含 setLegalHold 作業的響應數據。
BlobSetMetadataResponse	包含 setMetadata 作業的響應數據。
BlobSetTagsResponse	包含 setTags 作業的響應數據。
BlobSetTierResponse	包含 setTier 作業的響應數據。
BlobStartCopyFromURLResponse	包含 startCopyFromURL 作業的響應數據。
BlobType	定義 BlobType 的值。
BlobUndeleteResponse	包含取消刪除作業的回應數據。
BlobUploadCommonResponse	<xref:BlockBlobClient.uploadFile>、<xref:BlockBlobClient.uploadStream>和 <xref:BlockBlobClient.uploadBrowserDate>的回應類型。
BlockBlobCommitBlockListResponse	包含 commitBlockList 作業的響應數據。
BlockBlobGetBlockListResponse	包含 getBlockList 作業的響應數據。
BlockBlobPutBlobFromUrlResponse	包含 putBlobFromUrl 作業的響應數據。
BlockBlobStageBlockFromURLResponse	包含 stageBlockFromURL 作業的響應數據。
BlockBlobStageBlockResponse	包含 stageBlock 作業的響應數據。
BlockBlobUploadResponse	包含上傳作業的回應數據。
BlockListType	定義 BlockListType 的值。
ContainerCreateResponse	包含建立作業的響應數據。
ContainerDeleteResponse	包含刪除作業的回應數據。
ContainerGetAccessPolicyResponse	包含 <xref:ContainerClient.getAccessPolicy> 作業的響應數據。
ContainerGetPropertiesResponse	包含 getProperties 作業的響應數據。
ContainerListBlobFlatSegmentResponse	包含 listBlobFlatSegment 作業的響應數據。
ContainerListBlobHierarchySegmentResponse	包含 listBlobHierarchySegment 作業的響應數據。
ContainerRenameResponse	包含重新命名作業的響應數據。
ContainerSetAccessPolicyResponse	包含 setAccessPolicy 作業的響應數據。
ContainerSetMetadataResponse	包含 setMetadata 作業的響應數據。
ContainerUndeleteResponse	包含還原作業的回應數據。
CopyPollerBlobClient	從 <xref:BlobClient.beginCopyFromURL> 傳迴的輪詢器所需的 <xref:BlobClient> 定義作業。
CopyStatusType	定義 CopyStatusType 的值。
CredentialPolicyCreator	建立使用所提供 nextPolicy 之新 CredentialPolicy 的 Factory 函式。
DeleteSnapshotsOptionType	定義DeleteSnapshotsOptionType的值。
EncryptionAlgorithmType	定義 EncryptionAlgorithmType 的值。
GeoReplicationStatusType	定義 GeoReplicationStatusType 的值。
LeaseDurationType	定義 LeaseDurationType 的值。
LeaseOperationResponse	包含建立、修改或刪除租用之作業的響應數據。請參閱 <xref:BlobLeaseClient>。
LeaseStateType	定義 LeaseStateType 的值。
LeaseStatusType	定義 LeaseStatusType 的值。
ListBlobsIncludeItem	定義 ListBlobsIncludeItem 的值。
ListContainersIncludeType	定義 ListContainersIncludeType 的值。
ObjectReplicationStatus	指定 Blob 的複寫狀態。當記憶體帳戶已套用物件複寫策略時，就會使用此選項。請參閱 <xref:ObjectReplicationPolicy> 與 <xref:ObjectReplicationRule>。
PageBlobClearPagesResponse	包含 clearPages 作業的響應數據。
PageBlobCopyIncrementalResponse	包含 copyIncremental 作業的響應數據。
PageBlobCreateResponse	包含建立作業的響應數據。
PageBlobResizeResponse	包含重設大小作業的響應數據。
PageBlobUpdateSequenceNumberResponse	包含 updateSequenceNumber 作業的響應數據。
PageBlobUploadPagesFromURLResponse	包含 uploadPagesFromURL 作業的響應數據。
PageBlobUploadPagesResponse	包含 uploadPages 作業的響應數據。
PublicAccessType	定義 PublicAccessType 的值。
RehydratePriority	定義 RehydratePriority 的值。
SequenceNumberActionType	定義 SequenceNumberActionType 的值。
ServiceFindBlobsByTagsSegmentResponse	<xref:BlobServiceClient.findBlobsByTags> 作業的回應。
ServiceGetAccountInfoResponse	包含 getAccountInfo 作業的響應數據。
ServiceGetPropertiesResponse	包含 getProperties 作業的響應數據。
ServiceGetStatisticsResponse	包含 getStatistics 作業的響應數據。
ServiceGetUserDelegationKeyResponse	包含 <xref:getUserDelegationKey> 作業的響應數據。
ServiceListContainersSegmentResponse	包含 listContainersSegment 作業的響應數據。
ServiceSetPropertiesResponse	包含 setProperties 作業的響應數據。
ServiceSubmitBatchResponseModel	包含 submitBatch 作業的響應數據。
SkuName	定義 SkuName 的值。
SyncCopyStatusType	定義 SyncCopyStatusType 的值。
Tags	Blob 標記。

列舉

BlockBlobTier	表示 Blob 上的存取層。如需區塊 Blob 層級階層處理的詳細資訊，請參閱經常性存取、非經常性存取和封存儲存層。
PremiumPageBlobTier	指定要設定 Blob 的分頁 Blob 層。這隻適用於進階記憶體帳戶上的分頁 Blob。如需每個PageBlobTier對應IOPS和輸送量的詳細資訊，請參閱這裡。
SASProtocol	產生的 SAS 通訊協定。
StorageRetryPolicyType	RetryPolicy 類型。

函式

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	僅適用於運行時間NODE.JS。產生 <xref:SASQueryParameters> 物件，其中包含發出實際 REST 要求所需的所有 SAS 查詢參數。
generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)	僅適用於運行時間NODE.JS。建立 SASQueryParameters 的實例。只接受建立 SAS 所需的必要設定。如需選擇性設定，請直接設定對應的屬性，例如許可權、startsOn 和標識符。警告：未提供標識符時，需要許可權和 expiresOn。如果您以這個建構函式初始，您必須將值指派給標識碼或 expiresOn & 許可權。在執行下列代碼段之前，請先填入必要的詳細數據。範例用法： JavaScript // 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(); 使用識別碼的範例： JavaScript // 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 名稱的範例： JavaScript // 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 時，需要有許可權和到期日時，將會忽略標識符。範例用法： JavaScript // 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();
isPipelineLike(unknown)	判斷給定自變數是否符合管線合約的協助程式
newPipeline(StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	使用提供的認證建立新的 Pipeline 物件。

函式詳細資料

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

僅適用於運行時間NODE.JS。產生 <xref:SASQueryParameters> 物件，其中包含發出實際 REST 要求所需的所有 SAS 查詢參數。

TypeScript

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

參數

accountSASSignatureValues: AccountSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

傳回

SASQueryParameters

generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)

僅適用於運行時間NODE.JS。建立 SASQueryParameters 的實例。

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

警告：未提供標識符時，需要許可權和 expiresOn。如果您以這個建構函式初始，您必須將值指派給標識碼或 expiresOn & 許可權。

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

範例用法：

JavaScript

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

使用識別碼的範例：

JavaScript

// 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 名稱的範例：

JavaScript

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

TypeScript

function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

參數

blobSASSignatureValues: BlobSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

傳回

SASQueryParameters

generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)

僅適用於運行時間NODE.JS。建立 SASQueryParameters 的實例。警告：產生使用者委派 SAS 時，需要有許可權和到期日時，將會忽略標識符。

範例用法：

JavaScript

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

TypeScript

function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string)

參數

blobSASSignatureValues: BlobSASSignatureValues

userDelegationKey: UserDelegationKey

傳回值 blobServiceClient.getUserDelegationKey()

accountName: string

傳回

SASQueryParameters

isPipelineLike(unknown)

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

TypeScript

function isPipelineLike(pipeline: unknown)

參數

pipeline: unknown

可能是管線的自變數

傳回

boolean

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

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

TypeScript

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

參數

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

pipelineOptions: StoragePipelineOptions

自選。選項。

傳回

Pipeline

新的 Pipeline 物件。

共用方式為

@azure/storage-blob package

類別

介面

類型別名

列舉

函式

函式詳細資料

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

參數

傳回

generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)

參數

傳回

generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)

參數

傳回

isPipelineLike(unknown)

參數

傳回

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

參數

傳回

其他資源