Class ShareFileRenameOptions

Namespace

Azure.Storage.Files.Shares.Models

Assembly

Azure.Storage.Files.Shares.dll

Optional parameters for renaming a File or Directory.

public class ShareFileRenameOptions

Inheritance

object

ShareFileRenameOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ShareFileRenameOptions()

public ShareFileRenameOptions()

Properties

ContentType

Optional content type to set on the File. Note that this parameter does not apply for Directories.

public string ContentType { get; set; }

Property Value

string

DestinationConditions

Destination request conditions.

public ShareFileRequestConditions DestinationConditions { get; set; }

Property Value

ShareFileRequestConditions

FilePermission

Optional file permission to set on the destination file or directory.

public string FilePermission { get; set; }

Property Value

string

IgnoreReadOnly

Optional. A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail.

public bool? IgnoreReadOnly { get; set; }

Property Value

bool?

Metadata

Optional custom metadata to set on the destination.

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

Property Value

IDictionary<string, string>

ReplaceIfExists

Optional. A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the destination file. If not provided or if false and the destination file does exist, the request will not overwrite the destination file. If provided and the destination file doesn’t exist, the rename will succeed.

public bool? ReplaceIfExists { get; set; }

Property Value

bool?

SmbProperties

Optional SMB properties to set on the destination file or directory.

public FileSmbProperties SmbProperties { get; set; }

Property Value

FileSmbProperties

SourceConditions

Source request conditions. This parameter is only applicable if the source is a file.

public ShareFileRequestConditions SourceConditions { get; set; }

Property Value

ShareFileRequestConditions