Compartilhar via


QueueSendMessageOptions interface

Opções para configurar operação de sendMessage

Extends

Propriedades

abortSignal

Uma implementação da interface AbortSignalLike para sinalizar a solicitação para cancelar a operação. Por exemplo, use o controlador de @azure/anulação para criar um AbortSignal.

Propriedades herdadas

messageTimeToLive

Opcional. Especifica o intervalo de tempo de vida útil para a mensagem, em segundos. Antes da versão 2017-07-29, o tempo de vida máximo permitido é de 7 dias. Para a versão 2017-07-29 ou posterior, o tempo máximo de vida útil pode ser qualquer número positivo, bem como -1 indicando que a mensagem não expira. Se esse parâmetro for omitido, o tempo de vida padrão será de 7 dias.

requestId

Fornece um valor opaco gerado pelo cliente com um limite de caracteres de 1 KB que é registrado nos logs de análise quando o log de análise de armazenamento está habilitado.

timeoutInSeconds

O parâmetro de tempo limite é expresso em segundos. Para obter mais informações, consulte Definindo tempos limite para operações de serviço de fila.

tracingOptions

Opções para configurar intervalos criados quando o rastreamento está habilitado.

visibilityTimeout

Opcional. Se especificado, a solicitação deve ser feita usando uma versão x-ms-de-2011-08-18 ou posterior. Se não for especificado, o valor padrão será 0. Especifica o novo valor de tempo limite de visibilidade, em segundos, em relação ao tempo do servidor. O novo valor deve ser maior ou igual a 0 e não pode ser maior que 7 dias. O tempo limite de visibilidade de uma mensagem não pode ser definido como um valor posterior ao tempo de expiração. visibilitytimeout deve ser definido como um valor menor que o valor de vida útil.

Detalhes da propriedade

abortSignal

Uma implementação da interface AbortSignalLike para sinalizar a solicitação para cancelar a operação. Por exemplo, use o controlador de @azure/anulação para criar um AbortSignal.

abortSignal?: AbortSignalLike

Valor da propriedade

Detalhes das propriedades herdadas

messageTimeToLive

Opcional. Especifica o intervalo de tempo de vida útil para a mensagem, em segundos. Antes da versão 2017-07-29, o tempo de vida máximo permitido é de 7 dias. Para a versão 2017-07-29 ou posterior, o tempo máximo de vida útil pode ser qualquer número positivo, bem como -1 indicando que a mensagem não expira. Se esse parâmetro for omitido, o tempo de vida padrão será de 7 dias.

messageTimeToLive?: number

Valor da propriedade

number

herdado deMessagesEnqueueOptionalParams.messageTimeToLive

requestId

Fornece um valor opaco gerado pelo cliente com um limite de caracteres de 1 KB que é registrado nos logs de análise quando o log de análise de armazenamento está habilitado.

requestId?: string

Valor da propriedade

string

herdado deMessagesEnqueueOptionalParams.requestId

timeoutInSeconds

O parâmetro de tempo limite é expresso em segundos. Para obter mais informações, consulte Definindo tempos limite para operações de serviço de fila.

timeoutInSeconds?: number

Valor da propriedade

number

Herdado deMessagesEnqueueOptionalParams.timeoutInSeconds

tracingOptions

Opções para configurar intervalos criados quando o rastreamento está habilitado.

tracingOptions?: OperationTracingOptions

Valor da propriedade

Herdado deCommonOptions.tracingOptions

visibilityTimeout

Opcional. Se especificado, a solicitação deve ser feita usando uma versão x-ms-de-2011-08-18 ou posterior. Se não for especificado, o valor padrão será 0. Especifica o novo valor de tempo limite de visibilidade, em segundos, em relação ao tempo do servidor. O novo valor deve ser maior ou igual a 0 e não pode ser maior que 7 dias. O tempo limite de visibilidade de uma mensagem não pode ser definido como um valor posterior ao tempo de expiração. visibilitytimeout deve ser definido como um valor menor que o valor de vida útil.

visibilityTimeout?: number

Valor da propriedade

number

herdado deMessagesEnqueueOptionalParams.visibilityTimeout