QueueServiceClient class

  • Ссылка
Пакет:
@azure/storage-queue

QueueServiceClient представляет URL-адрес службы очередей службы хранилища Azure, позволяющий управлять очередями.

Extends

StorageClient

Конструкторы

QueueServiceClient(string, Pipeline)

Создает экземпляр QueueServiceClient.
QueueServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Создает экземпляр QueueServiceClient.

Унаследованные свойства

accountName
url

Значение строки URL-адреса.

Методы

createQueue(string, QueueCreateOptions)

Создает новую очередь в указанной учетной записи.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4
deleteQueue(string, QueueDeleteOptions)

Удаляет указанную очередь без возможности восстановления.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3
fromConnectionString(string, StoragePipelineOptions)

Создает экземпляр QueueServiceClient.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Доступно только для QueueServiceClient, созданного с учетными данными общего ключа.

Создает URI подписанного URL-адреса (SAS) учетной записи на основе переданных свойств и параметров клиента. SAS подписывается учетными данными общего ключа клиента.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
getProperties(ServiceGetPropertiesOptions)

Возвращает свойства службы очередей учетной записи хранения, включая свойства для правил Аналитика Службы хранилища и CORS (общий доступ к ресурсам независимо от источника).

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-properties
getQueueClient(string)

Создает объект QueueClient .
getStatistics(ServiceGetStatisticsOptions)

Получает статистику, связанную с репликацией службы очередей. Она доступна только для вторичной конечной точки, если для учетной записи хранилища включена географически избыточная репликация с доступом для чтения.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-stats
listQueues(ServiceListQueuesOptions)

Возвращает асинхронный итератор для вывода списка всех очередей в указанной учетной записи.

.byPage() возвращает асинхронный итератор для перечисления очередей на страницах.

Пример использования for await синтаксиса:

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

Пример, использующий среду 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();
}

Пример, использующий среду 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++;
    }
  }
}

Пример использования разбиения по страницам с маркером:

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++;
  }
}
setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

Задает свойства конечной точки службы очередей учетной записи хранения, включая свойства для Аналитика Службы хранилища, правил CORS (общий доступ к ресурсам независимо от источника) и параметров обратимого удаления.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-service-properties

Сведения о конструкторе

QueueServiceClient(string, Pipeline)

Создает экземпляр QueueServiceClient.

new QueueServiceClient(url: string, pipeline: Pipeline)

Параметры

url

string

Строка URL-адреса, указывающая на службу очередей службы хранилища Azure, например "https://myaccount.queue.core.windows.net"". Вы можете добавить SAS при использовании AnonymousCredential, например "https://myaccount.queue.core.windows.net?sasString"".

pipeline
Pipeline

Вызовите newPipeline() для создания конвейера по умолчанию или предоставления настраиваемого конвейера.

QueueServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Создает экземпляр QueueServiceClient.

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

Параметры

url

string

Строка URL-адреса, указывающая на службу очередей службы хранилища Azure, например "https://myaccount.queue.core.windows.net"". Вы можете добавить SAS при использовании AnonymousCredential, например "https://myaccount.queue.core.windows.net?sasString"".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные @azure/identity данные из пакета для проверки подлинности запросов к службе. Можно также предоставить объект , реализующий интерфейс TokenCredential. Если значение не указано, используется AnonymousCredential.

options
StoragePipelineOptions

Параметры для настройки конвейера HTTP.

Пример использования DefaultAzureCredential из @azure/identity:

const account = "<account>";

const credential = new DefaultAzureCredential();

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

Пример использования имени или ключа учетной записи:

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
  }
);

Сведения об унаследованном свойстве

accountName 

accountName: string

Значение свойства

string

Наследуется от StorageClient.accountName

url

Значение строки URL-адреса.

url: string

Значение свойства

string

Наследуется от StorageClient.url

Сведения о методе

createQueue(string, QueueCreateOptions)

Создает новую очередь в указанной учетной записи.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4

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

Параметры

queueName

string

имя создаваемой очереди

options
QueueCreateOptions

Параметры для операции создания очереди.

Возвращаемое значение

Promise<QueueCreateResponse>

Данные ответа для операции создания очереди.

deleteQueue(string, QueueDeleteOptions)

Удаляет указанную очередь без возможности восстановления.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3

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

Параметры

queueName

string

имя удаляемой очереди.

options
QueueDeleteOptions

Параметры для операции удаления в очередь.

Возвращаемое значение

Promise<QueueDeleteResponse>

Данные ответа для операции удаления очереди.

fromConnectionString(string, StoragePipelineOptions)

Создает экземпляр QueueServiceClient.

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

Параметры

connectionString

string

Строка подключения к учетной записи или строка подключения SAS учетной записи хранения Azure. [ Примечание. Строка подключения учетной записи может использоваться только в NODE.JS среде выполнения. ] Пример строки подключения учетной записи —DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Пример строки подключения SAS — 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
StoragePipelineOptions

Параметры для настройки конвейера HTTP.

Возвращаемое значение

QueueServiceClient

Новый объект QueueServiceClient из заданной строки подключения.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Доступно только для QueueServiceClient, созданного с учетными данными общего ключа.

Создает URI подписанного URL-адреса (SAS) учетной записи на основе переданных свойств и параметров клиента. SAS подписывается учетными данными общего ключа клиента.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas

function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string

Параметры

expiresOn

Date

Необязательный элемент. Время, когда подписанный URL-адрес становится недействительным. Значение по умолчанию — через час, если не указано.

permissions
AccountSASPermissions

Указывает список разрешений, которые будут связаны с SAS.

resourceTypes

string

Указывает типы ресурсов, связанные с подписанным URL-адресом.

options
ServiceGenerateAccountSasUrlOptions

Дополнительные параметры.

Возвращаемое значение

string

URI SAS учетной записи, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

getProperties(ServiceGetPropertiesOptions)

Возвращает свойства службы очередей учетной записи хранения, включая свойства для правил Аналитика Службы хранилища и CORS (общий доступ к ресурсам независимо от источника).

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-properties

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

Параметры

options
ServiceGetPropertiesOptions

Параметры для получения операции свойств.

Возвращаемое значение

Promise<ServiceGetPropertiesResponse>

Данные ответа, включая свойства службы очередей.

getQueueClient(string)

Создает объект QueueClient .

function getQueueClient(queueName: string): QueueClient

Параметры

queueName

string

Возвращаемое значение

QueueClient

новый QueueClient

Пример использования:

const queueClient = queueServiceClient.getQueueClient("<new queue name>");
const createQueueResponse = await queueClient.create();

getStatistics(ServiceGetStatisticsOptions)

Получает статистику, связанную с репликацией службы очередей. Она доступна только для вторичной конечной точки, если для учетной записи хранилища включена географически избыточная репликация с доступом для чтения.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-stats

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

Параметры

options
ServiceGetStatisticsOptions

Параметры для получения статистики операции.

Возвращаемое значение

Promise<ServiceGetStatisticsResponse>

Данные ответа для получения статистики операции.

listQueues(ServiceListQueuesOptions)

Возвращает асинхронный итератор для вывода списка всех очередей в указанной учетной записи.

.byPage() возвращает асинхронный итератор для перечисления очередей на страницах.

Пример использования for await синтаксиса:

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

Пример, использующий среду 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();
}

Пример, использующий среду 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++;
    }
  }
}

Пример использования разбиения по страницам с маркером:

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++;
  }
}

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

Параметры

options
ServiceListQueuesOptions

Параметры для операции вывода списка очередей.

Возвращаемое значение

PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse, PageSettings>

AsyncIterableIterator, поддерживающий разбиение по страницам.

setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

Задает свойства конечной точки службы очередей учетной записи хранения, включая свойства для Аналитика Службы хранилища, правил CORS (общий доступ к ресурсам независимо от источника) и параметров обратимого удаления.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-service-properties

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

Параметры

properties
QueueServiceProperties
options
ServiceGetPropertiesOptions

Параметры для задания операции свойств.

Возвращаемое значение

Promise<ServiceSetPropertiesResponse>

Данные ответа для операции Задания свойств.