ShareFileCopyOptions Class

  • Reference

Definition

Namespace:
Azure.Storage.Files.Shares.Models
Assembly:
Azure.Storage.Files.Shares.dll
Package:
Azure.Storage.Files.Shares v12.20.1
Package:
Azure.Storage.Files.Shares v12.21.0-beta.2
Source:
ShareFileCopyOptions.cs
Source:
ShareFileCopyOptions.cs

Optional parameters for ShareFileClient.StartCopy() and .StartCopyAsync().

public class ShareFileCopyOptions
type ShareFileCopyOptions = class
Public Class ShareFileCopyOptions
Inheritance
Object
ShareFileCopyOptions

Constructors

ShareFileCopyOptions()

Properties

Archive

Optional boolean Specifying to set archive attribute on a target file. True means archive attribute will be set on a target file despite attribute overrides or a source file state.
Conditions

Optional ShareFileRequestConditions to add conditions on copying the file.
FilePermission

Optional file permission to set for the destination file.
FilePermissionCopyMode

Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of FilePermission or FilePermissionKey.
IgnoreReadOnly

Optional boolean specifying to overwrite the target file if it already exists and has read-only attribute set.
Metadata

Optional custom metadata to set on the destination file.
PermissionFormat

Specifies the format in which the file permission is returned. If unspecified or explicitly set to SDDL, the permission is returned in SDDL format. If explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission.
SmbProperties

Optional SMB properties to set on the destination file.
SmbPropertiesToCopy

SMB properties to copy from the source file.

Applies to