Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FileCreateOptions

Package version

Options to configure the ShareFileClient.create operation.

Hierarchy

Index

Properties

Optional abortSignal

abortSignal: AbortSignalLike

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.

Optional creationTime

creationTime: Date | TimeNowType

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.

Optional fileAttributes

fileAttributes: FileSystemAttributes

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

Optional fileHttpHeaders

fileHttpHeaders: FileHttpHeaders

File HTTP headers like Content-Type.

Optional filePermission

filePermission: string | FilePermissionInheritType

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.

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.

Optional filePermissionKey

filePermissionKey: undefined | 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.

Optional lastWriteTime

lastWriteTime: Date | TimeNowType

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.

Optional leaseAccessConditions

leaseAccessConditions: LeaseAccessConditions

Lease access conditions.

Optional metadata

metadata: Metadata

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

Optional tracingOptions

tracingOptions: OperationTracingOptions

Generated using TypeDoc