Share via

QueueGetPropertiesHeaders interface

  • Reference
Package:
@azure/storage-queue

Defines headers for Queue_getProperties operation.

Properties

approximateMessagesCount

The approximate number of messages in the queue. This number is not lower than the actual number of messages in the queue, but could be higher.
clientRequestId

If a client request id header is sent in the request, this header will be present in the response with the same value.
date

UTC date/time value generated by the service that indicates the time at which the response was initiated
errorCode

Error Code
metadata
requestId

This header uniquely identifies the request that was made and can be used for troubleshooting the request.
version

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 above.

Property Details

approximateMessagesCount

The approximate number of messages in the queue. This number is not lower than the actual number of messages in the queue, but could be higher.

approximateMessagesCount?: number

Property Value

number

clientRequestId

If a client request id header is sent in the request, this header will be present in the response with the same value.

clientRequestId?: string

Property Value

string

date

UTC date/time value generated by the service that indicates the time at which the response was initiated

date?: Date

Property Value

Date

errorCode

Error Code

errorCode?: string

Property Value

string

metadata 

metadata?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

requestId

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

requestId?: string

Property Value

string

version

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 above.

version?: string

Property Value

string