QueueClient.UpdateMessageAsync メソッド

定義

名前空間:

Azure.Storage.Queues

アセンブリ:

Azure.Storage.Queues.dll

パッケージ:

Azure.Storage.Queues v12.17.1

オーバーロード

UpdateMessageAsync(String, String, BinaryData, TimeSpan, CancellationToken)	メッセージの可視性のタイムアウトと内容を変更します。 メッセージは、UTF-8 エンコードされた XML 要求に含めることができる形式である必要があります。 それ以外の場合 MessageEncoding は、 オプションを に Base64 設定して、準拠していないメッセージを処理できます。 エンコードされたメッセージのサイズは、バージョン 2011-08-18 以降では最大 64 KiB、以前のバージョンでは 8 KiB のサイズにすることができます。 詳細については、「 メッセージを更新します。
UpdateMessageAsync(String, String, String, TimeSpan, CancellationToken)	メッセージの可視性のタイムアウトと内容を変更します。 メッセージは、UTF-8 エンコードされた XML 要求に含めることができる形式である必要があります。 それ以外の場合 MessageEncoding は、 オプションを に Base64 設定して、準拠していないメッセージを処理できます。 エンコードされたメッセージのサイズは、バージョン 2011-08-18 以降では最大 64 KiB、以前のバージョンでは 8 KiB のサイズにすることができます。 詳細については、「 メッセージを更新します。

UpdateMessageAsync(String, String, BinaryData, TimeSpan, CancellationToken)

ソース:

QueueClient.cs

メッセージの可視性のタイムアウトと内容を変更します。

メッセージは、UTF-8 エンコードされた XML 要求に含めることができる形式である必要があります。 それ以外の場合 MessageEncoding は、 オプションを に Base64 設定して、準拠していないメッセージを処理できます。 エンコードされたメッセージのサイズは、バージョン 2011-08-18 以降では最大 64 KiB、以前のバージョンでは 8 KiB のサイズにすることができます。

詳細については、「 メッセージを更新します。

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.UpdateReceipt>> UpdateMessageAsync (string messageId, string popReceipt, BinaryData message, TimeSpan visibilityTimeout = default, System.Threading.CancellationToken cancellationToken = default);

abstract member UpdateMessageAsync : string * string * BinaryData * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.UpdateReceipt>>
override this.UpdateMessageAsync : string * string * BinaryData * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.UpdateReceipt>>

Public Overridable Function UpdateMessageAsync (messageId As String, popReceipt As String, message As BinaryData, Optional visibilityTimeout As TimeSpan = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of UpdateReceipt))

パラメーター

messageId

String

更新するメッセージの ID。

popReceipt

String

必須。 メッセージの取得またはメッセージの更新操作に対する以前の呼び出しから返される有効なポップ レシート値を指定します。

message

BinaryData

任意。 更新されたメッセージ。

visibilityTimeout

TimeSpan

必須。 サーバー時間を基準に、新しい表示タイムアウト値を秒単位で指定します。 新しい値は、0 以上の 7 日を超えない値である必要があります。 メッセージの表示タイムアウト値は、有効期限より後の値に設定できます。 メッセージは、削除されるか有効期限が切れるまで更新できます。

cancellationToken

CancellationToken

CancellationToken で、省略可能です。

戻り値

Task<Response<UpdateReceipt>>

Response<T>.

注釈

このバージョンのライブラリでは、既定ではメッセージはエンコードされません。 Base64 は、以前の v11 ライブラリの既定の動作でした。 「CloudQueue.EncodeMessage」を参照してください。

UpdateMessageAsync(String, String, String, TimeSpan, CancellationToken)

ソース:

QueueClient.cs

メッセージの可視性のタイムアウトと内容を変更します。

メッセージは、UTF-8 エンコードされた XML 要求に含めることができる形式である必要があります。 それ以外の場合 MessageEncoding は、 オプションを に Base64 設定して、準拠していないメッセージを処理できます。 エンコードされたメッセージのサイズは、バージョン 2011-08-18 以降では最大 64 KiB、以前のバージョンでは 8 KiB のサイズにすることができます。

詳細については、「 メッセージを更新します。

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.UpdateReceipt>> UpdateMessageAsync (string messageId, string popReceipt, string messageText = default, TimeSpan visibilityTimeout = default, System.Threading.CancellationToken cancellationToken = default);

abstract member UpdateMessageAsync : string * string * string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.UpdateReceipt>>
override this.UpdateMessageAsync : string * string * string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.UpdateReceipt>>

Public Overridable Function UpdateMessageAsync (messageId As String, popReceipt As String, Optional messageText As String = Nothing, Optional visibilityTimeout As TimeSpan = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of UpdateReceipt))

パラメーター

messageId

String

更新するメッセージの ID。

popReceipt

String

必須。 メッセージの取得またはメッセージの更新操作に対する以前の呼び出しから返される有効なポップ レシート値を指定します。

messageText

String

任意。 更新されたメッセージ テキスト。

visibilityTimeout

TimeSpan

必須。 サーバー時間を基準に、新しい表示タイムアウト値を秒単位で指定します。 新しい値は、0 以上の 7 日を超えない値である必要があります。 メッセージの表示タイムアウト値は、有効期限より後の値に設定できます。 メッセージは、削除されるか有効期限が切れるまで更新できます。

cancellationToken

CancellationToken

CancellationToken で、省略可能です。

戻り値

Task<Response<UpdateReceipt>>

Response<T>.

注釈

このバージョンのライブラリでは、既定ではメッセージはエンコードされません。 Base64 は、以前の v11 ライブラリの既定の動作でした。 「CloudQueue.EncodeMessage」を参照してください。