BlobGetPropertiesResponse interface

參考

套件:: @azure/storage-blob

包含 getProperties 作業的響應數據。

Extends: BlobGetPropertiesResponseModel

屬性

objectReplicationDestinationPolicyId	目的地 Blob 的物件複寫策略標識碼。
objectReplicationSourceProperties	剖析的物件復寫策略標識碼、規則標識元和來源 Blob 的狀態。

繼承的屬性

acceptRanges	表示服務支援部分 Blob 內容的要求。
accessTier	進階記憶體帳戶上的分頁 Blob 層，或 Blob 記憶體 LRS 帳戶上的區塊 Blob 層。如需允許的進階分頁 Blob 層清單，請參閱 https://docs.microsoft.com/en-us/azure/virtual-machines/windows/premium-storage#features。針對 Blob 記憶體 LRS 帳戶，有效值為經常性/非經常性/封存。
accessTierChangedOn	對象上變更階層的時間。只有在已設定區塊 Blob 上的層時，才會傳回這個值。
accessTierInferred	僅適用於進階記憶體帳戶上的分頁 Blob。如果未在 Blob 上明確設定存取層，則會根據其內容長度推斷該層，而且此標頭會以 true 值傳回。
archiveStatus	對於 Blob 記憶體 LRS 帳戶，有效值為 rehydrate-pending-to-hot/rehydrate-pending-to-cool。如果 Blob 正在解除凍結且尚未完成，則會傳回此標頭，表示解除凍結已擱置，也會告知目的地層。
blobCommittedBlockCount	Blob 中存在的已認可區塊數目。此標頭只會針對附加 Blob 傳回。
blobSequenceNumber	分頁 Blob 的目前序號。區塊 Blob 或附加 Blob 不會傳回此標頭
blobType	Blob 的類型。
cacheControl	如果先前已為 Blob 指定此標頭，則會傳回此標頭。
clientRequestId	如果在要求中傳送用戶端要求標識符標頭，此標頭將會出現在具有相同值的回應中。
contentDisposition	此標頭會傳回為 'x-ms-blob-content-disposition' 標頭指定的值。 Content-Disposition 回應標頭字段會傳達有關如何處理響應承載的其他資訊，也可用來附加其他元數據。例如，如果設定為附件，則表示使用者代理程式不應該顯示回應，而是顯示 [另存新檔] 對話方塊，其檔名不是指定的 Blob 名稱。
contentEncoding	此標頭會傳回針對 Content-Encoding 要求標頭指定的值
contentLanguage	此標頭會傳回為 Content-Language 要求標頭指定的值。
contentLength	Blob 的大小，以位元組為單位。對於分頁 Blob，此標頭會傳回與 Blob 一起儲存的 x-ms-blob-content-length 標頭值。
contentMD5	如果 Blob 具有 MD5 哈希，而且此作業是讀取完整的 Blob，則會傳回此回應標頭，讓用戶端可以檢查訊息內容完整性。
contentType	為 Blob 指定的內容類型。默認內容類型為 'application/octet-stream'
copyCompletedOn	上次嘗試複製 Blob 作業的結束時間，其中此 Blob 是目的地 Blob。這個值可以指定完成、中止或失敗複製嘗試的時間。如果複製擱置中、如果此 Blob 從未成為複製 Blob 作業中的目的地，或是此 Blob 在結束的複製 Blob 作業之後使用 [設定 Blob 屬性]、[放置 Blob] 或 [放置區塊清單] 進行修改，則不會出現此標頭。
copyId	此複製作業的字串識別碼。使用取得 Blob 屬性來檢查此複製作業的狀態，或傳遞至中止複製 Blob 以中止暫止的複本。
copyProgress	包含複製的位元組數目，以及上次嘗試複製 Blob 作業中來源中的位元組總數，其中此 Blob 是目的地 Blob。可以顯示複製的介於 0 和 Content-Length 位元組之間。如果此 Blob 從未是複製 Blob 作業中的目的地，或是此 Blob 在結束的複製 Blob 作業之後使用設定 Blob 屬性、放置 Blob 或放置區塊清單進行修改，則不會出現此標頭
copySource	長度最多 2 KB 的 URL，指定上次嘗試複製 Blob 作業中使用的來源 Blob 或檔案，其中此 Blob 是目的地 Blob。如果此 Blob 從未是複製 Blob 作業中的目的地，或是此 Blob 在結束的複製 Blob 作業之後使用設定 Blob 屬性、放置 Blob 或放置區塊清單進行修改，則不會出現此標頭。
copyStatus	x-ms-copy-id 所識別之複製作業的狀態。
copyStatusDescription	只有在 x-ms-copy-status 失敗或擱置時才會出現。描述最後一個致命或非嚴重複製作業失敗的原因。如果此 Blob 從未是複製 Blob 作業中的目的地，或是此 Blob 在結束的複製 Blob 作業之後使用設定 Blob 屬性、放置 Blob 或放置區塊清單進行修改，則不會出現此標頭
createdOn	傳回建立 Blob 的日期和時間。
date	服務所產生的 UTC 日期/時間值，指出回應起始的時間
destinationSnapshot	如果 Blob 是累加複製 Blob 或累加複製快照集，則包含 x-ms-copy-status 為成功。此 Blob 上次成功增量複製快照集的快照集時間。
encryptionKeySha256	用來加密元數據之加密金鑰的 SHA-256 哈希。只有當元數據使用客戶提供的金鑰加密時，才會傳回此標頭。
encryptionScope	傳回用來加密 Blob 內容和應用程式元數據的加密範圍名稱。請注意，缺少此標頭表示使用預設帳戶加密範圍。
errorCode	錯誤碼
etag	ETag 包含一個值，可用來有條件地執行作業。如果要求版本是 2011-08-18 或更新版本，ETag 值將會以引號括住。
expiresOn	此 Blob 到期的時間。
immutabilityPolicyExpiresOn	服務所產生的 UTC 日期/時間值，指出 Blob 不變性原則到期的時間。
immutabilityPolicyMode	表示不變性原則模式。
isCurrentVersion	此標頭的值表示此 Blob 的版本是否為目前版本，另請參閱 x-ms-version-id 標頭。
isIncrementalCopy	如果 Blob 是累加複製 Blob，則包含此 Blob。
isSealed	如果此 Blob 已密封
isServerEncrypted	如果 Blob 資料和應用程式元數據使用指定的演算法完全加密，則此標頭的值會設定為 true。否則，此值會設定為 false （當 Blob 未加密時，或只加密 Blob/應用程式元數據的一部分時）。
lastAccessed	服務所產生的 UTC 日期/時間值，指出 Blob 上次讀取或寫入的時間
lastModified	傳回上次修改 Blob 的日期和時間。任何修改 Blob 的作業，包括 Blob 元數據或屬性的更新，會變更 Blob 上次修改的時間。
leaseDuration	當 Blob 租用時，指定租用是無限期還是固定持續時間。
leaseState	Blob 的租用狀態。
leaseStatus	Blob 目前的租用狀態。
legalHold	指出 Blob 上是否有法律保留。
metadata
objectReplicationPolicyId	自選。只有在針對記憶體容器和復寫的目的地 Blob 啟用物件複寫時，才有效。
objectReplicationRules	自選。只有在針對記憶體容器和復寫的來源 Blob 啟用物件複寫時才有效。擷取此標頭時，它會傳回具有原則標識碼和規則標識碼的標頭（例如 x-ms-or-policyid_ruleid），而此值將會是復寫的狀態（例如完成、失敗）。
rehydratePriority	如果對象處於解除凍結擱置狀態，則會以解除凍結的優先順序傳回此標頭。
requestId	此標頭可唯一識別已提出並可用於對要求進行疑難解答的要求。
tagCount	與 Blob 相關聯的標籤目
version	指出用來執行要求的 Blob 服務版本。針對針對 2009-09-19 版和更新版本提出的要求，會傳回此標頭。
versionId	服務所傳回的 DateTime 值，可唯一識別 Blob。此標頭的值表示 Blob 版本，而且可用於後續要求來存取此 Blob 版本。

屬性詳細資料

objectReplicationDestinationPolicyId

目的地 Blob 的物件複寫策略標識碼。

objectReplicationDestinationPolicyId?: string

屬性值

string

objectReplicationSourceProperties

剖析的物件復寫策略標識碼、規則標識元和來源 Blob 的狀態。

objectReplicationSourceProperties?: ObjectReplicationPolicy[]

屬性值

ObjectReplicationPolicy[]

繼承的屬性詳細資料

acceptRanges

表示服務支援部分 Blob 內容的要求。

acceptRanges?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.acceptRanges

accessTier

進階記憶體帳戶上的分頁 Blob 層，或 Blob 記憶體 LRS 帳戶上的區塊 Blob 層。如需允許的進階分頁 Blob 層清單，請參閱 https://docs.microsoft.com/en-us/azure/virtual-machines/windows/premium-storage#features。針對 Blob 記憶體 LRS 帳戶，有效值為經常性/非經常性/封存。

accessTier?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.accessTier

accessTierChangedOn

對象上變更階層的時間。只有在已設定區塊 Blob 上的層時，才會傳回這個值。

accessTierChangedOn?: Date

屬性值

Date

繼承自 BlobGetPropertiesResponseModel.accessTierChangedOn

accessTierInferred

僅適用於進階記憶體帳戶上的分頁 Blob。如果未在 Blob 上明確設定存取層，則會根據其內容長度推斷該層，而且此標頭會以 true 值傳回。

accessTierInferred?: boolean

屬性值

boolean

繼承自 BlobGetPropertiesResponseModel.accessTierInferred

archiveStatus

對於 Blob 記憶體 LRS 帳戶，有效值為 rehydrate-pending-to-hot/rehydrate-pending-to-cool。如果 Blob 正在解除凍結且尚未完成，則會傳回此標頭，表示解除凍結已擱置，也會告知目的地層。

archiveStatus?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.archiveStatus

blobCommittedBlockCount

Blob 中存在的已認可區塊數目。此標頭只會針對附加 Blob 傳回。

blobCommittedBlockCount?: number

屬性值

number

繼承自 BlobGetPropertiesResponseModel.blobCommittedBlockCount

blobSequenceNumber

分頁 Blob 的目前序號。區塊 Blob 或附加 Blob 不會傳回此標頭

blobSequenceNumber?: number

屬性值

number

繼承自 BlobGetPropertiesResponseModel.blobSequenceNumber

blobType

Blob 的類型。

blobType?: BlobType

屬性值

BlobType

繼承自 BlobGetPropertiesResponseModel.blobType

cacheControl

如果先前已為 Blob 指定此標頭，則會傳回此標頭。

cacheControl?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.cacheControl

clientRequestId

如果在要求中傳送用戶端要求標識符標頭，此標頭將會出現在具有相同值的回應中。

clientRequestId?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.clientRequestId

contentDisposition

此標頭會傳回為 'x-ms-blob-content-disposition' 標頭指定的值。 Content-Disposition 回應標頭字段會傳達有關如何處理響應承載的其他資訊，也可用來附加其他元數據。例如，如果設定為附件，則表示使用者代理程式不應該顯示回應，而是顯示 [另存新檔] 對話方塊，其檔名不是指定的 Blob 名稱。

contentDisposition?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.contentDisposition

contentEncoding

此標頭會傳回針對 Content-Encoding 要求標頭指定的值

contentEncoding?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.contentEncoding

contentLanguage

此標頭會傳回為 Content-Language 要求標頭指定的值。

contentLanguage?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.contentLanguage

contentLength

Blob 的大小，以位元組為單位。對於分頁 Blob，此標頭會傳回與 Blob 一起儲存的 x-ms-blob-content-length 標頭值。

contentLength?: number

屬性值

number

繼承自 BlobGetPropertiesResponseModel.contentLength

contentMD5

如果 Blob 具有 MD5 哈希，而且此作業是讀取完整的 Blob，則會傳回此回應標頭，讓用戶端可以檢查訊息內容完整性。

contentMD5?: Uint8Array

屬性值

Uint8Array

繼承自 BlobGetPropertiesResponseModel.contentMD5

contentType

為 Blob 指定的內容類型。默認內容類型為 'application/octet-stream'

contentType?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.contentType

copyCompletedOn

上次嘗試複製 Blob 作業的結束時間，其中此 Blob 是目的地 Blob。這個值可以指定完成、中止或失敗複製嘗試的時間。如果複製擱置中、如果此 Blob 從未成為複製 Blob 作業中的目的地，或是此 Blob 在結束的複製 Blob 作業之後使用 [設定 Blob 屬性]、[放置 Blob] 或 [放置區塊清單] 進行修改，則不會出現此標頭。

copyCompletedOn?: Date

屬性值

Date

繼承自 BlobGetPropertiesResponseModel.copyCompletedOn

copyId

此複製作業的字串識別碼。使用取得 Blob 屬性來檢查此複製作業的狀態，或傳遞至中止複製 Blob 以中止暫止的複本。

copyId?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.copyId

copyProgress

包含複製的位元組數目，以及上次嘗試複製 Blob 作業中來源中的位元組總數，其中此 Blob 是目的地 Blob。可以顯示複製的介於 0 和 Content-Length 位元組之間。如果此 Blob 從未是複製 Blob 作業中的目的地，或是此 Blob 在結束的複製 Blob 作業之後使用設定 Blob 屬性、放置 Blob 或放置區塊清單進行修改，則不會出現此標頭

copyProgress?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.copyProgress

copySource

長度最多 2 KB 的 URL，指定上次嘗試複製 Blob 作業中使用的來源 Blob 或檔案，其中此 Blob 是目的地 Blob。如果此 Blob 從未是複製 Blob 作業中的目的地，或是此 Blob 在結束的複製 Blob 作業之後使用設定 Blob 屬性、放置 Blob 或放置區塊清單進行修改，則不會出現此標頭。

copySource?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.copySource

copyStatus

x-ms-copy-id 所識別之複製作業的狀態。

copyStatus?: CopyStatusType

屬性值

CopyStatusType

繼承自 BlobGetPropertiesResponseModel.copyStatus

copyStatusDescription

只有在 x-ms-copy-status 失敗或擱置時才會出現。描述最後一個致命或非嚴重複製作業失敗的原因。如果此 Blob 從未是複製 Blob 作業中的目的地，或是此 Blob 在結束的複製 Blob 作業之後使用設定 Blob 屬性、放置 Blob 或放置區塊清單進行修改，則不會出現此標頭

copyStatusDescription?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.copyStatusDescription

createdOn

傳回建立 Blob 的日期和時間。

createdOn?: Date

屬性值

Date

繼承自 BlobGetPropertiesResponseModel.createdOn

date

服務所產生的 UTC 日期/時間值，指出回應起始的時間

date?: Date

屬性值

Date

繼承自 BlobGetPropertiesResponseModel.date

destinationSnapshot

如果 Blob 是累加複製 Blob 或累加複製快照集，則包含 x-ms-copy-status 為成功。此 Blob 上次成功增量複製快照集的快照集時間。

destinationSnapshot?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.destinationSnapshot

encryptionKeySha256

用來加密元數據之加密金鑰的 SHA-256 哈希。只有當元數據使用客戶提供的金鑰加密時，才會傳回此標頭。

encryptionKeySha256?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.encryptionKeySha256

encryptionScope

傳回用來加密 Blob 內容和應用程式元數據的加密範圍名稱。請注意，缺少此標頭表示使用預設帳戶加密範圍。

encryptionScope?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.encryptionScope

errorCode

錯誤碼

errorCode?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.errorCode

etag

ETag 包含一個值，可用來有條件地執行作業。如果要求版本是 2011-08-18 或更新版本，ETag 值將會以引號括住。

etag?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.etag

expiresOn

此 Blob 到期的時間。

expiresOn?: Date

屬性值

Date

繼承自 BlobGetPropertiesResponseModel.expiresOn

immutabilityPolicyExpiresOn

服務所產生的 UTC 日期/時間值，指出 Blob 不變性原則到期的時間。

immutabilityPolicyExpiresOn?: Date

屬性值

Date

繼承自 BlobGetPropertiesResponseModel.immutabilityPolicyExpiresOn

immutabilityPolicyMode

表示不變性原則模式。

immutabilityPolicyMode?: BlobImmutabilityPolicyMode

屬性值

BlobImmutabilityPolicyMode

繼承自 BlobGetPropertiesResponseModel.immutabilityPolicyMode

isCurrentVersion

此標頭的值表示此 Blob 的版本是否為目前版本，另請參閱 x-ms-version-id 標頭。

isCurrentVersion?: boolean

屬性值

boolean

繼承自 BlobGetPropertiesResponseModel.isCurrentVersion

isIncrementalCopy

如果 Blob 是累加複製 Blob，則包含此 Blob。

isIncrementalCopy?: boolean

屬性值

boolean

繼承自 BlobGetPropertiesResponseModel.isIncrementalCopy

isSealed

如果此 Blob 已密封

isSealed?: boolean

屬性值

boolean

繼承自 BlobGetPropertiesResponseModel.isSealed

isServerEncrypted

如果 Blob 資料和應用程式元數據使用指定的演算法完全加密，則此標頭的值會設定為 true。否則，此值會設定為 false （當 Blob 未加密時，或只加密 Blob/應用程式元數據的一部分時）。

isServerEncrypted?: boolean

屬性值

boolean

繼承自 BlobGetPropertiesResponseModel.isServerEncrypted

lastAccessed

服務所產生的 UTC 日期/時間值，指出 Blob 上次讀取或寫入的時間

lastAccessed?: Date

屬性值

Date

繼承自 BlobGetPropertiesResponseModel.lastAccessed

lastModified

傳回上次修改 Blob 的日期和時間。任何修改 Blob 的作業，包括 Blob 元數據或屬性的更新，會變更 Blob 上次修改的時間。

lastModified?: Date

屬性值

Date

繼承自 BlobGetPropertiesResponseModel.lastModified

leaseDuration

當 Blob 租用時，指定租用是無限期還是固定持續時間。

leaseDuration?: LeaseDurationType

屬性值

LeaseDurationType

繼承自 BlobGetPropertiesResponseModel.leaseDuration

leaseState

Blob 的租用狀態。

leaseState?: LeaseStateType

屬性值

LeaseStateType

繼承自 BlobGetPropertiesResponseModel.leaseState

leaseStatus

Blob 目前的租用狀態。

leaseStatus?: LeaseStatusType

屬性值

LeaseStatusType

繼承自 BlobGetPropertiesResponseModel.leaseStatus

legalHold

指出 Blob 上是否有法律保留。

legalHold?: boolean

屬性值

boolean

繼承自 BlobGetPropertiesResponseModel.legalHold

metadata

metadata?: {[propertyName: string]: string}

屬性值

{[propertyName: string]: string}

繼承自 BlobGetPropertiesResponseModel.metadata

objectReplicationPolicyId

自選。只有在針對記憶體容器和復寫的目的地 Blob 啟用物件複寫時，才有效。

objectReplicationPolicyId?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.objectReplicationPolicyId

objectReplicationRules

自選。只有在針對記憶體容器和復寫的來源 Blob 啟用物件複寫時才有效。擷取此標頭時，它會傳回具有原則標識碼和規則標識碼的標頭（例如 x-ms-or-policyid_ruleid），而此值將會是復寫的狀態（例如完成、失敗）。

objectReplicationRules?: {[propertyName: string]: string}

屬性值

{[propertyName: string]: string}

繼承自 BlobGetPropertiesResponseModel.objectReplicationRules

rehydratePriority

如果對象處於解除凍結擱置狀態，則會以解除凍結的優先順序傳回此標頭。

rehydratePriority?: RehydratePriority

屬性值

RehydratePriority

繼承自 BlobGetPropertiesResponseModel.rehydratePriority

requestId

此標頭可唯一識別已提出並可用於對要求進行疑難解答的要求。

requestId?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.requestId

tagCount

與 Blob 相關聯的標籤目

tagCount?: number

屬性值

number

繼承自 BlobGetPropertiesResponseModel.tagCount

version

指出用來執行要求的 Blob 服務版本。針對針對 2009-09-19 版和更新版本提出的要求，會傳回此標頭。

version?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.version

versionId

服務所傳回的 DateTime 值，可唯一識別 Blob。此標頭的值表示 Blob 版本，而且可用於後續要求來存取此 Blob 版本。

versionId?: string

屬性值

string

繼承自 BlobGetPropertiesResponseModel.versionId

共用方式為

BlobGetPropertiesResponse interface

屬性

繼承的屬性

屬性詳細資料

objectReplicationDestinationPolicyId

屬性值

objectReplicationSourceProperties

屬性值

繼承的屬性詳細資料

acceptRanges

屬性值

accessTier

屬性值

accessTierChangedOn

屬性值

accessTierInferred

屬性值

archiveStatus

屬性值

blobCommittedBlockCount

屬性值

blobSequenceNumber

屬性值

blobType

屬性值

cacheControl

屬性值

clientRequestId

屬性值

contentDisposition

屬性值

contentEncoding

屬性值

contentLanguage

屬性值

contentLength

屬性值

contentMD5

屬性值

contentType

屬性值

copyCompletedOn

屬性值

copyId

屬性值

copyProgress

屬性值

copySource

屬性值

copyStatus

屬性值

copyStatusDescription

屬性值

createdOn

屬性值

date

屬性值

destinationSnapshot

屬性值

encryptionKeySha256

屬性值

encryptionScope

屬性值

errorCode

屬性值

etag

屬性值

expiresOn

屬性值

immutabilityPolicyExpiresOn

屬性值

immutabilityPolicyMode

屬性值

isCurrentVersion

屬性值

isIncrementalCopy

屬性值

isSealed

屬性值