Renew-Lock for a Message

Article
12/19/2023

Renews the lock on an already locked message.

Request

Method	Request URI	HTTP Version
POST	`http{s}://{serviceNamespace}.servicebus.windows.net/{queuePath}/messages/{messageId\|sequenceNumber}/{lockToken}` or `http{s}://{serviceNamespace}.servicebus.windows.net/{topicPath}/subscriptions/{subscriptionName}/messages/{messageId\|sequenceNumber}/{lockToken}\|HTTP/1.1`

URI Parameters

The URI is provided in the Location header of the peeked message, or you can construct it from the parts described in the following table.

Parameter	Description
`messageId`	The ID of the message, as returned in `BrokerProperties{MessageId}` by the Peek Message operation, for which the lock is to be renewed.
`sequence-number`	The sequence number of the message, as returned in `BrokerProperties{SequenceNumber}` by the Peek Message operation, for which the lock is to be renewed.
`lockToken`	The token of the lock of the message, as returned by the Peek Message operation in `BrokerProperties{LockToken}`, for which the lock is to be renewed.

Request Headers

The following table describes required and optional request headers.

Request Header Description

Authorization

Request Header	Description
Authorization	Specify one of the following token values: Microsoft Entra JSON Web Token (JWT) token. Example: `Authorization: Bearer <Azure AD JWT token>`. For information on generating a Microsoft Entra token, see Authenticate from an application. A SAS token. Example: `Authorization: SharedAccessSignature sr=<NAMESPACE NAME>.servicebus.windows.net&sig=<SHARED ACCESS KEY>&se=<TOKEN EXPIRY INSTANT>&skn=<SHARED KEY NAME>`. For information on generating a SAS token, see Generate a Shared Access Signature token and Generate SAS token.

Specify one of the following token values:

Microsoft Entra JSON Web Token (JWT) token.
Example: Authorization: Bearer <Azure AD JWT token>.
For information on generating a Microsoft Entra token, see Authenticate from an application.
A SAS token.
Example: Authorization: SharedAccessSignature sr=<NAMESPACE NAME>.servicebus.windows.net&sig=<SHARED ACCESS KEY>&se=<TOKEN EXPIRY INSTANT>&skn=<SHARED KEY NAME>.
For information on generating a SAS token, see Generate a Shared Access Signature token and Generate SAS token.

Request Body

None.

Response

The response includes an HTTP status code, a set of response headers, and the response body.

Response Codes

Code	Description
200	Message lock successfully renewed.
401	Authorization failure.
404	No message was found with the specified `MessageId` or `LockToken`.
410	Specified queue or subscription doesn't exist.
500	Internal error.

For information about status codes, see Status and Error Codes.

Response Headers

The response for this operation includes the following headers. The response might also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Header	Description
Content-Type	Set to `application/atom+xml;type=entry;charset=utf-8`.

Response Body

None.

Example

The following HTTP request renews the lock for a locked message:

POST https://your-namespace.servicebus.windows.net/HttpClientSampleQueue/messages/31907572-1647-43c3-8741-631acd554d6f/7da9cfd5-40d5-4bb1-8d64-ec5a52e1c547?timeout=60 HTTP/1.1  
Authorization: SharedAccessSignature sr=rukochbay&sig=rg9iGsK0ZyYlvhIqyH5IS5tqmeb08h8FstjHLPj3%2f8g%3d&se=1404265946&skn=RootManageSharedAccessKey  
Host: your-namespace.servicebus.windows.net  
Content-Length: 0

Service Bus returns the following response:

HTTP/1.1 200 OK  
Transfer-Encoding: chunked  
Content-Type: application/xml; charset=utf-8  
Server: Microsoft-HTTPAPI/2.0  
Date: Tue, 01 Jul 2014 23:00:35 GMT  
  
0

Share via