@azure/storage-queue package

  • Ссылка

Классы

AccountSASPermissions

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Это вспомогательный класс для создания строки, представляющей разрешения, предоставляемые AccountSAS. Значение true означает, что любой SAS, использующий эти разрешения, предоставит разрешения для этой операции. После установки всех значений они должны быть сериализованы с помощью toString и заданы в качестве поля разрешений для объекта AccountSASSignatureValues . Можно создать строку разрешений и без этого класса, но порядок разрешений является конкретным, и этот класс гарантирует правильность.
AccountSASResourceTypes

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Это вспомогательный класс для создания строки, представляющей ресурсы, доступные для AccountSAS. Значение true означает, что любой SAS, использующий эти разрешения, предоставит доступ к этому типу ресурса. После установки всех значений они должны быть сериализованы с помощью toString и заданы в качестве поля ресурсов в объекте AccountSASSignatureValues . Можно создать строку ресурсов и без этого класса, но порядок ресурсов является конкретным, и этот класс гарантирует правильность.
AccountSASServices

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Это вспомогательный класс для создания строки, представляющей службы, доступные для AccountSAS. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит доступ к этой службе. После установки всех значений они должны быть сериализованы с помощью toString и заданы в качестве поля служб в объекте AccountSASSignatureValues . Можно создать строку служб и без этого класса, но порядок служб является конкретным, и этот класс гарантирует правильность.
AnonymousCredential

AnonymousCredential предоставляет элемент CredentialPolicyCreator , используемый для создания объектов AnonymousCredentialPolicy . AnonymousCredentialPolicy используется с HTTP-запросами, которые считывают общедоступные ресурсы, или для использования с подписанными URL-адресами (SAS).
AnonymousCredentialPolicy

AnonymousCredentialPolicy используется с HTTP-запросами, которые считывают общедоступные ресурсы, или для использования с подписанными URL-адресами (SAS).
BaseRequestPolicy

Базовый класс, от которого наследуются все политики запросов.
Credential

Credential — это абстрактный класс для подписывания HTTP-запросов службы хранилища Azure. Этот класс будет размещать фабрику credentialPolicyCreator, которая создает CredentialPolicy.
CredentialPolicy

Политика учетных данных, используемая для подписывания HTTP-запросов перед отправкой. Этот класс является абстрактным.
HttpHeaders

Коллекция пар "ключ-значение" заголовка HTTP.
Pipeline

Класс Pipeline, содержащий политики HTTP-запросов. Вы можете создать конвейер по умолчанию, вызвав newPipeline(). Или вы можете создать конвейер с собственными политиками с помощью конструктора Конвейера. Перед реализацией настраиваемого конвейера обратитесь к newPipeline() и предоставленным политикам.
QueueClient

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

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Это вспомогательный класс для создания строки, представляющей разрешения, предоставленные ServiceSAS очереди. Значение true означает, что любой SAS, использующий эти разрешения, предоставит разрешения для этой операции. После установки всех значений они должны быть сериализованы с помощью toString и заданы в качестве поля разрешений для объекта QueueSASSignatureValues . Можно создать строку разрешений и без этого класса, но порядок разрешений является конкретным, и этот класс гарантирует правильность.
QueueServiceClient

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

Необязательные свойства, которые можно использовать при создании RequestPolicy.
RestError

Ошибка, возникавшая в результате HTTP-запроса к конечной точке службы.
SASQueryParameters

Представляет компоненты, составляющие параметры запроса SAS службы хранилища Azure. Этот тип не создается непосредственно пользователем; он создается только типами AccountSASSignatureValues и QueueSASSignatureValues . После создания его можно закодировать в toString() и добавить к URL-адресу напрямую (хотя здесь следует соблюдать осторожность, если существуют параметры запроса, которые могут повлиять на соответствующие способы добавления этих параметров запроса).

ПРИМЕЧАНИЕ. Экземпляры этого класса являются неизменяемыми.
StorageBrowserPolicy

StorageBrowserPolicy обрабатывает различия между Node.js и средой выполнения браузера, в том числе:

  1. Браузеры кэшируют запросы GET/HEAD путем добавления условных заголовков, таких как "IF_MODIFIED_SINCE". StorageBrowserPolicy — это политика, используемая для добавления запроса метки времени в URL-адрес запроса GET/HEAD, что позволяет избежать кэша браузера.

  2. Удаление заголовка файла cookie для обеспечения безопасности

  3. Удаление заголовка длины содержимого, чтобы избежать предупреждений браузеров
StorageBrowserPolicyFactory

StorageBrowserPolicyFactory — это класс фабрики, помогающий создавать объекты StorageBrowserPolicy .
StorageRetryPolicy

Политика повторных попыток с экспоненциальной повторными попытками и линейными повторными попытками.
StorageRetryPolicyFactory

StorageRetryPolicyFactory — это класс фабрики, помогающий создавать объекты StorageRetryPolicy .
StorageSharedKeyCredential

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

StorageSharedKeyCredential для авторизации ключа учетной записи службы хранилища Azure.
StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy — это политика, используемая для подписывания HTTP-запроса с помощью общего ключа.
WebResource

Создает новый объект WebResource.

Этот класс обеспечивает абстракцию при вызове REST, не зависят от библиотеки или реализации и упаковывает необходимые свойства для запуска запроса.

Интерфейсы

AccessPolicy

Политика доступа
AccountSASSignatureValues

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

AccountSASSignatureValues используется для создания подписанного URL-адреса (SAS) для учетной записи хранения Azure. После правильного задания всех значений вызовите метод generateSASQueryParameters(), чтобы получить представление SAS, которое фактически может быть применено к URL-адресам очереди. Обратите внимание, что и этот класс, и SASQueryParameters существуют, так как первый является изменяемым и логическим представлением, а второй является неизменяемым и используется для создания фактических запросов REST.

Дополнительные https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 сведения о SAS см https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas . в описании параметров, включая необходимые.
CommonOptions

Интерфейс для параметров, общих для каждой удаленной операции.
CorsRule

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

Объект, возвращаемый в массиве QueueMessageList при вызове метода Get Messages on a Queue.
EnqueuedMessage

Объект, возвращаемый в массиве QueueMessageList при вызове метода Put Message on a Queue
GeoReplication

Geo-Replication сведения о вторичной службе хранилища
HttpOperationResponse

Объект-оболочка для HTTP-запроса и ответа. Десериализованный объект хранится в свойстве parsedBody при получении текста ответа в ФОРМАТЕ JSON или XML.
IHttpClient

Интерфейс, который может отправлять HttpRequests и получать обещанные httpResponses.
ListQueuesSegmentResponse

Объект, возвращаемый при вызове списка очередей в службе очередей.
Logging

Параметры ведения журнала Azure Analytics.
MessageIdDeleteHeaders

Определяет заголовки для операции MessageId_delete.
MessageIdUpdateHeaders

Определяет заголовки для операции MessageId_update.
MessagesClearHeaders

Определяет заголовки для операции Messages_clear.
MessagesDequeueHeaders

Определяет заголовки для операции Messages_dequeue.
MessagesDequeueOptionalParams

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

Определяет заголовки для операции Messages_enqueue.
MessagesEnqueueOptionalParams

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

Определяет заголовки для операции Messages_peek.
MessagesPeekOptionalParams

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

Коллекция пар строк "ключ-значение".
Metrics

Интерфейс, представляющий метрики.
PeekedMessageItem

Объект, возвращаемый в массиве QueueMessageList при вызове Обзор Messages в очереди
PipelineOptions

Интерфейс option для конструктора конвейера.
QueueClearMessagesOptions

Параметры для настройки операции clearMessages
QueueCreateHeaders

Определяет заголовки для операции Queue_create.
QueueCreateIfNotExistsResponse

Содержит данные ответа для операции createIfNotExists .
QueueCreateOptions

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

Определяет заголовки для операции Queue_delete.
QueueDeleteIfExistsResponse

Содержит данные ответа для операции deleteIfExists .
QueueDeleteMessageOptions

Параметры для настройки операции deleteMessage
QueueDeleteOptions

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

Параметры для настройки операции exists
QueueGenerateSasUrlOptions

Параметры для настройки операции generateSasUrl .
QueueGetAccessPolicyHeaders

Определяет заголовки для операции Queue_getAccessPolicy.
QueueGetAccessPolicyOptions

Параметры для настройки операции getAccessPolicy
QueueGetPropertiesHeaders

Определяет заголовки для операции Queue_getProperties.
QueueGetPropertiesOptions

Параметры для настройки операции getProperties
QueueItem

Очередь службы хранилища Azure.
QueuePeekMessagesOptions

Параметры для настройки операции peekMessages
QueueReceiveMessageOptions

Параметры для настройки операции receiveMessages
QueueSASSignatureValues

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

QueueSASSignatureValues используется для создания маркеров SAS службы очередей для очередей.
QueueSendMessageOptions

Параметры для настройки операции sendMessage
QueueServiceProperties

Свойства службы хранилища.
QueueServiceStatistics

Статистика для службы хранилища.
QueueSetAccessPolicyHeaders

Определяет заголовки для операции Queue_setAccessPolicy.
QueueSetAccessPolicyOptions

Параметры для настройки операции setAccessPolicy
QueueSetMetadataHeaders

Определяет заголовки для операции Queue_setMetadata.
QueueSetMetadataOptions

Параметры для настройки операции setMetadata
QueueUpdateMessageOptions

Параметры для настройки операции updateMessage
RequestPolicy

Базовая структура политики запросов.
RetentionPolicy

политика хранения
SasIPRange

Допустимый диапазон IP-адресов для SAS.
ServiceGenerateAccountSasUrlOptions

Параметры для настройки операции generateAccountSasUrl .
ServiceGetPropertiesHeaders

Определяет заголовки для операции Service_getProperties.
ServiceGetPropertiesOptions

Параметры для настройки операции getProperties
ServiceGetStatisticsHeaders

Определяет заголовки для операции Service_getStatistics.
ServiceGetStatisticsOptions

Параметры для настройки операции getStatistics
ServiceListQueuesOptions

Параметры для настройки операции listQueues
ServiceListQueuesSegmentHeaders

Определяет заголовки для операции Service_listQueuesSegment.
ServiceSetPropertiesHeaders

Определяет заголовки для операции Service_setProperties.
ServiceSetPropertiesOptions

Параметры для настройки операции setProperties
SignedIdentifier

Подписанный идентификатор.
SignedIdentifierModel

подписанный идентификатор
StoragePipelineOptions

Интерфейс Option для метода newPipeline().
StorageRetryOptions

Интерфейс параметров повтора очереди хранилища.

Псевдонимы типа

CredentialPolicyCreator

Функция фабрики, которая создает новую credentialPolicy, которая использует предоставленный nextPolicy.
GeoReplicationStatusType

Определяет значения для GeoReplicationStatusType.
HttpRequestBody

Возможные типы текста HTTP-запроса
ListQueuesIncludeType

Определяет значения для ListQueuesIncludeType. Возможные значения: "метаданные"
MessageIdDeleteResponse

Содержит данные ответа для операции удаления.
MessageIdUpdateResponse

Содержит данные ответа для операции обновления.
MessagesClearResponse

Содержит данные ответа для операции очистки.
QueueClearMessagesResponse

Содержит данные ответа для операции clearMessages .
QueueCreateResponse

Содержит данные ответа для операции создания.
QueueDeleteMessageResponse

Содержит данные ответа для операции deleteMessage .
QueueDeleteResponse

Содержит данные ответа для операции удаления.
QueueGetAccessPolicyResponse

Содержит данные ответа для операции getAccessPolicy .
QueueGetPropertiesResponse

Содержит данные ответа для операции getProperties.
QueuePeekMessagesResponse

Содержит данные ответа для операции peekMessages .
QueueReceiveMessageResponse

Содержит данные ответа для операции receiveMessages .
QueueSendMessageResponse

Содержит данные ответа для операции sendMessage .
QueueSetAccessPolicyResponse

Содержит данные ответа для операции setAccessPolicy.
QueueSetMetadataResponse

Содержит данные ответа для операции setMetadata.
QueueUpdateMessageResponse

Содержит данные ответа для операции updateMessage .
ReceivedMessageItem

Объект, возвращаемый в массиве receivedMessageItems при вызове метода receiveMessages.

См. статью QueueReceiveMessageResponse.
RequestPolicyFactory

Создает новый объект RequestPolicy для каждого запроса, который использует предоставленный nextPolicy.
ServiceGetPropertiesResponse

Содержит данные ответа для операции getProperties.
ServiceGetStatisticsResponse

Содержит данные ответа для операции getStatistics.
ServiceListQueuesSegmentResponse

Содержит данные ответа для операции listQueuesSegment.
ServiceSetPropertiesResponse

Содержит данные ответа для операции setProperties.

Перечисления

SASProtocol

Протоколы для созданного SAS.
StorageQueueAudience

Определяет известные облачные аудитории для службы хранилища.
StorageRetryPolicyType

Типы RetryPolicy.

Функции

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Создайте новый объект сериализации RequestPolicyCreator, который будет сериализовать тела HTTP-запросов по мере их прохождения через конвейер HTTP.
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Создает объект SASQueryParameters , содержащий все параметры запроса SAS, необходимые для выполнения фактического запроса REST.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

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

Принимает только необходимые параметры, необходимые для создания SAS. Для необязательных параметров задайте соответствующие свойства напрямую, например разрешения, startsOn и идентификатор.

ПРЕДУПРЕЖДЕНИЕ. Если идентификатор не указан, требуются разрешения и срок действия. Необходимо назначить значение идентификатору или истекаетВ & разрешений вручную, если вы инициалируете с этим конструктором.
getQueueServiceAccountAudience(string)
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Создает новый объект Pipeline с предоставленными учетными данными.

Сведения о функции

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Создайте новый объект сериализации RequestPolicyCreator, который будет сериализовать тела HTTP-запросов по мере их прохождения через конвейер HTTP.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory

Параметры

deserializationContentTypes
DeserializationContentTypes
parsingOptions
SerializerOptions

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

RequestPolicyFactory

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Создает объект SASQueryParameters , содержащий все параметры запроса SAS, необходимые для выполнения фактического запроса REST.

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

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Параметры

accountSASSignatureValues
AccountSASSignatureValues

Значения подписи SAS учетной записи

sharedKeyCredential
StorageSharedKeyCredential

Учетные данные общего ключа.

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

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

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

Принимает только необходимые параметры, необходимые для создания SAS. Для необязательных параметров задайте соответствующие свойства напрямую, например разрешения, startsOn и идентификатор.

ПРЕДУПРЕЖДЕНИЕ. Если идентификатор не указан, требуются разрешения и срок действия. Необходимо назначить значение идентификатору или истекаетВ & разрешений вручную, если вы инициалируете с этим конструктором.

function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Параметры

queueSASSignatureValues
QueueSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

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

SASQueryParameters

getQueueServiceAccountAudience(string) 

function getQueueServiceAccountAudience(storageAccountName: string): string

Параметры

storageAccountName

string

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

string

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Создает новый объект Pipeline с предоставленными учетными данными.

function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline

Параметры

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

pipelineOptions
StoragePipelineOptions

Параметры.

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

Pipeline

Новый объект Pipeline.