Share via


PathProperties Class

Definition

PathProperties

public class PathProperties
type PathProperties = class
Public Class PathProperties
Inheritance
PathProperties

Properties

AcceptRanges

Indicates that the service supports requests for partial path content.

AccessControlList

Optional. The POSIX access control list for the file or directory.

AccessTier

The tier of block blob on blob storage LRS accounts. For blob storage LRS accounts, valid values are Hot/Cool/Archive.

AccessTierChangedOn

The time the tier was changed on the object. This is only returned if the tier on the block blob was ever set.

ArchiveStatus

For blob storage LRS accounts, valid values are rehydrate-pending-to-hot/rehydrate-pending-to-cool. If the blob is being rehydrated and is not complete then this header is returned indicating that rehydrate is pending and also tells the destination tier.

CacheControl

This header is returned if it was previously specified for the path.

ContentDisposition

This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the path name specified.

ContentEncoding

This header returns the value that was specified for the Content-Encoding request header

ContentHash

If the path has an MD5 hash and this operation is to read the full path, this response header is returned so that the client can check for message content integrity.

ContentLanguage

This header returns the value that was specified for the Content-Language request header.

ContentLength

The number of bytes present in the response body.

ContentType

The content type specified for the path. The default content type is 'application/octet-stream'

CopyCompletedOn

Conclusion time of the last attempted Copy Blob operation where this path was the destination path. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this path has never been the destination in a Copy path operation, or if this path has been modified after a concluded Copy Blob operation using Set path Properties, Put path, or Put Block List.

CopyId

String identifier for this copy operation. Use with Get Path Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy.

CopyProgress

Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this path was the destination pth. Can show between 0 and Content-Length bytes copied. This header does not appear if this path has never been the destination in a Copy Blob operation, or if this path has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List

CopySource

URL up to 2 KB in length that specifies the source path or file used in the last attempted Copy Blob operation where this path was the destination path. This header does not appear if this path has never been the destination in a Copy Blob operation, or if this path has been modified after a concluded Copy Blob operation using Set Path Properties, Put Blob, or Put Block List.

CopyStatus

State of the copy operation identified by x-ms-copy-id.

CopyStatusDescription

Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this path has never been the destination in a Copy Blob operation, or if this path has been modified after a concluded Copy Blob operation using Set Path Properties, Put Blob, or Put Block List

CreatedOn

Returns the date and time the path was created.

EncryptionContext

Encryption context of the file. Encryption context is metadata that is not encrypted when stored on the file. The primary application of this field is to store non-encrypted data that can be used to derive the customer-provided key for a file. Not applicable for directories.

EncryptionKeySha256

The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the metadata was encrypted with a customer-provided key.

EncryptionScope

Returns the name of the encryption scope used to encrypt the path contents and application metadata. Note that the absence of this header implies use of the default account encryption scope, or default file system encryption scope, if it has been set.

ETag

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

ExpiresOn

The time the path will be deleted.

Group

Group.

IsDirectory

If this path represents a directory.

IsIncrementalCopy

Included if the path is incremental copy blob.

IsServerEncrypted

The value of this header is set to true if the path data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the path is unencrypted, or if only parts of the path/application metadata are encrypted).

LastModified

Returns the date and time the path was last modified. Any operation that modifies the path, including an update of the path's metadata or properties, changes the last-modified time of the path.

LeaseDuration

When a path is leased, specifies whether the lease is of infinite or fixed duration.

LeaseState

Lease state of the path.

LeaseStatus

The current lease status of the path.

Metadata

The Path's metdata.

Owner

Owner.

Permissions

Permissions.

Applies to