FileStartCopyOptions interface

Package:

@azure/storage-file-share

Options to configure the startCopyFromURL operation.

Extends

CommonOptions

Properties

abortSignal	An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.
copyFileSmbInfo	SMB info.
fileModeCopyMode	Optional, only applicable to NFS Files. Applicable only when the copy source is a File. Determines the copy behavior of the mode bits of the file. source: The mode on the destination file is copied from the source file. override: The mode on the destination file is determined via the x-ms-mode header.
fileOwnerCopyMode	Optional, only applicable to NFS Files. Determines the copy behavior of the owner user identifier (UID) and group identifier (GID) of the file. source: The owner user identifier (UID) and group identifier (GID) on the destination file is copied from the source file. override: The owner user identifier (UID) and group identifier (GID) on the destination file is determined via the x-ms-owner and x-ms-group headers.
filePermission	If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is lesser than or equal to 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.
filePermissionFormat	Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission
filePermissionKey	Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.
leaseAccessConditions	Lease access conditions.
metadata	A collection of key-value string pair to associate with the file storage object.
posixProperties	Optional properties to set on NFS files. Note that this property is only applicable to files created in NFS shares.

Inherited Properties

tracingOptions

Property Details

abortSignal

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

copyFileSmbInfo

SMB info.

copyFileSmbInfo?: CopyFileSmbInfo

Property Value

CopyFileSmbInfo

fileModeCopyMode

Optional, only applicable to NFS Files. Applicable only when the copy source is a File. Determines the copy behavior of the mode bits of the file. source: The mode on the destination file is copied from the source file. override: The mode on the destination file is determined via the x-ms-mode header.

fileModeCopyMode?: ModeCopyMode

Property Value

ModeCopyMode

fileOwnerCopyMode

Optional, only applicable to NFS Files. Determines the copy behavior of the owner user identifier (UID) and group identifier (GID) of the file. source: The owner user identifier (UID) and group identifier (GID) on the destination file is copied from the source file. override: The owner user identifier (UID) and group identifier (GID) on the destination file is determined via the x-ms-owner and x-ms-group headers.

fileOwnerCopyMode?: OwnerCopyMode

Property Value

OwnerCopyMode

filePermission

If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is lesser than or equal to 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.

filePermission?: string

Property Value

string

filePermissionFormat

Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission

filePermissionFormat?: FilePermissionFormat

Property Value

FilePermissionFormat

filePermissionKey

Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.

filePermissionKey?: string

Property Value

string

leaseAccessConditions

Lease access conditions.

leaseAccessConditions?: LeaseAccessConditions

Property Value

LeaseAccessConditions

metadata

A collection of key-value string pair to associate with the file storage object.

metadata?: Metadata

Property Value

Metadata

posixProperties

Optional properties to set on NFS files. Note that this property is only applicable to files created in NFS shares.

posixProperties?: FilePosixProperties

Property Value

FilePosixProperties

Inherited Property Details

tracingOptions

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions