QueueSendMessageOptions interface

パッケージ:

@azure/storage-queue

sendMessage 操作を構成するためのオプション

Extends

MessagesEnqueueOptionalParams,CommonOptions

継承されたプロパティ

abortSignal	中止コントローラーのシグナル。 ネットワーク要求の送信と応答の待機の両方を中止するために使用できます。
customHeaders	は、要求が送信される前に適用されます。
messageTimeToLive	省略可能。 メッセージの有効期限を秒単位で指定します。 バージョン 2017-07-29 より前のバージョンでは、最大有効期間は 7 日間です。 バージョン 2017-07-29 以降の場合、最大有効期間は任意の正の数と、メッセージの有効期限が切れないことを示す -1 になります。 このパラメーターが省略されている場合、既定の有効期限は 7 日です。
onDownloadProgress	ダウンロードの進行状況時に発生するコールバック。
onUploadProgress	アップロードの進行状況時に発生するコールバック。
requestId	ストレージ解析ロギングが有効なときに解析ログに記録される、クライアントで生成された非透過の値を 1 KB の文字制限付きで提供します。
serializerOptions	XML 解析/構築の動作をオーバーライドするオプション。
shouldDeserialize	HttpOperationResponse を逆シリアル化する必要があるかどうか。 これが未定義の場合は、HttpOperationResponse を逆シリアル化する必要があります。
timeout	要求が自動的に終了するまでの時間 (ミリ秒)。 要求が終了すると、 AbortError がスローされます。
timeoutInSeconds	タイムアウト パラメーターは秒単位で表されます。 詳細については、「キュー サービス操作のタイムアウトの設定」を参照してください。
tracingContext	トレース: スパンの作成時に使用されるコンテキスト。
tracingOptions	トレースが有効になっているときに作成されたスパンを構成するためのオプション。
visibilityTimeout	省略可能。 指定する場合は、x-ms-version の 2011-08-18 以降を使用して要求を行う必要があります。 値を指定しない場合は、既定値 0 が使用されます。 サーバー時間を基準に、新しい表示タイムアウト値を秒単位で指定します。 新しい値は、0 以上の 7 日を超えない値である必要があります。 メッセージの表示タイムアウト値は、有効期限より後の値に設定できます。 visibilitytimeout は、有効期間の値より小さい値に設定する必要があります。

継承されたプロパティの詳細

abortSignal

中止コントローラーのシグナル。 ネットワーク要求の送信と応答の待機の両方を中止するために使用できます。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

MessagesEnqueueOptionalParams.abortSignalから継承

customHeaders

は、要求が送信される前に適用されます。

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

プロパティ値

{[key: string]: string}

MessagesEnqueueOptionalParams.customHeadersから継承

messageTimeToLive

省略可能。 メッセージの有効期限を秒単位で指定します。 バージョン 2017-07-29 より前のバージョンでは、最大有効期間は 7 日間です。 バージョン 2017-07-29 以降の場合、最大有効期間は任意の正の数と、メッセージの有効期限が切れないことを示す -1 になります。 このパラメーターが省略されている場合、既定の有効期限は 7 日です。

messageTimeToLive?: number

プロパティ値

number

MessagesEnqueueOptionalParams.messageTimeToLiveから継承

onDownloadProgress

ダウンロードの進行状況時に発生するコールバック。

onDownloadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

MessagesEnqueueOptionalParams.onDownloadProgressから継承

onUploadProgress

アップロードの進行状況時に発生するコールバック。

onUploadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

MessagesEnqueueOptionalParams.onUploadProgressから継承

requestId

ストレージ解析ロギングが有効なときに解析ログに記録される、クライアントで生成された非透過の値を 1 KB の文字制限付きで提供します。

requestId?: string

プロパティ値

string

MessagesEnqueueOptionalParams.requestIdから継承

serializerOptions

XML 解析/構築の動作をオーバーライドするオプション。

serializerOptions?: SerializerOptions

プロパティ値

SerializerOptions

MessagesEnqueueOptionalParams.serializerOptionsから継承

shouldDeserialize

HttpOperationResponse を逆シリアル化する必要があるかどうか。 これが未定義の場合は、HttpOperationResponse を逆シリアル化する必要があります。

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

プロパティ値

boolean | (response: HttpOperationResponse) => boolean

MessagesEnqueueOptionalParams.shouldDeserializeから継承されます

timeout

要求が自動的に終了するまでの時間 (ミリ秒)。 要求が終了すると、 AbortError がスローされます。

timeout?: number

プロパティ値

number

MessagesEnqueueOptionalParams.timeoutから継承

timeoutInSeconds

タイムアウト パラメーターは秒単位で表されます。 詳細については、「キュー サービス操作のタイムアウトの設定」を参照してください。

timeoutInSeconds?: number

プロパティ値

number

MessagesEnqueueOptionalParams.timeoutInSecondsから継承

tracingContext

トレース: スパンの作成時に使用されるコンテキスト。

tracingContext?: Context

プロパティ値

@azure/core-tracing.Context

MessagesEnqueueOptionalParams.tracingContextから継承

tracingOptions

トレースが有効になっているときに作成されたスパンを構成するためのオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

CommonOptions.tracingOptionsから継承

visibilityTimeout

省略可能。 指定する場合は、x-ms-version の 2011-08-18 以降を使用して要求を行う必要があります。 値を指定しない場合は、既定値 0 が使用されます。 サーバー時間を基準に、新しい表示タイムアウト値を秒単位で指定します。 新しい値は、0 以上の 7 日を超えない値である必要があります。 メッセージの表示タイムアウト値は、有効期限より後の値に設定できます。 visibilitytimeout は、有効期間の値より小さい値に設定する必要があります。

visibilityTimeout?: number

プロパティ値

number

MessagesEnqueueOptionalParams.visibilityTimeoutから継承