MessagesDequeueOptionalParams interface

Paket:

@azure/storage-queue

İsteğe bağlı parametreler.

Extends

RequestOptionsBase

Özellikler

abortSignal	İstekleri durdurmak için kullanılabilecek sinyal.
customHeaders	istek gönderilmeden önce uygulanır.
numberOfMessages	Opsiyonel. Kuyruktan alınacak ileti sayısını en fazla 32 olarak belirten sıfır olmayan bir tamsayı değeri. Daha az görünürse, 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 arama.
onUploadProgress	Karşıya yükleme ilerlemesi üzerine tetiklenen geri arama.
requestId	Depolama analizi günlüğü etkinleştirildiğinde analiz günlüklerine kaydedilen 1 KB karakter sınırıyla istemci tarafından oluşturulan, opak bir değer sağlar.
serializerOptions	XML ayrıştırma/oluşturma davranışını geçersiz kılma seçenekleri.
shouldDeserialize	HttpOperationResponse'un seri durumdan çıkarılıp çıkarılmayacağı. Bu tanımlanmamışsa HttpOperationResponse seri durumdan çıkarılmalıdır.
timeout	otomatik olarak sonlandırılmadan önce bir isteğin alabildiği milisaniye sayısı. İ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.
visibilityTimeout	Opsiyonel. Yeni görünürlük zaman aşımı değerini sunucu zamanına göre saniye olarak 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 uzun olamaz. İletinin görünürlük zaman aşımı süresi, süre sonu süresinden sonraki bir değere ayarlanabilir.

Özellik Ayrıntıları

abortSignal

İstekleri durdurmak için kullanılabilecek sinyal.

abortSignal?: AbortSignalLike

Özellik Değeri

AbortSignalLike

customHeaders

istek gönderilmeden önce uygulanır.

customHeaders?: [key: string]: string

Özellik Değeri

[key: string]: string

numberOfMessages

Opsiyonel. Kuyruktan alınacak ileti sayısını en fazla 32 olarak belirten sıfır olmayan bir tamsayı değeri. Daha az görünürse, 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

onDownloadProgress

İndirme ilerlemesi üzerine tetiklenen geri arama.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Özellik Değeri

(progress: TransferProgressEvent) => void

onUploadProgress

Karşıya yükleme ilerlemesi üzerine tetiklenen geri arama.

onUploadProgress?: (progress: TransferProgressEvent) => void

Özellik Değeri

(progress: TransferProgressEvent) => void

requestId

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

requestId?: string

Özellik Değeri

string

serializerOptions

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

serializerOptions?: SerializerOptions

Özellik Değeri

SerializerOptions

shouldDeserialize

HttpOperationResponse'un seri durumdan çıkarılıp çı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

timeout

otomatik olarak sonlandırılmadan önce bir isteğin alabildiği milisaniye sayısı. İstek sonlandırılırsa bir AbortError oluşturulur.

timeout?: number

Özellik Değeri

number

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

tracingContext

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

tracingContext?: Context

Özellik Değeri

Context

visibilityTimeout

Opsiyonel. Yeni görünürlük zaman aşımı değerini sunucu zamanına göre saniye olarak 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 uzun olamaz. İletinin görünürlük zaman aşımı süresi, süre sonu süresinden sonraki bir değere ayarlanabilir.

visibilityTimeout?: number

Özellik Değeri

number