QueueCreateOptionalParams interface
省略可能なパラメーター。
- Extends
-
RequestOptionsBase
プロパティ
| abort |
要求を中止するために使用できるシグナル。 |
| custom |
{object}[customHeaders]要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。 |
| metadata | 随意。 キューのメタデータを応答本文の一部として返すように指定するには、このパラメーターを含めます。 このパラメーターで要求されたメタデータは、Queue サービスの 2009-09-19 バージョンによって課される名前付け制限に従って格納する必要があることに注意してください。 このバージョン以降、すべてのメタデータ名は C# 識別子の名前付け規則に従う必要があります。 |
| on |
ダウンロードの進行状況時に発生するコールバック。 |
| on |
アップロードの進行状況時に発生するコールバック。 |
| request |
ストレージ分析ログが有効な場合に分析ログに記録される 1 KB の文字制限を持つ、クライアント生成の不透明な値を提供します。 |
| timeout | 要求が自動的に終了するまでの時間 (ミリ秒)。 |
| timeout |
タイムアウト パラメーターは秒単位で表されます。 詳細については、「キュー サービス操作のタイムアウトの設定」<href=" を https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations>するを参照してください。 |
プロパティの詳細
abortSignal
要求を中止するために使用できるシグナル。
abortSignal?: AbortSignalLike
プロパティ値
AbortSignalLike
customHeaders
{object}[customHeaders]要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。
customHeaders?: undefined | [key: string]: string
プロパティ値
undefined | [key: string]: string
metadata
随意。 キューのメタデータを応答本文の一部として返すように指定するには、このパラメーターを含めます。 このパラメーターで要求されたメタデータは、Queue サービスの 2009-09-19 バージョンによって課される名前付け制限に従って格納する必要があることに注意してください。 このバージョン以降、すべてのメタデータ名は C# 識別子の名前付け規則に従う必要があります。
metadata?: undefined | [key: string]: string
プロパティ値
undefined | [key: string]: string
onDownloadProgress
ダウンロードの進行状況時に発生するコールバック。
onDownloadProgress?: undefined | (progress: TransferProgressEvent) => void
プロパティ値
undefined | (progress: TransferProgressEvent) => void
onUploadProgress
アップロードの進行状況時に発生するコールバック。
onUploadProgress?: undefined | (progress: TransferProgressEvent) => void
プロパティ値
undefined | (progress: TransferProgressEvent) => void
requestId
ストレージ分析ログが有効な場合に分析ログに記録される 1 KB の文字制限を持つ、クライアント生成の不透明な値を提供します。
requestId?: undefined | string
プロパティ値
undefined | string
timeout
要求が自動的に終了するまでの時間 (ミリ秒)。
timeout?: undefined | number
プロパティ値
undefined | number
timeoutParameter
タイムアウト パラメーターは秒単位で表されます。 詳細については、「キュー サービス操作のタイムアウトの設定」<href=" を https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations>するを参照してください。
timeoutParameter?: undefined | number
プロパティ値
undefined | number