FileSetHTTPHeadersOptionalParams interface

パッケージ:

@azure/storage-file

省略可能なパラメーター。

Extends

RequestOptionsBase

プロパティ

abortSignal	要求を中止するために使用できるシグナル。
customHeaders	{object}[customHeaders]要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。
fileContentLength	指定したサイズにファイルのサイズを変更します。 指定したバイト値がファイルの現在のサイズより小さい場合は、指定したバイト値より上のすべての範囲がクリアされます。
fileHTTPHeaders	操作の追加パラメーター
filePermission	指定した場合、ディレクトリ/ファイルにアクセス許可 (セキュリティ記述子) を設定する必要があります。 このヘッダーは、アクセス許可のサイズが <= 8 KB の場合に使用できます。それ以外の場合は、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

指定した場合、ディレクトリ/ファイルにアクセス許可 (セキュリティ記述子) を設定する必要があります。 このヘッダーは、アクセス許可のサイズが <= 8 KB の場合に使用できます。それ以外の場合は、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