QueueServiceClient | @azure/storage-queue

A QueueServiceClient represents a URL to the Azure Storage Queue service allowing you to manipulate queues.

export
class: QueueServiceClient

Hierarchy

StorageClient
- QueueServiceClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

Overrides StorageClient.constructor
- Defined in storage/storage-queue/src/QueueServiceClient.ts:210
Creates an instance of QueueServiceClient.
memberof

QueueServiceClient

example
```
const account = "<account>";

// Use a TokenCredential implementation from the @azure/identity package.
// In this case, a DefaultAzureCredential (recommended for most users)
const credential = new DefaultAzureCredential();

const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  credential
}
```
example
```
const account = "<account>";

const sharedKeyCredential = new StorageSharedKeyCredential(account, "<account key>");

const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  sharedKeyCredential,
  {
    retryOptions: { maxTries: 4 }, // Retry options
    telemetry: { value: "BasicSample/V11.0.0" } // Customized telemetry string
  }
);
```
Parameters
- url: string
  
  A URL string pointing to Azure Storage queue service, such as "https://myaccount.queue.core.windows.net". You can append a SAS if using AnonymousCredential, such as "https://myaccount.queue.core.windows.net?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 QueueServiceClient
Overrides StorageClient.constructor
- Defined in storage/storage-queue/src/QueueServiceClient.ts:256
Creates an instance of QueueServiceClient.

memberof

QueueServiceClient

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

Properties

accountName

accountName: string

Protected storageClientContext

storageClientContext: StorageClientContext

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

type: {StorageClientContext}
memberof: StorageClient

url

url: string

URL string value.

type: {string}
memberof: StorageClient

Methods

createQueue

createQueue(queueName: string, options?: QueueCreateOptions): Promise<QueueCreateResponse>

- Defined in storage/storage-queue/src/QueueServiceClient.ts:613
Creates a new queue under the specified account.

see

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

memberof

QueueServiceClient

Parameters
- queueName: string
  
  name of the queue to create
- Default value options: QueueCreateOptions = {}
Returns Promise<QueueCreateResponse>

Response data for the Queue create operation.

deleteQueue

deleteQueue(queueName: string, options?: QueueDeleteOptions): Promise<QueueDeleteResponse>

- Defined in storage/storage-queue/src/QueueServiceClient.ts:629
Deletes the specified queue permanently.

see

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

memberof

QueueServiceClient

Parameters
- queueName: string
  
  name of the queue to delete.
- Default value options: QueueDeleteOptions = {}
Returns Promise<QueueDeleteResponse>

Response data for the Queue delete operation.

getProperties

getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>

- Defined in storage/storage-queue/src/QueueServiceClient.ts:514
Gets the properties of a storage account’s Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.

see

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

memberof

QueueServiceClient

Parameters
- Default value options: ServiceGetPropertiesOptions = {}
Returns Promise<ServiceGetPropertiesResponse>

Response data including the queue service properties.

getQueueClient

getQueueClient(queueName: string): QueueClient

- Defined in storage/storage-queue/src/QueueServiceClient.ts:307
Creates a QueueClient object.
memberof

QueueServiceClient

example
```
const queueClient = queueServiceClient.getQueueClient("<new queue name>");
const createQueueResponse = await queueClient.create();
```
Parameters
- queueName: string
Returns QueueClient

a new QueueClient

getStatistics

getStatistics(options?: ServiceGetStatisticsOptions): Promise<ServiceGetStatisticsResponse>

- Defined in storage/storage-queue/src/QueueServiceClient.ts:581
Retrieves statistics related to replication for the Queue service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.

see

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

memberof

QueueServiceClient

Parameters
- Default value options: ServiceGetStatisticsOptions = {}
Returns Promise<ServiceGetStatisticsResponse>

Response data for get statistics the operation.

listQueues

listQueues(options?: ServiceListQueuesOptions): PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse>

Returns an async iterable iterator to list all the queues under the specified account.

.byPage() returns an async iterable iterator to list the queues in pages.

example

   let i = 1;
   for await (const item of queueServiceClient.listQueues()) {
     console.log(`Queue${i}: ${item.name}`);
     i++;
   }

example

   // Generator syntax .next()
   let i = 1;
   let iterator = queueServiceClient.listQueues();
   let item = await iterator.next();
   while (!item.done) {
     console.log(`Queue${i}: ${iterator.value.name}`);
     i++;
     item = await iterator.next();
   }

example

   // Example for .byPage()
   // passing optional maxPageSize in the page settings
   let i = 1;
   for await (const item2 of queueServiceClient.listQueues().byPage({ maxPageSize: 20 })) {
     if (item2.queueItems) {
       for (const queueItem of item2.queueItems) {
         console.log(`Queue${i}: ${queueItem.name}`);
         i++;
       }
     }
   }

example

   let i = 1;
   let iterator = queueServiceClient.listQueues().byPage({ maxPageSize: 2 });
   let item = (await iterator.next()).value;
   // Prints 2 queue names
   if (item.queueItems) {
     for (const queueItem of item.queueItems) {
       console.log(`Queue${i}: ${queueItem.name}`);
       i++;
     }
   }
   // Gets next marker
   let marker = item.continuationToken;
   // Passing next marker as continuationToken
   iterator = queueServiceClient.listQueues().byPage({ continuationToken: marker, maxPageSize: 10 });
   item = (await iterator.next()).value;
   // Prints 10 queue names
   if (item.queueItems) {
     for (const queueItem of item.queueItems) {
       console.log(`Queue${i}: ${queueItem.name}`);
       i++;
     }
   }

memberof

QueueServiceClient

Parameters

Default value options: ServiceListQueuesOptions = {}

Returns PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse>

An asyncIterableIterator that supports paging.

setProperties

setProperties(properties: QueueServiceProperties, options?: ServiceGetPropertiesOptions): Promise<ServiceSetPropertiesResponse>

- Defined in storage/storage-queue/src/QueueServiceClient.ts:547
Sets properties for a storage account’s Queue service endpoint, including properties for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings.

see

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

memberof

QueueServiceClient

Parameters
- properties: QueueServiceProperties
- Default value options: ServiceGetPropertiesOptions = {}
Returns Promise<ServiceSetPropertiesResponse>

Response data for the Set Properties operation.

Static fromConnectionString

fromConnectionString(connectionString: string, options?: StoragePipelineOptions): QueueServiceClient

- Defined in storage/storage-queue/src/QueueServiceClient.ts:175
Creates an instance of QueueServiceClient.

memberof

QueueServiceClient

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
- Optional options: StoragePipelineOptions
Returns QueueServiceClient

A new QueueServiceClient object from the given connection string.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

url: string

Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Optional options: StoragePipelineOptions

Returns QueueServiceClient

Parameters

url: string

pipeline: Pipeline

Returns QueueServiceClient

Properties

accountName

Protected storageClientContext

url

Methods

createQueue

Parameters

queueName: string

Default value options: QueueCreateOptions = {}

Returns Promise<QueueCreateResponse>

deleteQueue

Parameters

queueName: string

Default value options: QueueDeleteOptions = {}

Returns Promise<QueueDeleteResponse>

getProperties

Parameters

Default value options: ServiceGetPropertiesOptions = {}

Returns Promise<ServiceGetPropertiesResponse>

getQueueClient

Parameters

queueName: string

Returns QueueClient

getStatistics

Parameters

Default value options: ServiceGetStatisticsOptions = {}

Returns Promise<ServiceGetStatisticsResponse>

listQueues

Parameters

Default value options: ServiceListQueuesOptions = {}

Returns PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse>

setProperties

Parameters

properties: QueueServiceProperties

Default value options: ServiceGetPropertiesOptions = {}

Returns Promise<ServiceSetPropertiesResponse>

Static fromConnectionString

Parameters

connectionString: string

Optional options: StoragePipelineOptions

Returns QueueServiceClient