MessagesEnqueueOptionalParams interface

Optionale Parameter.

Extends

Eigenschaften

messageTimeToLive

Optional. Gibt das Gültigkeitsdauerintervall für die Nachricht in Sekunden an. Vor Version 2017-07-29 beträgt die maximal zulässige Laufzeit 7 Tage. Für Version 2017-07-29 oder höher kann die maximale Laufzeit eine beliebige positive Zahl und -1 sein, die angibt, dass die Nachricht nicht abläuft. Wenn dieser Parameter nicht angegeben ist, beträgt die Standardgültigkeitsdauer 7 Tage.

requestId

Stellt einen vom Client generierten, nicht transparenten Wert mit einer Zeichenbeschränkung von 1 KB bereit, der bei Aktivierung der Speicheranalyse-Protokollierung in den Analyseprotokollen erfasst wird.

timeoutInSeconds

Der Timeoutparameter wird in Sekunden ausgedrückt. Weitere Informationen finden Sie unter Festlegen von Timeouts für Warteschlangendienstvorgänge.

visibilityTimeout

Optional. Falls angegeben, muss die Anforderung mit einer x-ms-Version von 2011-08-18 oder höher erfolgen. Wenn dieser Wert fehlt, wird der Standardwert 0 verwendet. Gibt den neuen Sichtbarkeitstimeoutwert in Sekunden relativ zur Serverzeit an. Der neue Wert muss größer oder gleich 0 sein und darf nicht größer als 7 Tage sein. Das Sichtbarkeitstimeout einer Nachricht darf nicht auf einen Wert festgelegt werden, der nach der Ablaufzeit liegt. visibilitytimeout sollte auf einen Wert festgelegt werden, der kleiner als der Wert für die Laufzeit ist.

Geerbte Eigenschaften

abortSignal

Signal eines Abbruchcontrollers. Kann verwendet werden, um sowohl das Senden einer Netzwerkanforderung als auch das Warten auf eine Antwort abzubrechen.

customHeaders

wird angewendet, bevor die Anforderung gesendet wird.

onDownloadProgress

Rückruf, der beim Downloadfortschritt ausgelöst wird.

onUploadProgress

Rückruf, der beim Hochladen des Fortschritts ausgelöst wird.

serializerOptions

Optionen zum Überschreiben des XML-Analyse-/Erstellungsverhaltens.

shouldDeserialize

Gibt an, ob httpOperationResponse deserialisiert werden soll. Wenn dies nicht definiert ist, sollte httpOperationResponse deserialisiert werden.

timeout

Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird. Wenn die Anforderung beendet wird, wird ein AbortError ausgelöst.

tracingContext

Ablaufverfolgung: Kontext, der beim Erstellen von Spannen verwendet wird.

Details zur Eigenschaft

messageTimeToLive

Optional. Gibt das Gültigkeitsdauerintervall für die Nachricht in Sekunden an. Vor Version 2017-07-29 beträgt die maximal zulässige Laufzeit 7 Tage. Für Version 2017-07-29 oder höher kann die maximale Laufzeit eine beliebige positive Zahl und -1 sein, die angibt, dass die Nachricht nicht abläuft. Wenn dieser Parameter nicht angegeben ist, beträgt die Standardgültigkeitsdauer 7 Tage.

messageTimeToLive?: number

Eigenschaftswert

number

requestId

Stellt einen vom Client generierten, nicht transparenten Wert mit einer Zeichenbeschränkung von 1 KB bereit, der bei Aktivierung der Speicheranalyse-Protokollierung in den Analyseprotokollen erfasst wird.

requestId?: string

Eigenschaftswert

string

timeoutInSeconds

Der Timeoutparameter wird in Sekunden ausgedrückt. Weitere Informationen finden Sie unter Festlegen von Timeouts für Warteschlangendienstvorgänge.

timeoutInSeconds?: number

Eigenschaftswert

number

visibilityTimeout

Optional. Falls angegeben, muss die Anforderung mit einer x-ms-Version von 2011-08-18 oder höher erfolgen. Wenn dieser Wert fehlt, wird der Standardwert 0 verwendet. Gibt den neuen Sichtbarkeitstimeoutwert in Sekunden relativ zur Serverzeit an. Der neue Wert muss größer oder gleich 0 sein und darf nicht größer als 7 Tage sein. Das Sichtbarkeitstimeout einer Nachricht darf nicht auf einen Wert festgelegt werden, der nach der Ablaufzeit liegt. visibilitytimeout sollte auf einen Wert festgelegt werden, der kleiner als der Wert für die Laufzeit ist.

visibilityTimeout?: number

Eigenschaftswert

number

Geerbte Eigenschaftsdetails

abortSignal

Signal eines Abbruchcontrollers. Kann verwendet werden, um sowohl das Senden einer Netzwerkanforderung als auch das Warten auf eine Antwort abzubrechen.

abortSignal?: AbortSignalLike

Eigenschaftswert

Geerbt von RequestOptionsBase.abortSignal

customHeaders

wird angewendet, bevor die Anforderung gesendet wird.

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

Eigenschaftswert

{[key: string]: string}

Geerbt von RequestOptionsBase.customHeaders

onDownloadProgress

Rückruf, der beim Downloadfortschritt ausgelöst wird.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

Geerbt von RequestOptionsBase.onDownloadProgress

onUploadProgress

Rückruf, der beim Hochladen des Fortschritts ausgelöst wird.

onUploadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

Geerbt von RequestOptionsBase.onUploadProgress

serializerOptions

Optionen zum Überschreiben des XML-Analyse-/Erstellungsverhaltens.

serializerOptions?: SerializerOptions

Eigenschaftswert

Geerbt von RequestOptionsBase.serializerOptions

shouldDeserialize

Gibt an, ob httpOperationResponse deserialisiert werden soll. Wenn dies nicht definiert ist, sollte httpOperationResponse deserialisiert werden.

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

Eigenschaftswert

boolean | (response: HttpOperationResponse) => boolean

Geerbt von RequestOptionsBase.shouldDeserialize

timeout

Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird. Wenn die Anforderung beendet wird, wird ein AbortError ausgelöst.

timeout?: number

Eigenschaftswert

number

Geerbt von RequestOptionsBase.timeout

tracingContext

Ablaufverfolgung: Kontext, der beim Erstellen von Spannen verwendet wird.

tracingContext?: Context

Eigenschaftswert

@azure/core-tracing.Context

Geerbt von RequestOptionsBase.tracingContext