FileSetHTTPHeadersOptionalParams interface

包:

@azure/storage-file

可选参数。

扩展

RequestOptionsBase

属性

abortSignal	可用于中止请求的信号。
customHeaders	{object}[customHeaders]将在发送请求之前应用的用户定义的自定义请求标头。
fileContentLength	将文件的大小调整为指定大小。 如果指定的字节值小于文件的当前大小，则会清除指定字节值上方的所有范围。
fileHTTPHeaders	作的其他参数
filePermission	如果指定了权限（安全描述符），则应为目录/文件设置权限。 如果权限大小为 <= 8KB，则可以使用此标头，否则应使用 x-ms-file-permission-key 标头。 默认值：继承。 如果将 SDDL 指定为输入，则它必须具有所有者、组和 dacl。 注意：应仅指定 x-ms-file-permission 或 x-ms-file-permission-key 之一。
filePermissionKey	要为目录/文件设置的权限的键。 注意：应仅指定 x-ms-file-permission 或 x-ms-file-permission-key 之一。
onDownloadProgress	下载进度触发的回调。
onUploadProgress	上传进度时触发的回调。
timeout	请求在自动终止之前可能需要的毫秒数。
timeoutParameter	超时参数以秒为单位表示。 有关详细信息，请参阅 为文件服务作设置超时。

属性详细信息

abortSignal

可用于中止请求的信号。

abortSignal?: AbortSignalLike

属性值

AbortSignalLike

customHeaders

{object}[customHeaders]将在发送请求之前应用的用户定义的自定义请求标头。

customHeaders?: undefined | [key: string]: string

属性值

undefined | [key: string]: string

fileContentLength

将文件的大小调整为指定大小。 如果指定的字节值小于文件的当前大小，则会清除指定字节值上方的所有范围。

fileContentLength?: undefined | number

属性值

undefined | number

fileHTTPHeaders

作的其他参数

fileHTTPHeaders?: FileHTTPHeaders

属性值

FileHTTPHeaders

filePermission

如果指定了权限（安全描述符），则应为目录/文件设置权限。 如果权限大小为 <= 8KB，则可以使用此标头，否则应使用 x-ms-file-permission-key 标头。 默认值：继承。 如果将 SDDL 指定为输入，则它必须具有所有者、组和 dacl。 注意：应仅指定 x-ms-file-permission 或 x-ms-file-permission-key 之一。

filePermission?: undefined | string

属性值

undefined | string

filePermissionKey

要为目录/文件设置的权限的键。 注意：应仅指定 x-ms-file-permission 或 x-ms-file-permission-key 之一。

filePermissionKey?: undefined | string

属性值

undefined | string

onDownloadProgress

下载进度触发的回调。

onDownloadProgress?: undefined | (progress: TransferProgressEvent) => void

属性值

undefined | (progress: TransferProgressEvent) => void

onUploadProgress

上传进度时触发的回调。

onUploadProgress?: undefined | (progress: TransferProgressEvent) => void

属性值

undefined | (progress: TransferProgressEvent) => void

timeout

请求在自动终止之前可能需要的毫秒数。

timeout?: undefined | number

属性值

undefined | number

timeoutParameter

超时参数以秒为单位表示。 有关详细信息，请参阅 为文件服务作设置超时。

timeoutParameter?: undefined | number

属性值

undefined | number