Package version:

Interface DirectoryCreateOptions

Options to configure ShareDirectoryClient.create operation.

interface DirectoryCreateOptions {
    abortSignal?: any;
    changeTime?: Date | "now";
    creationTime?: Date | "now";
    fileAttributes?: FileSystemAttributes;
    filePermission?: string;
    filePermissionFormat?: FilePermissionFormat;
    filePermissionKey?: string;
    lastWriteTime?: Date | "now";
    metadata?: Metadata;
    posixProperties?: FilePosixProperties;
    tracingOptions?: any;
}

Hierarchy (view full)

Properties

abortSignal? changeTime? creationTime? fileAttributes? filePermission? filePermissionFormat? filePermissionKey? lastWriteTime? metadata? posixProperties? tracingOptions?

Properties

OptionalabortSignal

abortSignal?: any

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.

OptionalchangeTime

changeTime?: Date | "now"

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.

OptionalcreationTime

creationTime?: Date | "now"

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. By default, the value will be set as now.

OptionalfileAttributes

fileAttributes?: FileSystemAttributes

The file system attributes to be set on the file or directory.

OptionalfilePermission

filePermission?: string

The permission(security descriptor) to be set for the file or directory in the Security Descriptor Definition Language (SDDL) or binary. 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.

Note that only one of filePermission or filePermissionKey can be specified. And if both are not specified, inherit will be set to filePermission as default value by client library.

OptionalfilePermissionFormat

filePermissionFormat?: 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

OptionalfilePermissionKey

filePermissionKey?: string

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.

OptionallastWriteTime

lastWriteTime?: Date | "now"

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. By default, the value will be set as now.

Optionalmetadata

metadata?: Metadata

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

OptionalposixProperties

posixProperties?: FilePosixProperties

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

OptionaltracingOptions

tracingOptions?: any

Settings

Member Visibility