FileCreateOptionalParams | @azure/storage-file-share

Optional Parameters.

Hierarchy

RequestOptionsBase
- FileCreateOptionalParams

Indexable

[key: string]: any

Optional Parameters.

Index

Properties

Optional abortSignal

abortSignal: AbortSignalLike

The signal which can be used to abort requests.

Optional customHeaders

customHeaders: undefined | object

property: {object} [customHeaders] User defined custom request headers that will be applied before the request is sent.

Optional fileHttpHeaders

fileHttpHeaders: FileHttpHeaders

Additional parameters for the operation

Optional filePermission

filePermission: undefined | string

If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.

Optional filePermissionKey

filePermissionKey: undefined | string

Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.

Optional metadata

metadata: undefined | object

A name-value pair to associate with a file storage object.

Optional onDownloadProgress

onDownloadProgress: undefined | function

Callback which fires upon download progress.

Optional onUploadProgress

onUploadProgress: undefined | function

Callback which fires upon upload progress.

Optional spanOptions

spanOptions: SpanOptions

Options used to create a span when tracing is enabled.

Optional timeout

timeout: undefined | number

The number of milliseconds a request can take before automatically being terminated.

Optional timeoutInSeconds

timeoutInSeconds: undefined | number

The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.