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

@azure/storage-queue package

Классы

AccountSASPermissions

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Это вспомогательный класс для создания строки, представляющей разрешения, предоставленные AccountSAS. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит разрешения для этой операции. После установки всех значений его следует сериализовать с помощью toString и задать в качестве поля разрешений для объекта <xref:AccountSASSignatureValues>. Можно создать строку разрешений без этого класса, но порядок разрешений является конкретным, и этот класс гарантирует правильность.
AccountSASResourceTypes

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Это вспомогательный класс для создания строки, представляющей ресурсы, доступные учетной записью AccountSAS. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит доступ к этому типу ресурса. После установки всех значений его следует сериализовать с помощью toString и задать поле ресурсов в объекте <xref:AccountSASSignatureValues>. Можно создать строку ресурсов без этого класса, но порядок ресурсов является конкретным, и этот класс гарантирует правильность.
AccountSASServices

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Это вспомогательный класс для создания строки, представляющей службы, доступные учетной записью AccountSAS. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит этому службе доступ. После установки всех значений его следует сериализовать с помощью toString и задать в качестве поля служб в объекте <xref:AccountSASSignatureValues>. Можно создать строку служб без этого класса, но порядок служб является конкретным, и этот класс гарантирует правильность.
AnonymousCredential

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

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

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

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

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

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

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Это вспомогательный класс для создания строки, представляющей разрешения, предоставленные ServiceSAS очереди. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит разрешения для этой операции. После установки всех значений его следует сериализовать с помощью toString и задать в качестве поля разрешений для объекта <xref:QueueSASSignatureValues>. Можно создать строку разрешений без этого класса, но порядок разрешений является конкретным, и этот класс гарантирует правильность.
QueueServiceClient

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

Представляет компоненты, составляющие параметры запроса SAS службы хранилища Azure. Этот тип не создается непосредственно пользователем; он создается только типами <xref:AccountSASSignatureValues> и <xref:QueueSASSignatureValues>. После создания его можно закодировать в <xref:String> и добавить его непосредственно к URL-адресу (хотя осторожность должна быть предприняна здесь, если существуют существующие параметры запроса, которые могут повлиять на соответствующие средства добавления этих параметров запроса). ПРИМЕЧАНИЕ. Экземпляры этого класса неизменяемы.
StorageBrowserPolicy

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

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

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

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

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

StorageClient представляет основанный клиентский класс для <xref:QueueServiceClient>, <xref:QueueClient> и т. д.
StorageClientContext
StorageRetryPolicy

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

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

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. StorageSharedKeyCredential для авторизации ключа учетной записи службы хранилища Azure.
StorageSharedKeyCredentialPolicy

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

Интерфейсы

AccessPolicy

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

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. AccountSASSignatureValues используется для создания подписанного URL-адреса (SAS) для учетной записи хранения Azure. После правильного задания всех значений вызов создаетSASQueryParameters() для получения представления SAS, который можно применить к URL-адресам очереди. Обратите внимание: что этот класс и <xref:SASQueryParameters> существуют, так как первый является мутируемым и логическим представлением, а последний является неизменяемым и используется для создания фактических запросов REST.
CommonOptions

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

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

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

Объект, возвращенный в массиве QueueMessageList при вызове put Message в очереди
GeoReplication

Geo-Replication сведения о вторичной службе хранилища
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 при вызове peek Messages в очереди
PipelineOptions

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

Параметры настройки операции <xref:QueueClient.clearMessages>
QueueCreateHeaders

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

Содержит данные ответа для операции <xref:QueueClient.createIfNotExists>.
QueueCreateOptions

Параметры настройки операции <xref:QueueClient.create>
QueueDeleteHeaders

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

Содержит данные ответа для операции <xref:QueueClient.deleteIfExists>.
QueueDeleteMessageOptions

Параметры настройки операции <xref:QueueClient.deleteMessage>
QueueDeleteOptions

Параметры настройки операции <xref:QueueClient.delete>
QueueExistsOptions

Параметры настройки операции <xref:QueueClient.exists>
QueueGenerateSasUrlOptions

Параметры настройки операции <xref:QueueClient.generateSasUrl>.
QueueGetAccessPolicyHeaders

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

Параметры настройки операции <xref:QueueClient.getAccessPolicy>
QueueGetPropertiesHeaders

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

Параметры настройки операции <xref:QueueClient.getProperties>
QueueItem

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

Параметры настройки операции <xref:QueueClient.peekMessages>
QueueReceiveMessageOptions

Параметры настройки операции <xref:QueueClient.receiveMessages>
QueueSASSignatureValues

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. QueueSASSignatureValues используется для создания маркеров SAS службы очередей для очередей.
QueueSendMessageOptions

Параметры настройки операции <xref:QueueClient.sendMessage>
QueueServiceProperties

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

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

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

Параметры настройки операции <xref:QueueClient.setAccessPolicy>
QueueSetMetadataHeaders

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

Параметры настройки операции <xref:QueueClient.setMetadata>
QueueUpdateMessageOptions

Параметры настройки операции <xref:QueueClient.updateMessage>
RetentionPolicy

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

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

Параметры настройки операции <xref:QueueServiceClient.generateAccountSasUrl>.
ServiceGetPropertiesHeaders

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

Параметры настройки операции <xref:QueueServiceClient.getProperties>
ServiceGetStatisticsHeaders

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

Параметры настройки операции <xref:QueueServiceClient.getStatistics>
ServiceListQueuesOptions

Параметры настройки операции <xref:QueueServiceClient.listQueues>
ServiceListQueuesSegmentHeaders

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

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

Параметры настройки операции <xref:QueueServiceClient.setProperties>
SignedIdentifier

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

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

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

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

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

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

CredentialPolicyCreator

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

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

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

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

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

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

Содержит данные ответа для операции <xref:QueueClient.clearMessages>.
QueueCreateResponse

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

Содержит данные ответа для операции <xref:QueueClient.deleteMessage>.
QueueDeleteResponse

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

Содержит данные ответа для операции <xref:QueueClient.getAccessPolicy>.
QueueGetPropertiesResponse

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

Содержит данные ответа для операции <xref:QueueClient.peekMessages>.
QueueReceiveMessageResponse

Содержит данные ответа для операции <xref:QueueClient.receiveMessages>.
QueueSendMessageResponse

Содержит данные ответа для операции <xref:QueueClient.sendMessage>.
QueueSetAccessPolicyResponse

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

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

Содержит данные ответа для операции <xref:QueueClient.updateMessage>.
ReceivedMessageItem

Объект, возвращаемый в массиве receivedMessageItems при вызове <xref:QueueClient.receiveMessages>. См. <xref:QueueReceiveMessageResponse>
ServiceGetPropertiesResponse

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

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

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

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

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

SASProtocol

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

Типы RetryPolicy.

Функции

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Создает объект <xref:SASQueryParameters>, содержащий все параметры запроса SAS, необходимые для выполнения фактического запроса REST.
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Создает экземпляр SASQueryParameters.

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

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

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

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

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Создает объект <xref:SASQueryParameters>, содержащий все параметры запроса SAS, необходимые для выполнения фактического запроса REST.

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Параметры

accountSASSignatureValues
AccountSASSignatureValues

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

sharedKeyCredential
StorageSharedKeyCredential

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

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

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Создает экземпляр SASQueryParameters.

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

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

function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Параметры

queueSASSignatureValues
QueueSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

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

SASQueryParameters

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

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

Параметры

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

pipelineOptions
StoragePipelineOptions

Параметры.

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

Pipeline

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