@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(S), которые считывают общедоступные ресурсы или используются с подписанными URL-адресами (SAS).
AnonymousCredentialPolicy	AnonymousCredentialPolicy используется с запросами HTTP(S), которые считывают общедоступные ресурсы или используются с подписанными URL-адресами (SAS).
BaseRequestPolicy	Базовый класс, из которого наследуют все политики запросов.
Credential	Учетные данные — это абстрактный класс для подписывания HTTP-запросов службы хранилища Azure. Этот класс будет размещать фабрику credentialPolicyCreator, которая создает CredentialPolicy.
CredentialPolicy	Политика учетных данных, используемая для подписывания запросов HTTP(S) перед отправкой. Это абстрактный класс.
Pipeline	Класс Конвейера, содержащий политики HTTP-запроса. Конвейер по умолчанию можно создать, вызвав newPipeline. Вы также можете создать конвейер с собственными политиками конструктором Конвейера. Перед реализацией настраиваемого конвейера обратитесь к newPipeline и предоставленным политикам.
QueueClient	QueueClient представляет URL-адрес сообщений очереди службы хранилища Azure, позволяющих управлять своими сообщениями.
QueueSASPermissions	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Это вспомогательный класс для создания строки, представляющей разрешения, предоставленные ServiceSAS очереди. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит разрешения для этой операции. После установки всех значений его следует сериализовать с помощью toString и задать в качестве поля разрешений для объекта QueueSASSignatureValues. Можно создать строку разрешений без этого класса, но порядок разрешений является конкретным, и этот класс гарантирует правильность.
QueueServiceClient	QueueServiceClient представляет URL-адрес службы очередей службы хранилища Azure, которая позволяет управлять очередями.
SASQueryParameters	Представляет компоненты, составляющие параметры запроса SAS службы хранилища Azure. Этот тип не создается непосредственно пользователем; он создается только типами AccountSASSignatureValues и QueueSASSignatureValues . После создания его можно закодировать в toString() и добавить его непосредственно к URL-адресу (хотя осторожность должна быть предприняна здесь, если существуют существующие параметры запроса, которые могут повлиять на соответствующие средства добавления этих параметров запроса). ПРИМЕЧАНИЕ. Экземпляры этого класса неизменяемы.
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory — это класс фабрики, помогающий создавать объекты StorageBrowserPolicy.
StorageRetryPolicy	Политика повторных попыток с экспоненциальной повторными попытками и линейной повторными попытками, реализованной.
StorageRetryPolicyFactory	StorageRetryPolicyFactory — это класс фабрики, помогающий создавать объекты StorageRetryPolicy.
StorageSharedKeyCredential	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. StorageSharedKeyCredential для авторизации ключа учетной записи службы хранилища Azure.
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy — это политика, используемая для подписывания HTTP-запроса с общим ключом.

Интерфейсы

AccessPolicy	Политика доступа
AccountSASSignatureValues	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. AccountSASSignatureValues используется для создания подписанного URL-адреса (SAS) для учетной записи хранения Azure. После правильного задания всех значений вызов создаетSASQueryParameters() для получения представления SAS, который можно применить к URL-адресам очереди. Обратите внимание: что оба класса и SASQueryParameters существуют, так как первый является изменяемым и логическим представлением, а последний является неизменяемым и используется для создания фактических запросов REST. Дополнительные концептуальные сведения о SAS https://learn.microsoft.com/azure/storage/common/storage-dotnet-shared-access-signature-part-1 см. в https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas описаний параметров, включая необходимые
CommonOptions	Интерфейс для параметров, распространенных для каждой удаленной операции.
CorsRule	CORS — это функция HTTP, которая позволяет веб-приложению, работающему под одним доменом, получать доступ к ресурсам в другом домене. Веб-браузеры реализуют ограничение безопасности, известное как политика того же источника, которая запрещает веб-странице вызывать API в другом домене; CORS предоставляет безопасный способ разрешить одному домену (исходному домену) вызывать API в другом домене.
DequeuedMessageItem	Объект, возвращенный в массиве QueueMessageList при вызове метода Get Messages в очереди.
EnqueuedMessage	Объект, возвращенный в массиве QueueMessageList при вызове put Message в очереди
GeoReplication	Geo-Replication сведения о вторичной службе хранилища
HttpHeaders	Коллекция пар ключей и значений заголовка HTTP.
HttpOperationResponse	Http Response, совместимый с core-v1(core-http).
HttpResponse	Представление HTTP-ответа, включающее ссылку на запрос, который он был создан.
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 в очереди
PipelineLike	Интерфейс для класса Pipeline, содержащего политики HTTP-запроса. Конвейер по умолчанию можно создать, вызвав newPipeline. Вы также можете создать конвейер с собственными политиками конструктором Конвейера. Перед реализацией настраиваемого конвейера обратитесь к newPipeline и предоставленным политикам.
PipelineOptions	Интерфейс параметра для конструктора конвейера.
QueueClearMessagesOptions	Параметры настройки операции clearMessages
QueueCreateHeaders	Определяет заголовки для операции Queue_create.
QueueCreateIfNotExistsResponse	Содержит данные ответа для операции createIfNotExists.
QueueCreateOptions	Параметры настройки операции создания
QueueDeleteHeaders	Определяет заголовки для операции Queue_delete.
QueueDeleteIfExistsResponse	Содержит данные ответа для операции deleteIfExists.
QueueDeleteMessageOptions	Параметры настройки операции deleteMessage
QueueDeleteOptions	Параметры настройки операции удаления
QueueExistsOptions	Параметры настройки существуют операции
QueueGenerateSasUrlOptions	Параметры настройки создайте операцию SasUrl.
QueueGetAccessPolicyHeaders	Определяет заголовки для операции Queue_getAccessPolicy.
QueueGetAccessPolicyOptions	Параметры настройки операции getAccessPolicy
QueueGetPropertiesHeaders	Определяет заголовки для операции Queue_getProperties.
QueueGetPropertiesOptions	Параметры настройки операции getProperties
QueueItem	Очередь службы хранилища Azure.
QueuePeekMessagesOptions	Параметры настройки операции peekMessages
QueueReceiveMessageOptions	Параметры настройки операции полученияMessages
QueueSASSignatureValues	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. QueueSASSignatureValues используется для создания маркеров SAS службы очередей для очередей.
QueueSendMessageOptions	Параметры настройки операции sendMessage
QueueServiceProperties	Свойства службы хранилища.
QueueServiceStatistics	Статистика для службы хранилища.
QueueSetAccessPolicyHeaders	Определяет заголовки для операции Queue_setAccessPolicy.
QueueSetAccessPolicyOptions	Параметры настройки операции setAccessPolicy
QueueSetMetadataHeaders	Определяет заголовки для операции Queue_setMetadata.
QueueSetMetadataOptions	Параметры настройки операции setMetadata
QueueUpdateMessageOptions	Параметры настройки операции updateMessage
RequestPolicy	Совместимый интерфейс для политик запросов core-http
RequestPolicyFactory	Интерфейс для совместимости с requestPolicyFactory core-http
RequestPolicyOptions	Интерфейс для совместимости с RequestPolicy
ResponseLike	Объект с простым свойством _response.
ResponseWithBody	Объект с свойством _response с текстом и заголовками, которые уже проанализированы в известные типы.
ResponseWithHeaders	Объект с свойством _response, который уже анализирует заголовки в типизированный объект.
RestError	Настраиваемый тип ошибки для неудачных запросов конвейера.
RetentionPolicy	Политика хранения
SasIPRange	Допустимый диапазон IP-адресов для SAS.
ServiceClientOptions	Подмножество @azure/core-http ServiceClientOptions
ServiceGenerateAccountSasUrlOptions	Параметры настройки операции generateAccountSasUrl.
ServiceGetPropertiesHeaders	Определяет заголовки для операции Service_getProperties.
ServiceGetPropertiesOptions	Параметры настройки операции getProperties
ServiceGetStatisticsHeaders	Определяет заголовки для операции Service_getStatistics.
ServiceGetStatisticsOptions	Параметры настройки операции getStatistics
ServiceGetUserDelegationKeyHeaders	Определяет заголовки для Service_getUserDelegationKey операции.
ServiceGetUserDelegationKeyOptions	Опции настройки сервиса — получить ключ делегирования пользователя.
ServiceListQueuesOptions	Параметры настройки операции listQueues
ServiceListQueuesSegmentHeaders	Определяет заголовки для операции Service_listQueuesSegment.
ServiceSetPropertiesHeaders	Определяет заголовки для операции Service_setProperties.
ServiceSetPropertiesOptions	Параметры настройки операции setProperties
SignedIdentifier	Подписанный идентификатор.
SignedIdentifierModel	Подписанный идентификатор
StoragePipelineOptions	Интерфейс параметров для функции newPipeline.
StorageRetryOptions	Интерфейс параметров повторных попыток хранилища BLOB-объектов.
UserDelegationKey	Ключ для делегирования пользователей.
UserDelegationKeyModel	Ключ для делегирования пользователя
WebResource	Описание HTTP-запроса, который необходимо выполнить на удаленном сервере.

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

CredentialPolicyCreator	Функция фабрики, которая создает новый CredentialPolicy, использующий предоставленный nextPolicy.
GeoReplicationStatusType	Определяет значения для GeoReplicationStatusType.
HttpRequestBody	Типы тел, поддерживаемые в запросе. NodeJS.ReadableStream и () => NodeJS.ReadableStream — только узел. Blob, ReadableStream<Uint8Array> и () => ReadableStream<Uint8Array> предназначены только для браузера.
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
ServiceGetPropertiesResponse	Содержит данные ответа для операции getProperties.
ServiceGetStatisticsResponse	Содержит данные ответа для операции getStatistics.
ServiceGetUserDelegationKeyResponse	Содержит данные отклика операции getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions) .
ServiceListQueuesSegmentResponse	Содержит данные ответа для операции listQueuesSegment.
ServiceSetPropertiesResponse	Содержит данные ответа для операции setProperties.
WithResponse	Тип, представляющий результат операции с известным свойством _response.

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

SASProtocol	Протоколы для созданного SAS.
StorageQueueAudience	Определяет известные облачные аудитории для хранилища.
StorageRetryPolicyType	Типы RetryPolicy.

Функции

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Создает объект SASQueryParameters, содержащий все параметры запроса SAS, необходимые для выполнения фактического запроса REST. См. https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas
generateQueueSASQueryParameters(QueueSASSignatureValues, UserDelegationKey, string)	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Создает экземпляр SASQueryParameters. Принимает только необходимые параметры для создания SAS. Для дополнительных параметров задайте соответствующие свойства напрямую, например разрешения, запуск и идентификатор. ПРЕДУПРЕЖДЕНИЕ. Если идентификатор не указан, требуются разрешения и истекает срок действия. Необходимо назначить значение идентификатору или истекает срок действия разрешений & вручную, если вы инициалы с помощью этого конструктора.
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)
getQueueServiceAccountAudience(string)	Получение аудитории OAuth для учетной записи хранения для службы очередей.
isPipelineLike(unknown)	Помощник, который решает, соответствует ли заданный аргумент контракту конвейера
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	Создает новый объект Pipeline с предоставленными учетными данными.

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

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

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

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

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

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

Параметры

accountSASSignatureValues

AccountSASSignatureValues

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

sharedKeyCredential

StorageSharedKeyCredential

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

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

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, UserDelegationKey, string)

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

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

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

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

function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters

Параметры

queueSASSignatureValues

QueueSASSignatureValues

userDelegationKey

UserDelegationKey

accountName

string

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

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

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

Параметры

queueSASSignatureValues

QueueSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

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

SASQueryParameters

getQueueServiceAccountAudience(string)

Получение аудитории OAuth для учетной записи хранения для службы очередей.

function getQueueServiceAccountAudience(storageAccountName: string): string

Параметры

storageAccountName

string

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

string

isPipelineLike(unknown)

Помощник, который решает, соответствует ли заданный аргумент контракту конвейера

function isPipelineLike(pipeline: unknown): pipeline

Параметры

pipeline

unknown

Аргумент, который может быть конвейером

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

pipeline

Значение true, если аргумент удовлетворяет контракту конвейера

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

Optional. Options.

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

Pipeline

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