Поделиться через

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://learn.microsoft.com/rest/api/storageservices/create-queue4
deleteQueue(string, QueueDeleteOptions)

Удаляет указанную очередь окончательно.

См. https://learn.microsoft.com/rest/api/storageservices/delete-queue3
fromConnectionString(string, StoragePipelineOptions)

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

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

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

См. https://learn.microsoft.com/rest/api/storageservices/create-account-sas
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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

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

См. https://learn.microsoft.com/rest/api/storageservices/create-account-sas
getProperties(ServiceGetPropertiesOptions)

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

См. https://learn.microsoft.com/rest/api/storageservices/get-queue-service-properties
getQueueClient(string)

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

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

См. https://learn.microsoft.com/rest/api/storageservices/get-queue-service-stats
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

ДОСТУПНО ТОЛЬКО ПРИ ИСПОЛЬЗОВАНИИ АУТЕНТИФИКАЦИИ ТОКЕНА НОСИТЕЛЯ (TokenCredential).

Получает ключ делегирования пользователя для сервиса очереди. Это допустимая операция только при использовании аутентификации с токеном носителя.

См. https://learn.microsoft.com/rest/api/storageservices/get-user-delegation-key
listQueues(ServiceListQueuesOptions)

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

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

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

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

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

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

Пример использования iter.next():

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

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

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

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

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

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

let i = 1;
for await (const page of queueServiceClient.listQueues().byPage({ maxPageSize: 20 })) {
  for (const item of page.queueItems || []) {
    console.log(`Queue${i++}: ${item.name}`);
  }
}

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

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

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

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

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

См. https://learn.microsoft.com/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". При использовании AnonymousCredential можно добавить SAS, например "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". При использовании AnonymousCredential можно добавить SAS, например "https://myaccount.queue.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options
StoragePipelineOptions

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { QueueServiceClient } from "@azure/storage-queue";

const account = "<account>";
const credential = new DefaultAzureCredential();

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

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

import { StorageSharedKeyCredential, QueueServiceClient } from "@azure/storage-queue";

// Enter your storage account name and shared key
const account = "<account>";
const accountKey = "<accountkey>";

// Use StorageSharedKeyCredential with storage account and account key
// StorageSharedKeyCredential is only available in Node.js runtime, not in browsers
const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);

const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  sharedKeyCredential,
  {
    retryOptions: { maxTries: 4 }, // Retry options
    userAgentOptions: {
      userAgentPrefix: "BasicSample V10.0.0",
    }, // Customized telemetry string
  },
);

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

accountName 

accountName: string

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

string

наследуется от storageClient.accountName

url

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

url: string

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

string

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

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

createQueue(string, QueueCreateOptions)

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

См. https://learn.microsoft.com/rest/api/storageservices/create-queue4

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

Параметры

queueName

string

имя очереди для создания

options
QueueCreateOptions

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

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

Promise<QueueCreateResponse>

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

deleteQueue(string, QueueDeleteOptions)

Удаляет указанную очередь окончательно.

См. https://learn.microsoft.com/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. ] Пример строки подключения учетной записи — пример строки подключения SAS DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net — 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://learn.microsoft.com/rest/api/storageservices/create-account-sas

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

Параметры

expiresOn

Date

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

permissions
AccountSASPermissions

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

resourceTypes

string

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

options
ServiceGenerateAccountSasUrlOptions

Необязательные параметры.

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

string

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

generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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

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

См. https://learn.microsoft.com/rest/api/storageservices/create-account-sas

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

Параметры

expiresOn

Date

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

permissions
AccountSASPermissions

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

resourceTypes

string

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

options
ServiceGenerateAccountSasUrlOptions

Необязательные параметры.

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

string

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

getProperties(ServiceGetPropertiesOptions)

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

См. https://learn.microsoft.com/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

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

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

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

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
const createQueueResponse = await queueClient.create();
console.log(
  `Created queue ${queueName} successfully, service assigned request Id: ${createQueueResponse.requestId}`,
);

getStatistics(ServiceGetStatisticsOptions)

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

См. https://learn.microsoft.com/rest/api/storageservices/get-queue-service-stats

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

Параметры

options
ServiceGetStatisticsOptions

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

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

Promise<ServiceGetStatisticsResponse>

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

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

ДОСТУПНО ТОЛЬКО ПРИ ИСПОЛЬЗОВАНИИ АУТЕНТИФИКАЦИИ ТОКЕНА НОСИТЕЛЯ (TokenCredential).

Получает ключ делегирования пользователя для сервиса очереди. Это допустимая операция только при использовании аутентификации с токеном носителя.

См. https://learn.microsoft.com/rest/api/storageservices/get-user-delegation-key

function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>

Параметры

startsOn

Date

Время начала делегирования пользовательского SAS. Должно быть в течение 7 дней от текущего времени

expiresOn

Date

Время окончания для SAS для делегирования пользователей. Должно быть в течение 7 дней от текущего времени

options
ServiceGetUserDelegationKeyOptions

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

Promise<ServiceGetUserDelegationKeyResponse>

listQueues(ServiceListQueuesOptions)

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

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

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

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

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

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

Пример использования iter.next():

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

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

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

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

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

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

let i = 1;
for await (const page of queueServiceClient.listQueues().byPage({ maxPageSize: 20 })) {
  for (const item of page.queueItems || []) {
    console.log(`Queue${i++}: ${item.name}`);
  }
}

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

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

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

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

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

Параметры

options
ServiceListQueuesOptions

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

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

PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse, PageSettings>

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

setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

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

См. https://learn.microsoft.com/rest/api/storageservices/set-queue-service-properties

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

Параметры

properties
QueueServiceProperties
options
ServiceGetPropertiesOptions

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

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

Promise<ServiceSetPropertiesResponse>

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