QueuePeekMessagesOptions interface

Paket:

@azure/storage-queue

peekMessages işlemini yapılandırma seçenekleri

Extends

MessagesPeekOptionalParams,CommonOptions

Devralınan Özellikler

abortSignal	İptal denetleyicisi sinyali. Hem ağ isteği göndermeyi hem de yanıt beklemeyi durdurmak için kullanılabilir.
customHeaders	istek gönderilmeden önce uygulanır.
numberOfMessages	İsteğe bağlı. En fazla 32 olmak üzere kuyruktan alınacak ileti sayısını belirten sıfır olmayan bir tamsayı değeri. Daha az görünür durumdaysa, görünür iletiler döndürülür. Varsayılan olarak, bu işlemle kuyruktan tek bir ileti alınır.
onDownloadProgress	İndirme ilerlemesi üzerine tetiklenen geri çağırma.
onUploadProgress	Karşıya yükleme ilerlemesi üzerine tetiklenen geri çağırma.
requestId	Depolama analizi günlüğü etkinleştirildiğinde analiz günlüklerine kaydedilen 1 KB karakter sınırına sahip istemci tarafından oluşturulan, opak bir değer sağlar.
serializerOptions	XML ayrıştırma/derleme davranışını geçersiz kılma seçenekleri.
shouldDeserialize	HttpOperationResponse'un seri durumdan çıkarılıp seri durumdan çıkarılmayacağı. Bu tanımlanmamışsa HttpOperationResponse seri durumdan çıkarılmalıdır.
timeout	Bir isteğin otomatik olarak sonlandırılmadan önce ne kadar süre alabileceğini milisaniye cinsinden belirtin. İstek sonlandırılırsa, bir AbortError oluşturulur.
timeoutInSeconds	Zaman aşımı parametresi saniye cinsinden ifade edilir. Daha fazla bilgi için bkz. Kuyruk Hizmeti İşlemleri için Zaman Aşımlarını Ayarlama.
tracingContext	İzleme: Yayılma alanları oluşturulurken kullanılan bağlam.
tracingOptions	İzleme etkinleştirildiğinde oluşturulan span'ları yapılandırma seçenekleri.

Devralınan Özellik Detayları

abortSignal

İptal denetleyicisi sinyali. Hem ağ isteği göndermeyi hem de yanıt beklemeyi durdurmak için kullanılabilir.

abortSignal?: AbortSignalLike

Özellik Değeri

AbortSignalLike

MessagesPeekOptionalParams.abortSignal'danDevralındı

customHeaders

istek gönderilmeden önce uygulanır.

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

Özellik Değeri

{[key: string]: string}

MessagesPeekOptionalParams.customHeaders'danDevralındı

numberOfMessages

İsteğe bağlı. En fazla 32 olmak üzere kuyruktan alınacak ileti sayısını belirten sıfır olmayan bir tamsayı değeri. Daha az görünür durumdaysa, görünür iletiler döndürülür. Varsayılan olarak, bu işlemle kuyruktan tek bir ileti alınır.

numberOfMessages?: number

Özellik Değeri

number

MessagesPeekOptionalParams.numberOfMessages'danDevralındı

onDownloadProgress

İndirme ilerlemesi üzerine tetiklenen geri çağırma.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Özellik Değeri

(progress: TransferProgressEvent) => void

MessagesPeekOptionalParams.onDownloadProgress'tenDevralındı

onUploadProgress

Karşıya yükleme ilerlemesi üzerine tetiklenen geri çağırma.

onUploadProgress?: (progress: TransferProgressEvent) => void

Özellik Değeri

(progress: TransferProgressEvent) => void

MessagesPeekOptionalParams.onUploadProgress'tenDevralındı

requestId

Depolama analizi günlüğü etkinleştirildiğinde analiz günlüklerine kaydedilen 1 KB karakter sınırına sahip istemci tarafından oluşturulan, opak bir değer sağlar.

requestId?: string

Özellik Değeri

string

MessagesPeekOptionalParams.requestId'denDevralındı

serializerOptions

XML ayrıştırma/derleme davranışını geçersiz kılma seçenekleri.

serializerOptions?: SerializerOptions

Özellik Değeri

SerializerOptions

MessagesPeekOptionalParams.serializerOptions'danDevralındı

shouldDeserialize

HttpOperationResponse'un seri durumdan çıkarılıp seri durumdan çıkarılmayacağı. Bu tanımlanmamışsa HttpOperationResponse seri durumdan çıkarılmalıdır.

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

Özellik Değeri

boolean | (response: HttpOperationResponse) => boolean

MessagesPeekOptionalParams.shouldDeserialize'danDevralındı

timeout

Bir isteğin otomatik olarak sonlandırılmadan önce ne kadar süre alabileceğini milisaniye cinsinden belirtin. İstek sonlandırılırsa, bir AbortError oluşturulur.

timeout?: number

Özellik Değeri

number

MessagesPeekOptionalParams.timeout'tanDevralındı

timeoutInSeconds

Zaman aşımı parametresi saniye cinsinden ifade edilir. Daha fazla bilgi için bkz. Kuyruk Hizmeti İşlemleri için Zaman Aşımlarını Ayarlama.

timeoutInSeconds?: number

Özellik Değeri

number

İletilerden DevralındıPeekOptionalParams.timeoutInSeconds

tracingContext

İzleme: Yayılma alanları oluşturulurken kullanılan bağlam.

tracingContext?: Context

Özellik Değeri

@azure/core-tracing.Context

MessagesPeekOptionalParams.tracingContext'tenDevralındı

tracingOptions

İzleme etkinleştirildiğinde oluşturulan span'ları yapılandırma seçenekleri.

tracingOptions?: OperationTracingOptions

Özellik Değeri

OperationTracingOptions

CommonOptions.tracingOptions'danDevralındı