Package version
Creates an instance of QueueServiceClient.
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".
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.
Options to configure the HTTP pipeline.
Example using DefaultAzureCredential from @azure/identity:
const account = "<account>";
const credential = new DefaultAzureCredential();
const queueServiceClient = new QueueServiceClient(
`https://${account}.queue.core.windows.net`,
credential
}Example using an account name/key:
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
}
);Creates an instance of QueueServiceClient.
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".
Call newPipeline() to create a default pipeline, or provide a customized pipeline.
Credential factory in the pipleline to authenticate requests to the service, such as AnonymousCredential, StorageSharedKeyCredential. Initialized to an AnonymousCredential if not able to retrieve it from the pipeline.
Request policy pipeline.
StorageClientContext is a reference to protocol layer operations entry, which is generated by AutoRest generator.
URL string value.
Creates a new queue under the specified account.
name of the queue to create
Options to Queue create operation.
Response data for the Queue create operation.
Deletes the specified queue permanently.
name of the queue to delete.
Options to Queue delete operation.
Response data for the Queue delete operation.
Only available for QueueServiceClient constructed with a shared key credential.
Generates an account 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.
Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not specified.
Specifies the list of permissions to be associated with the SAS.
Specifies the resource types associated with the shared access signature.
Optional parameters.
An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
Gets the properties of a storage account’s Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
Options to get properties operation.
Response data including the queue service properties.
Creates a QueueClient object.
-
a new QueueClient
Example usage:
const queueClient = queueServiceClient.getQueueClient("<new queue name>");
const createQueueResponse = await queueClient.create();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.
Options to get statistics operation.
Response data for get statistics the operation.
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 using for await syntax:
let i = 1;
for await (const item of queueServiceClient.listQueues()) {
console.log(`Queue${i}: ${item.name}`);
i++;
}Example using iter.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 using 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 using paging with a marker:
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++;
}
}Options to list queues operation.
An asyncIterableIterator that supports paging.
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.
-
Options to set properties operation.
Response data for the Set Properties operation.
Creates an instance of QueueServiceClient.
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
Options to configure the HTTP pipeline.
A new QueueServiceClient object from the given connection string.
Generated using TypeDoc
A QueueServiceClient represents a URL to the Azure Storage Queue service allowing you to manipulate queues.