Updated: August 4, 2015
The Clear Messages operation deletes all messages from the specified queue.
The Clear Messages request may be constructed as follows. HTTPS is recommended. Replace myaccount with the name of your storage account, and myqueue with the name of your queue:
When making a request against the emulated storage service, specify the emulator hostname and Queue service port as 127.0.0.1:10001, followed by the emulated storage account name:
The following additional parameters may be specified on the request URI.
Optional. The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.
The following table describes required and optional request headers.
Required. Specifies the authentication scheme, account name, and signature. For more information, see Authentication for the Azure Storage Services.
Date or x-ms-date
Required. Specifies the Coordinated Universal Time (UTC) for the request. For more information, see Authentication for the Azure Storage Services.
Optional. Specifies the version of the operation to use for this request. For more information, see Versioning for the Azure Storage Services.
Optional. Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. Using this header is highly recommended for correlating client-side activities with requests received by the server. For more information, see About Storage Analytics Logging and Azure Logging: Using Logs to Track Storage Requests.
The response includes an HTTP status code and a set of response headers.
A successful operation returns status code 204 (No Content).
For information about status codes, see Status and Error Codes.
The response for this operation includes the following headers. The response also includes additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.
This header uniquely identifies the request that was made and can be used for troubleshooting the request. For more information, see Troubleshooting API Operations.
Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and later.
A UTC date/time value generated by the service that indicates the time at which the response was initiated.
Only the account owner may call this operation.
If a queue contains a large number of messages, Clear Messages may time out before all messages have been deleted. In this case the Queue service will return status code 500 (Internal Server Error), with the additional error code OperationTimedOut. If the operation times out, the client should continue to retry Clear Messages until it succeeds, to ensure that all messages have been deleted.