FileStartCopyOptions interface
Options to configure the startCopyFromURL operation.
- Extends
Properties
abort |
An implementation of the |
copy |
SMB info. |
file |
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. |
file |
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 |
file |
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. |
lease |
Lease access conditions. |
metadata | A collection of key-value string pair to associate with the file storage object. |
Inherited Properties
tracing |
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
copyFileSmbInfo
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
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
metadata
A collection of key-value string pair to associate with the file storage object.
metadata?: Metadata