QueueSendMessageOptions interface

Pakket:

@azure/storage-queue

Opties voor het configureren van <xref:QueueClient.sendMessage> bewerking

Uitbreiding

MessagesEnqueueOptionalParams

Eigenschappen

abortSignal	Het signaal dat kan worden gebruikt om aanvragen af te breken.
customHeaders	wordt toegepast voordat de aanvraag wordt verzonden.
messageTimeToLive	Facultatief. Hiermee geeft u het time-to-live-interval voor het bericht, in seconden. Vóór versie 2017-07-29 is de maximale time-to-live toegestaan 7 dagen. Voor versie 2017-07-29 of hoger kan de maximale time-to-live elk positief getal zijn, evenals -1 die aangeeft dat het bericht niet verloopt. Als deze parameter wordt weggelaten, is de standaard time-to-live 7 dagen.
onDownloadProgress	Callback die wordt geactiveerd bij de voortgang van het downloaden.
onUploadProgress	Callback die wordt geactiveerd bij het uploaden.
requestId	Biedt een door de client gegenereerde, ondoorzichtige waarde met een tekenlimiet van 1 kB die wordt vastgelegd in de analyselogboeken wanneer logboekregistratie van opslaganalyse is ingeschakeld.
serializerOptions	Opties voor het overschrijven van XML-parserings-/bouwgedrag.
shouldDeserialize	Of httpOperationResponse al dan niet moet worden gedeserialiseerd. Als dit niet is gedefinieerd, moet httpOperationResponse worden gedeserialiseerd.
timeout	Het aantal milliseconden dat een aanvraag kan duren voordat deze automatisch wordt beëindigd. Als de aanvraag wordt beëindigd, wordt er een AbortError gegenereerd.
timeoutInSeconds	De time-outparameter wordt uitgedrukt in seconden. Zie Time-outs instellen voor wachtrijservicebewerkingen voor meer informatie.
tracingContext	Tracering: Context die wordt gebruikt bij het maken van spans.
tracingOptions	Opties voor het configureren van periodes die zijn gemaakt wanneer tracering is ingeschakeld.
visibilityTimeout	Facultatief. Indien opgegeven, moet de aanvraag worden gedaan met een x-ms-versie van 2011-08-18 of hoger. Als dit niet is opgegeven, is de standaardwaarde 0. Hiermee geeft u de nieuwe time-outwaarde voor zichtbaarheid, in seconden, ten opzichte van servertijd. De nieuwe waarde moet groter zijn dan of gelijk zijn aan 0 en mag niet groter zijn dan 7 dagen. De time-out voor zichtbaarheid van een bericht kan niet worden ingesteld op een waarde later dan de verlooptijd. visibilitytimeout moet worden ingesteld op een waarde die kleiner is dan de time-to-live-waarde.

Eigenschapdetails

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

customHeaders

wordt toegepast voordat de aanvraag wordt verzonden.

customHeaders?: [key: string]: string

Waarde van eigenschap

[key: string]: string

messageTimeToLive

Facultatief. Hiermee geeft u het time-to-live-interval voor het bericht, in seconden. Vóór versie 2017-07-29 is de maximale time-to-live toegestaan 7 dagen. Voor versie 2017-07-29 of hoger kan de maximale time-to-live elk positief getal zijn, evenals -1 die aangeeft dat het bericht niet verloopt. Als deze parameter wordt weggelaten, is de standaard time-to-live 7 dagen.

messageTimeToLive?: number

Waarde van eigenschap

number

onDownloadProgress

Callback die wordt geactiveerd bij de voortgang van het downloaden.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

onUploadProgress

Callback die wordt geactiveerd bij het uploaden.

onUploadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

requestId

Biedt een door de client gegenereerde, ondoorzichtige waarde met een tekenlimiet van 1 kB die wordt vastgelegd in de analyselogboeken wanneer logboekregistratie van opslaganalyse is ingeschakeld.

requestId?: string

Waarde van eigenschap

string

serializerOptions

Opties voor het overschrijven van XML-parserings-/bouwgedrag.

serializerOptions?: SerializerOptions

Waarde van eigenschap

SerializerOptions

shouldDeserialize

Of httpOperationResponse al dan niet moet worden gedeserialiseerd. Als dit niet is gedefinieerd, moet httpOperationResponse worden gedeserialiseerd.

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

Waarde van eigenschap

boolean | (response: HttpOperationResponse) => boolean

timeout

Het aantal milliseconden dat een aanvraag kan duren voordat deze automatisch wordt beëindigd. Als de aanvraag wordt beëindigd, wordt er een AbortError gegenereerd.

timeout?: number

Waarde van eigenschap

number

timeoutInSeconds

De time-outparameter wordt uitgedrukt in seconden. Zie Time-outs instellen voor wachtrijservicebewerkingen voor meer informatie.

timeoutInSeconds?: number

Waarde van eigenschap

number

tracingContext

Tracering: Context die wordt gebruikt bij het maken van spans.

tracingContext?: Context

Waarde van eigenschap

Context

tracingOptions

Opties voor het configureren van periodes die zijn gemaakt wanneer tracering is ingeschakeld.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

visibilityTimeout

Facultatief. Indien opgegeven, moet de aanvraag worden gedaan met een x-ms-versie van 2011-08-18 of hoger. Als dit niet is opgegeven, is de standaardwaarde 0. Hiermee geeft u de nieuwe time-outwaarde voor zichtbaarheid, in seconden, ten opzichte van servertijd. De nieuwe waarde moet groter zijn dan of gelijk zijn aan 0 en mag niet groter zijn dan 7 dagen. De time-out voor zichtbaarheid van een bericht kan niet worden ingesteld op een waarde later dan de verlooptijd. visibilitytimeout moet worden ingesteld op een waarde die kleiner is dan de time-to-live-waarde.

visibilityTimeout?: number

Waarde van eigenschap

number