MessagesDequeueOptionalParams interface

Paket:

@azure/storage-queue

İsteğe bağlı parametreler.

Extends

RequestOptionsBase

Özellikler

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.
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.
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.
visibilityTimeout	İsteğe bağlı. Sunucu süresine göre saniye olarak yeni görünürlük zaman aşımı değerini belirtir. Varsayılan değer 30 saniyedir. Belirtilen değer 1 saniyeden büyük veya buna eşit olmalıdır ve 7 günden büyük veya 2011-08-18 sürümünden önceki REST protokolü sürümlerinde 2 saatten büyük olamaz. İletinin görünürlük zaman aşımı süresi, süre sonu tarihinden sonraki bir değere ayarlanabilir.

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.
onDownloadProgress	İndirme ilerlemesi üzerine tetiklenen geri çağırma.
onUploadProgress	Karşıya yükleme ilerlemesi üzerine tetiklenen geri çağırma.
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.
tracingContext	İzleme: Yayılma alanları oluşturulurken kullanılan bağlam.

Özellik Ayrıntıları

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

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

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

visibilityTimeout

İsteğe bağlı. Sunucu süresine göre saniye olarak yeni görünürlük zaman aşımı değerini belirtir. Varsayılan değer 30 saniyedir. Belirtilen değer 1 saniyeden büyük veya buna eşit olmalıdır ve 7 günden büyük veya 2011-08-18 sürümünden önceki REST protokolü sürümlerinde 2 saatten büyük olamaz. İletinin görünürlük zaman aşımı süresi, süre sonu tarihinden sonraki bir değere ayarlanabilir.

visibilityTimeout?: number

Özellik Değeri

number

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

Devralınan RequestOptionsBase.abortSignal

customHeaders

istek gönderilmeden önce uygulanır.

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

Özellik Değeri

{[key: string]: string}

Devralınan RequestOptionsBase.customHeaders

onDownloadProgress

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

Özellik Değeri

(progress: TransferProgressEvent) => void

Devralınan RequestOptionsBase.onDownloadProgress

onUploadProgress

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

onUploadProgress?: (progress: TransferProgressEvent) => void

Özellik Değeri

(progress: TransferProgressEvent) => void

Devralınan RequestOptionsBase.onUploadProgress

serializerOptions

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

serializerOptions?: SerializerOptions

Özellik Değeri

SerializerOptions

Devralınan RequestOptionsBase.serializerOptions

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

Devralınan RequestOptionsBase.shouldDeserialize

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

Devralınan RequestOptionsBase.timeout

tracingContext

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

tracingContext?: Context

Özellik Değeri

@azure/core-tracing.Context

Devralınan RequestOptionsBase.tracingContext