QueueClient | @azure/storage-queue

A QueueClient represents a URL to an Azure Storage Queue's messages allowing you to manipulate its messages.

export

Hierarchy

StorageClient
- QueueClient

Index

Constructors

constructor

Properties

Accessors

name

Methods

Constructors

constructor

new QueueClient(connectionString: string, queueName: string, options?: StoragePipelineOptions): QueueClient
new QueueClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions): QueueClient
new QueueClient(url: string, pipeline: Pipeline): QueueClient

Overrides StorageClient.constructor
- Defined in QueueClient.ts:568
Creates an instance of QueueClient.

memberof

QueueClient

Parameters
- connectionString: string
  
  Account connection string or a SAS connection string of an Azure storage account. [ Note - Account connection string can only be used in NODE.JS runtime. ] Account connection string example - DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS connection string example - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString
- queueName: string
  
  Queue name.
- Optional options: StoragePipelineOptions
Returns QueueClient
Overrides StorageClient.constructor
- Defined in QueueClient.ts:583
Creates an instance of QueueClient.

memberof

QueueClient

Parameters
- url: string
  
  A URL string pointing to Azure Storage queue, such as "https://myaccount.queue.core.windows.net/myqueue". You can append a SAS if using AnonymousCredential, such as "https://myaccount.queue.core.windows.net/myqueue?sasString".
- Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
  
  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
- Optional options: StoragePipelineOptions
Returns QueueClient
Overrides StorageClient.constructor
- Defined in QueueClient.ts:599
Creates an instance of QueueClient.

memberof

QueueClient

Parameters
- url: string
  
  A URL string pointing to Azure Storage queue, such as "https://myaccount.queue.core.windows.net/myqueue". You can append a SAS if using AnonymousCredential, such as "https://myaccount.queue.core.windows.net/myqueue?sasString".
- pipeline: Pipeline
  
  Call newPipeline() to create a default pipeline, or provide a customized pipeline.
Returns QueueClient

Properties

accountName

accountName: string

Protected storageClientContext

storageClientContext: StorageClientContext

StorageClientContext is a reference to protocol layer operations entry, which is generated by AutoRest generator.

memberof: StorageClient

url

url: string

URL string value.

memberof: StorageClient

Accessors

name

get name(): string

- Defined in QueueClient.ts:566
The name of the queue.

Returns string

Methods

clearMessages

clearMessages(options?: QueueClearMessagesOptions): Promise<QueueClearMessagesResponse>

- Defined in QueueClient.ts:1096
Clear deletes all messages from a queue.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/clear-messages

memberof

QueueClient

Parameters
- Default value options: QueueClearMessagesOptions = {}
Returns Promise<QueueClearMessagesResponse>

Response data for the clear messages operation.

create

create(options?: QueueCreateOptions): Promise<QueueCreateResponse>

- Defined in QueueClient.ts:715
Creates a new queue under the specified account.
see

https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4

memberof
QueueClient

Example usage:
```
const queueClient = queueServiceClient.getQueueClient("<new queue name>");
const createQueueResponse = await queueClient.create();
```
Parameters
- Default value options: QueueCreateOptions = {}
Returns Promise<QueueCreateResponse>

Response data for the Queue create operation.

createIfNotExists

createIfNotExists(options?: QueueCreateOptions): Promise<QueueCreateIfNotExistsResponse>

- Defined in QueueClient.ts:743
Creates a new queue under the specified account if it doesn't already exist. If the queue already exists, it is not changed.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4

memberof

QueueClient

Parameters
- Default value options: QueueCreateOptions = {}
Returns Promise<QueueCreateIfNotExistsResponse>

delete

delete(options?: QueueDeleteOptions): Promise<QueueDeleteResponse>

- Defined in QueueClient.ts:852
Deletes the specified queue permanently.
see

https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3

memberof
QueueClient

Example usage:
```
const deleteQueueResponse = await queueClient.delete();
console.log(
  "Delete queue successfully, service assigned request Id:", deleteQueueResponse.requestId
);
```
Parameters
- Default value options: QueueDeleteOptions = {}
Returns Promise<QueueDeleteResponse>

Response data for the Queue delete operation.

deleteIfExists

deleteIfExists(options?: QueueDeleteOptions): Promise<QueueDeleteIfExistsResponse>

- Defined in QueueClient.ts:800
Deletes the specified queue permanently if it exists.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3

memberof

QueueClient

Parameters
- Default value options: QueueDeleteOptions = {}
Returns Promise<QueueDeleteIfExistsResponse>

deleteMessage

deleteMessage(messageId: string, popReceipt: string, options?: QueueDeleteMessageOptions): Promise<QueueDeleteMessageResponse>

- Defined in QueueClient.ts:1304
deleteMessage permanently removes the specified message from its queue.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/delete-message2

memberof

QueueClient

Parameters
- messageId: string
  
  Id of the message.
- popReceipt: string
  
  A valid pop receipt value returned from an earlier call to the receive messages or update message operation.
- Default value options: QueueDeleteMessageOptions = {}
Returns Promise<QueueDeleteMessageResponse>

Response data for the delete message operation.

exists

exists(options?: QueueExistsOptions): Promise<boolean>

- Defined in QueueClient.ts:881
Returns true if the specified queue exists; false otherwise.

NOTE: use this function with care since an existing queue might be deleted by other clients or applications. Vice versa new queues might be added by other clients or applications after this function completes.

memberof

QueueClient

Parameters
- Default value options: QueueExistsOptions = {}
Returns Promise<boolean>

generateSasUrl

generateSasUrl(options: QueueGenerateSasUrlOptions): string

- Defined in QueueClient.ts:1422
Only available for QueueClient constructed with a shared key credential.

Generates a Service Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

memberof

QueueClient

Parameters
- options: QueueGenerateSasUrlOptions
  
  Optional parameters.
Returns string

The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.

getAccessPolicy

getAccessPolicy(options?: QueueGetAccessPolicyOptions): Promise<QueueGetAccessPolicyResponse>

- Defined in QueueClient.ts:987
Gets details about any stored access policies specified on the queue that may be used with Shared Access Signatures.

WARNING: JavaScript Date will potential lost precision when parsing start and expiry string. For example, new Date("2018-12-31T03:44:23.8827891Z").toISOString() will get "2018-12-31T03:44:23.882Z".

see

https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-acl

memberof

QueueClient

Parameters
- Default value options: QueueGetAccessPolicyOptions = {}
Returns Promise<QueueGetAccessPolicyResponse>

Response data for the Queue get access policy operation.

getProperties

getProperties(options?: QueueGetPropertiesOptions): Promise<QueueGetPropertiesResponse>

- Defined in QueueClient.ts:921
Gets all user-defined metadata and system properties for the specified queue. Metadata is associated with the queue as name-values pairs.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-metadata

WARNING: The metadata object returned in the response will have its keys in lowercase, even if they originally contained uppercase characters. This differs from the metadata keys returned by the listQueues method of QueueServiceClient using the includeMetadata option, which will retain their original casing.

memberof

QueueClient

Parameters
- Default value options: QueueGetPropertiesOptions = {}
Returns Promise<QueueGetPropertiesResponse>

Response data for the Queue get properties operation.

peekMessages

peekMessages(options?: QueuePeekMessagesOptions): Promise<QueuePeekMessagesResponse>

- Defined in QueueClient.ts:1257
peekMessages retrieves one or more messages from the front of the queue but does not alter the visibility of the message.
see

https://docs.microsoft.com/en-us/rest/api/storageservices/peek-messages

memberof
QueueClient

Example usage:
```
const peekMessagesResponse = await queueClient.peekMessages();
console.log("The peeked message is:", peekMessagesResponse.peekedMessageItems[0].messageText);
```
Parameters
- Default value options: QueuePeekMessagesOptions = {}
Returns Promise<QueuePeekMessagesResponse>

Response data for the peek messages operation.

receiveMessages

receiveMessages(options?: QueueReceiveMessageOptions): Promise<QueueReceiveMessageResponse>

receiveMessages retrieves one or more messages from the front of the queue.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages

memberof

QueueClient

Example usage:

const response = await queueClient.receiveMessages();
if (response.receivedMessageItems.length == 1) {
  const receivedMessageItem = response.receivedMessageItems[0];
  console.log("Processing & deleting message with content:", receivedMessageItem.messageText);
  const deleteMessageResponse = await queueClient.deleteMessage(
    receivedMessageItem.messageId,
    receivedMessageItem.popReceipt
  );
  console.log(
    "Delete message successfully, service assigned request Id:",
    deleteMessageResponse.requestId
  );
}

Parameters

Default value options: QueueReceiveMessageOptions = {}

Returns Promise<QueueReceiveMessageResponse>

Response data for the receive messages operation.

sendMessage

sendMessage(messageText: string, options?: QueueSendMessageOptions): Promise<QueueSendMessageResponse>

- Defined in QueueClient.ts:1138
sendMessage adds a new message to the back of a queue. The visibility timeout specifies how long the message should be invisible to Dequeue and Peek operations. The message content is up to 64KB in size, and must be in a format that can be included in an XML request with UTF-8 encoding. To include markup in the message, the contents of the message must either be XML-escaped or Base64-encode.
see

https://docs.microsoft.com/en-us/rest/api/storageservices/put-message

memberof
QueueClient

Example usage:
```
const sendMessageResponse = await queueClient.sendMessage("Hello World!");
console.log(
  "Sent message successfully, service assigned message Id:", sendMessageResponse.messageId,
  "service assigned request Id:", sendMessageResponse.requestId
);
```
Parameters
- messageText: string
  
  Text of the message to send
- Default value options: QueueSendMessageOptions = {}
Returns Promise<QueueSendMessageResponse>

Response data for the send messages operation.

setAccessPolicy

setAccessPolicy(queueAcl?: SignedIdentifier[], options?: QueueSetAccessPolicyOptions): Promise<QueueSetAccessPolicyResponse>

- Defined in QueueClient.ts:1050
Sets stored access policies for the queue that may be used with Shared Access Signatures.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-acl

memberof

QueueClient

Parameters
- Optional queueAcl: SignedIdentifier[]
- Default value options: QueueSetAccessPolicyOptions = {}
Returns Promise<QueueSetAccessPolicyResponse>

Response data for the Queue set access policy operation.

setMetadata

setMetadata(metadata?: Metadata, options?: QueueSetMetadataOptions): Promise<QueueSetMetadataResponse>

- Defined in QueueClient.ts:953
Sets one or more user-defined name-value pairs for the specified queue.

If no option provided, or no metadata defined in the option parameter, the queue metadata will be removed.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata

memberof

QueueClient

Parameters
- Optional metadata: Metadata
- Default value options: QueueSetMetadataOptions = {}
Returns Promise<QueueSetMetadataResponse>

Response data for the Queue set metadata operation.

updateMessage

updateMessage(messageId: string, popReceipt: string, message?: undefined | string, visibilityTimeout?: undefined | number, options?: QueueUpdateMessageOptions): Promise<QueueUpdateMessageResponse>

- Defined in QueueClient.ts:1344
Update changes a message's visibility timeout and contents. The message content is up to 64KB in size, and must be in a format that can be included in an XML request with UTF-8 encoding. To include markup in the message, the contents of the message must either be XML-escaped or Base64-encode.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/update-message

memberof

QueueClient

Parameters
- messageId: string
  
  Id of the message
- popReceipt: string
  
  A valid pop receipt value returned from an earlier call to the receive messages or update message operation.
- Optional message: undefined | string
  
  Message to update. If this parameter is undefined, then the content of the message won't be updated.
- Optional visibilityTimeout: undefined | number
  
  Specifies the new visibility timeout value, in seconds, relative to server time. The new value must be larger than or equal to 0, and cannot be larger than 7 days. The visibility timeout of a message cannot be set to a value later than the expiry time. A message can be updated until it has been deleted or has expired.
- Default value options: QueueUpdateMessageOptions = {}
Returns Promise<QueueUpdateMessageResponse>

Response data for the update message operation.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

connectionString: string

queueName: string

Optional options: StoragePipelineOptions

Returns QueueClient

Parameters

url: string

Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Optional options: StoragePipelineOptions

Returns QueueClient

Parameters

url: string

pipeline: Pipeline

Returns QueueClient

Properties

accountName

Protected storageClientContext

url

Accessors

name

Returns string

Methods

clearMessages

Parameters

Default value options: QueueClearMessagesOptions = {}

Returns Promise<QueueClearMessagesResponse>

create

Parameters

Default value options: QueueCreateOptions = {}

Returns Promise<QueueCreateResponse>

createIfNotExists

Parameters

Default value options: QueueCreateOptions = {}

Returns Promise<QueueCreateIfNotExistsResponse>

delete

Parameters

Default value options: QueueDeleteOptions = {}

Returns Promise<QueueDeleteResponse>

deleteIfExists

Parameters

Default value options: QueueDeleteOptions = {}

Returns Promise<QueueDeleteIfExistsResponse>

deleteMessage

Parameters

messageId: string

popReceipt: string

Default value options: QueueDeleteMessageOptions = {}

Returns Promise<QueueDeleteMessageResponse>

exists

Parameters

Default value options: QueueExistsOptions = {}

Returns Promise<boolean>

generateSasUrl

Parameters

options: QueueGenerateSasUrlOptions

Returns string

getAccessPolicy

Parameters

Default value options: QueueGetAccessPolicyOptions = {}

Returns Promise<QueueGetAccessPolicyResponse>

getProperties

Parameters

Default value options: QueueGetPropertiesOptions = {}

Returns Promise<QueueGetPropertiesResponse>

peekMessages

Parameters

Default value options: QueuePeekMessagesOptions = {}

Returns Promise<QueuePeekMessagesResponse>

receiveMessages

Parameters

Default value options: QueueReceiveMessageOptions = {}

Returns Promise<QueueReceiveMessageResponse>