DirectoryProperties interface
An interface for options common to every remote operation.
- Extends
Properties
abort |
An implementation of the |
Inherited Properties
change |
The Coordinated Universal Time (UTC) change time property for the directory. A value of now may be used to indicate the time of the request. By default, the value will be set to the time of the request. |
creation |
The Coordinated Universal Time (UTC) creation time property for the directory. A value of now may be used to indicate the time of the request. A value of preserve may be passed to keep an existing value unchanged. By default, the value will be set as preserve. |
file |
The file system attributes to be set on the file or directory. |
file |
The permission(security descriptor) to be set for the file or directory in the Security Descriptor Definition Language (SDDL). If specified, it must have an owner, group, and discretionary access control list (DACL). A value of inherit may be passed to inherit from the parent directory. A value of preserve may be passed to keep the value unchanged. Note that only one of filePermission or filePermissionKey can be specified. And if both are not specified, preserve will be set to filePermission as default value by client library. |
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 |
The key of the permission to be set for the file or directory. This can be created using the Create-Permission API. Note that only one of filePermission or filePermissionKey can be specified. |
last |
The Coordinated Universal Time (UTC) last write property for the directory. A value of now may be used to indicate the time of the request. A value of preserve may be passed to keep an existing value unchanged. By default, the value will be set as preserve. |
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
Inherited Property Details
changeTime
The Coordinated Universal Time (UTC) change time property for the directory. A value of now may be used to indicate the time of the request. By default, the value will be set to the time of the request.
changeTime?: Date | "now"
Property Value
Date | "now"
Inherited From FileAndDirectorySetPropertiesCommonOptions.changeTime
creationTime
The Coordinated Universal Time (UTC) creation time property for the directory. A value of now may be used to indicate the time of the request. A value of preserve may be passed to keep an existing value unchanged. By default, the value will be set as preserve.
creationTime?: Date | "now" | "preserve"
Property Value
Date | "now" | "preserve"
Inherited From FileAndDirectorySetPropertiesCommonOptions.creationTime
fileAttributes
The file system attributes to be set on the file or directory.
fileAttributes?: FileSystemAttributes | "preserve"
Property Value
FileSystemAttributes | "preserve"
Inherited From FileAndDirectorySetPropertiesCommonOptions.fileAttributes
filePermission
The permission(security descriptor) to be set for the file or directory in the Security Descriptor Definition Language (SDDL). If specified, it must have an owner, group, and discretionary access control list (DACL). A value of inherit may be passed to inherit from the parent directory. A value of preserve may be passed to keep the value unchanged.
Note that only one of filePermission or filePermissionKey can be specified. And if both are not specified, preserve will be set to filePermission as default value by client library.
filePermission?: string
Property Value
string
Inherited From FileAndDirectorySetPropertiesCommonOptions.filePermission
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
Inherited From FileAndDirectorySetPropertiesCommonOptions.filePermissionFormat
filePermissionKey
The key of the permission to be set for the file or directory. This can be created using the Create-Permission API.
Note that only one of filePermission or filePermissionKey can be specified.
filePermissionKey?: string
Property Value
string
Inherited From FileAndDirectorySetPropertiesCommonOptions.filePermissionKey
lastWriteTime
The Coordinated Universal Time (UTC) last write property for the directory. A value of now may be used to indicate the time of the request. A value of preserve may be passed to keep an existing value unchanged. By default, the value will be set as preserve.
lastWriteTime?: Date | "now" | "preserve"
Property Value
Date | "now" | "preserve"
Inherited From FileAndDirectorySetPropertiesCommonOptions.lastWriteTime