Class ShareFileProperties

Namespace

Azure.Storage.Files.Shares.Models

Assembly

Azure.Storage.Files.Shares.dll

Properties for a file.

public class ShareFileProperties

Inheritance

object

ShareFileProperties

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

CacheControl

If the Cache-Control request header has previously been set for the file, the Cache-Control value is returned in this header.

public string CacheControl { get; }

Property Value

string

ContentDisposition

Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response.

public string ContentDisposition { get; }

Property Value

string

ContentEncoding

If the Content-Encoding request header has previously been set for the file, the Content-Encoding value is returned in this header.

public IEnumerable<string> ContentEncoding { get; }

Property Value

IEnumerable<string>

ContentHash

If the Content-MD5 header has been set for the file, the Content-MD5 response header is returned so that the client can check for message content integrity.

public byte[] ContentHash { get; }

Property Value

byte[]

ContentLanguage

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

public IEnumerable<string> ContentLanguage { get; }

Property Value

IEnumerable<string>

ContentLength

The size of the file in bytes.

public long ContentLength { get; }

Property Value

long

ContentType

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

public string ContentType { get; }

Property Value

string

CopyCompletedOn

Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt.

public DateTimeOffset CopyCompletedOn { get; }

Property Value

DateTimeOffset

CopyId

String identifier for the last attempted Copy File operation where this file was the destination file.

public string CopyId { get; }

Property Value

string

CopyProgress

Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied.

public string CopyProgress { get; }

Property Value

string

CopySource

URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file.

public string CopySource { get; }

Property Value

string

CopyStatus

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

public CopyStatus CopyStatus { get; }

Property Value

CopyStatus

CopyStatusDescription

Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure.

public string CopyStatusDescription { get; }

Property Value

string

ETag

The ETag contains a value that you can use to perform operations conditionally, in quotes.

public ETag ETag { get; }

Property Value

ETag

IsServerEncrypted

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

public bool IsServerEncrypted { get; }

Property Value

bool

LastModified

The DateTimeOffset when the file was last modified.

public DateTimeOffset LastModified { get; }

Property Value

DateTimeOffset

LeaseDuration

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

public ShareLeaseDuration LeaseDuration { get; }

Property Value

ShareLeaseDuration

LeaseState

Lease state of the file.

public ShareLeaseState LeaseState { get; }

Property Value

ShareLeaseState

LeaseStatus

The current lease status of the file.

public ShareLeaseStatus LeaseStatus { get; }

Property Value

ShareLeaseStatus

Metadata

A set of name-value pairs associated with this file as user-defined metadata.

public IDictionary<string, string> Metadata { get; }

Property Value

IDictionary<string, string>

SmbProperties

The SMB properties for the file

public FileSmbProperties SmbProperties { get; set; }

Property Value

FileSmbProperties