FileCreateOptionalParams interface

Package:

@azure/storage-file

Optional Parameters.

Extends

RequestOptionsBase

Properties

fileHTTPHeaders	Additional parameters for the operation
filePermission	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.
filePermissionKey	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.
metadata	A name-value pair to associate with a file storage object.
timeoutParameter	The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
customHeaders	User defined custom request headers that will be applied before the request is sent.
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
timeout	The number of milliseconds a request can take before automatically being terminated.

Property Details

fileHTTPHeaders

Additional parameters for the operation

fileHTTPHeaders?: FileHTTPHeaders

Property Value

FileHTTPHeaders

filePermission

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.

filePermission?: string

Property Value

string

filePermissionKey

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.

filePermissionKey?: string

Property Value

string

metadata

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

metadata?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

timeoutParameter

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

timeoutParameter?: number

Property Value

number

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From msRest.RequestOptionsBase.abortSignal

customHeaders

User defined custom request headers that will be applied before the request is sent.

customHeaders?: {[key: string]: string}

Property Value

{[key: string]: string}

Inherited From msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From msRest.RequestOptionsBase.onUploadProgress

timeout

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

timeout?: number

Property Value

number

Inherited From msRest.RequestOptionsBase.timeout