FileCreateOptions interface

Package:

@azure/storage-file-share

Options to configure the create operation.

Extends

FileAndDirectoryCreateCommonOptions,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.
fileHttpHeaders	File HTTP headers like Content-Type.
leaseAccessConditions	Lease access conditions.
metadata	A collection of key-value string pair to associate with the file storage object.

Inherited Properties

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.
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. By default, the value will be set as now.
fileAttributes	The file system attributes to be set on the file or directory.
filePermission	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.
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	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.
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. By default, the value will be set as now.
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

fileHttpHeaders

File HTTP headers like Content-Type.

fileHttpHeaders?: FileHttpHeaders

Property Value

FileHttpHeaders

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

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

creationTime?: Date | "now"

Property Value

Date | "now"

Inherited From FileAndDirectoryCreateCommonOptions.creationTime

fileAttributes

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

fileAttributes?: FileSystemAttributes

Property Value

FileSystemAttributes

Inherited From FileAndDirectoryCreateCommonOptions.fileAttributes

filePermission

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.

filePermission?: string

Property Value

string

Inherited From FileAndDirectoryCreateCommonOptions.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

FilePermissionFormat

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

lastWriteTime?: Date | "now"

Property Value

Date | "now"

Inherited From FileAndDirectoryCreateCommonOptions.lastWriteTime

tracingOptions

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions