Partilhar via


Colocar mensagem

A Put Message operação adiciona uma nova mensagem à parte de trás da fila de mensagens. Um tempo limite de visibilidade também pode ser especificado para tornar a mensagem invisível até que o tempo limite de visibilidade expire. Uma mensagem deve estar em um formato que possa ser incluído em uma solicitação XML com codificação UTF-8. A mensagem codificada pode ter até 64 kibibytes (KiB) de tamanho para a versão 2011-08-18 e posterior, ou 8 KiB para versões anteriores.

Solicitação

Você pode construir a solicitação Put Message da seguinte maneira. Recomendamos que você use HTTPS. Substitua myaccount pelo nome da sua conta de armazenamento e myqueue pelo nome da sua fila:

Método Solicitar URI Versão HTTP
POST https://myaccount.queue.core.windows.net/myqueue/messages?visibilitytimeout=<int-seconds>&messagettl=<int-seconds> HTTP/1.1

Solicitação de serviço de armazenamento emulado

Quando você estiver fazendo uma solicitação no serviço de armazenamento emulado, especifique o nome do host do emulador e a porta de armazenamento da fila como 127.0.0.1:10001, seguido pelo nome da conta de armazenamento emulada:

Método Solicitar URI Versão HTTP
POST http://127.0.0.1:10001/devstoreaccount1/myqueue/messages?visibilitytimeout=<int-seconds>&messagettl=<int-seconds> HTTP/1.1

Para obter mais informações, consulte Usar o emulador Azurite para o desenvolvimento local do Armazenamento do Azure.

Parâmetros de URI

Você pode especificar os seguintes parâmetros no URI da solicitação:

Parâmetro Descrição
visibilitytimeout=<int=seconds> Opcional. Especifica o novo valor de tempo limite de visibilidade, em segundos, em relação ao tempo do servidor. Se for especificado, a solicitação deve ser feita usando um x-ms-version de 2011-08-18 ou posterior. Se não for especificado, o valor padrão será 0. 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 à data de validade. Defina visibilitytimeout como um valor menor do que o valor de tempo de vida.
messagettl=<int-seconds> Opcional. Especifica o intervalo de tempo de vida da mensagem, em segundos. Em versões anteriores a 2017-07-29, o tempo máximo de vida permitido é de 7 dias. Para a versão 2017-07-29 e posterior, o tempo máximo de vida pode ser qualquer número positivo e -1, o que indica que a mensagem não expira. Se esse parâmetro for omitido, o tempo de vida padrão será de 7 dias.
timeout Opcional. O parâmetro timeout é expresso em segundos. Para obter mais informações, consulte Definir tempos limite para operações de serviço de fila.

Cabeçalhos da requisição

Os cabeçalhos de solicitação obrigatórios e opcionais são descritos na tabela a seguir:

Cabeçalho da solicitação Descrição
Authorization Obrigatório Especifica o esquema de autorização, o nome da conta e a assinatura. Para obter mais informações, consulte Autorizar solicitações para o Armazenamento do Azure.
Date or x-ms-date Obrigatório Especifica o Tempo Universal Coordenado (UTC) para a solicitação. Para obter mais informações, consulte Autorizar solicitações para o Armazenamento do Azure.
x-ms-version Opcional. Especifica a versão da operação a ser usada para essa solicitação. Para obter mais informações, consulte controle de versão para os serviços de Armazenamento do Azure.
x-ms-client-request-id Opcional. Fornece um valor opaco gerado pelo cliente com um limite de caracteres de 1 kibibyte (KiB) que é registrado nos logs quando o log é configurado. É altamente recomendável que você use esse cabeçalho para correlacionar atividades do lado do cliente com solicitações que o servidor recebe.

Corpo de solicitação

O corpo da solicitação contém os dados da mensagem no seguinte formato XML. Observe que o conteúdo da mensagem deve estar em um formato que possa ser codificado com UTF-8.

<QueueMessage>  
    <MessageText>message-content</MessageText>  
</QueueMessage>  

Pedido de amostra

Request:  
POST https://myaccount.queue.core.windows.net/messages?visibilitytimeout=30&timeout=30 HTTP/1.1  
  
Headers:  
x-ms-version: 2011-08-18  
x-ms-date: Tue, 30 Aug 2011 01:03:21 GMT  
Authorization: SharedKey myaccount:sr8rIheJmCd6npMSx7DfAY3L//V3uWvSXOzUBCV9wnk=  
Content-Length: 100  
  
Body:  
<QueueMessage>  
<MessageText>PHNhbXBsZT5zYW1wbGUgbWVzc2FnZTwvc2FtcGxlPg==</MessageText>  
</QueueMessage>  

Resposta

A resposta inclui um código de status HTTP e um conjunto de cabeçalhos de resposta.

Código de estado

Uma operação bem-sucedida retorna o código de status 201 (Criado).

Para obter mais informações sobre códigos de status, consulte Códigos de status e de erro.

Cabeçalhos de resposta

A resposta para esta operação inclui os seguintes cabeçalhos. A resposta também pode incluir cabeçalhos HTTP padrão adicionais. Todos os cabeçalhos padrão estão em conformidade com a especificação do protocolo HTTP/1.1.

Cabeçalho da solicitação Descrição
x-ms-request-id Identifica exclusivamente a solicitação que foi feita e você pode usá-la para solucionar problemas da solicitação. Para obter mais informações, consulte Solucionar problemas de operações de API.
x-ms-version Indica a versão do serviço de fila que foi usada para executar a solicitação. Este cabeçalho é retornado para solicitações que foram feitas na versão 2009-09-19 e posterior.
Date Um valor de data/hora UTC gerado pelo serviço, que indica a hora em que a resposta foi iniciada.
x-ms-client-request-id Esse cabeçalho pode ser usado para solucionar problemas de solicitações e respostas correspondentes. O valor desse cabeçalho é igual ao valor do cabeçalho x-ms-client-request-id se ele estiver presente na solicitação e o valor não contiver mais de 1.024 caracteres ASCII visíveis. Se o cabeçalho x-ms-client-request-id não estiver presente na solicitação, ele não estará presente na resposta.

Corpo da resposta

A partir da versão 2016-05-31, a resposta para a Put Message operação contém as informações da mensagem no corpo da resposta. O formato XML do corpo retornado é descrito aqui.

O MessageID elemento é um valor GUID que identifica a mensagem na fila. Esse valor é atribuído à mensagem pelo Armazenamento em Fila e é opaco para o cliente. Esse valor pode ser usado junto com o valor do elemento PopReceipt para excluir ou atualizar uma mensagem da fila. O valor de PopReceipt também é opaco para o cliente e é necessário quando você estiver usando as APIs Excluir mensagem ou Atualizar mensagem.

Os InsertionTimeelementos , ExpirationTime, e são TimeNextVisible representados como valores UTC e formatados conforme descrito na RFC 1123.

<QueueMessagesList>
    <QueueMessage>
      <MessageId>string-message-id</MessageId>
      <InsertionTime>insertion-time</InsertionTime>
      <ExpirationTime>expiration-time</ExpirationTime>
      <PopReceipt>opaque-string-receipt-data</PopReceipt>
      <TimeNextVisible>time-next-visible</TimeNextVisible>
    </QueueMessage>
</QueueMessagesList>

Resposta da amostra

Response Status:
HTTP/1.1 200 OK
Response headers:
Transfer-Encoding: chunked
Content-Type: application/xml
x-ms-version: 2016-05-31
Date: Fri, 09 Oct 2016 21:04:30 GMT
Server: Windows-Azure-Queue/1.0 Microsoft-HTTPAPI/2.0

Response Body:

<?xml version="1.0" encoding="utf-8"?>
<QueueMessagesList>
  <QueueMessage>
    <MessageId>5974b586-0df3-4e2d-ad0c-18e3892bfca2</MessageId>
    <InsertionTime>Fri, 09 Oct 2016 21:04:30 GMT</InsertionTime>
    <ExpirationTime>Fri, 16 Oct 2016 21:04:30 GMT</ExpirationTime>
    <PopReceipt>YzQ4Yzg1MDItYTc0Ny00OWNjLTkxYTUtZGM0MDFiZDAwYzEw</PopReceipt>
    <TimeNextVisible>Fri, 09 Oct 2016 23:29:20 GMT</TimeNextVisible>
   </QueueMessage>
</QueueMessagesList>

Autorização

Esta operação pode ser executada pelo proprietário da conta e por qualquer pessoa com uma assinatura de acesso compartilhado com permissões para executar esta operação.

Observações

O tempo limite de visibilidade opcional especifica o tempo em que a mensagem fica invisível. Depois que o tempo limite expirar, a mensagem se tornará visível. Se você não especificar um tempo limite de visibilidade, o valor padrão de 0 será usado.

O tempo de vida da mensagem opcional especifica por quanto tempo uma mensagem permanece na fila. A mensagem é excluída da fila quando o período de tempo de vida expira.

Uma mensagem deve estar em um formato que possa ser incluído em uma solicitação XML com codificação UTF-8. Para incluir marcação na mensagem, o conteúdo da mensagem deve ser com escape de XML ou codificado em Base64. Qualquer marcação XML na mensagem que não seja escapada ou codificada é removida antes que a mensagem seja adicionada à fila. Se um caractere inválido (por exemplo, 0x1F) for com escape de XML ou codificado em Base64 na mensagem, as leituras subsequentes da mensagem não terão êxito.

Se a mensagem for muito grande, o serviço retornará o código de status 400 (solicitação incorreta).

Ver também

Autorizar solicitações ao de Armazenamento do Azure
Códigos de status e de erro
Códigos de erro do serviço de fila