DirectoryRenameOptions interface
Options to configure the rename operation.
- Extends
Properties
abort |
An implementation of the |
copy |
Optional. 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 x-ms-file-permission or x-ms-file-permission-key. |
destination |
Lease access condition for destination file. Required if the destination file has an active infinite lease. |
file |
Optional. If specified the permission (security descriptor) shall be set for the directory/file. |
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 |
Optional. Key of the permission to be set for the directory/file. Note: Only one of the filePermission or filePermissionKey should be specified. |
ignore |
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. |
metadata | Optional. A name-value pair to associate with a file storage object. |
replace |
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. Note: This value does not override the x-ms-file-copy-ignore-read-only header value. |
source |
Lease access condition for source file. Required if the source file has an active infinite lease. |
timeout |
Optional. The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. |
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
Optional. 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 x-ms-file-permission or x-ms-file-permission-key.
copyFileSmbInfo?: CopyFileSmbInfo
Property Value
destinationLeaseAccessConditions
Lease access condition for destination file. Required if the destination file has an active infinite lease.
destinationLeaseAccessConditions?: LeaseAccessConditions
Property Value
filePermission
Optional. If specified the permission (security descriptor) shall be set for the directory/file.
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
Optional. Key of the permission to be set for the directory/file. Note: Only one of the filePermission or filePermissionKey should be specified.
filePermissionKey?: string
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.
ignoreReadOnly?: boolean
Property Value
boolean
metadata
Optional. A name-value pair to associate with a file storage object.
metadata?: Metadata
Property Value
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. Note: This value does not override the x-ms-file-copy-ignore-read-only header value.
replaceIfExists?: boolean
Property Value
boolean
sourceLeaseAccessConditions
Lease access condition for source file. Required if the source file has an active infinite lease.
sourceLeaseAccessConditions?: LeaseAccessConditions
Property Value
timeoutInSeconds
Optional. The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
timeoutInSeconds?: number
Property Value
number