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


@azure/storage-common package

Классы

AnonymousCredential

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

AnonymousCredentialPolicy

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

BaseRequestPolicy

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

BufferScheduler

Этот класс принимает поток Node.js для чтения в качестве входных данных и сохраняет чтение данных из потока во внутреннюю структуру буфера, пока не достигнет maxBuffers. Каждый доступный буфер попытается активировать исходящийHandler.

Внутренняя структура буфера включает входящий массив буфера и исходящий массив буферов. Входящий массив буферов включает в себя "пустые" буферы, которые можно заполнить новыми входящими данными. Исходящий массив включает заполненные буферы, которые обрабатываются исходящимHandler. Каждый указанный выше размер буфера определяется параметром bufferSize.

NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING

NUM_OF_ALL_BUFFERS меньше или равно maxBuffers

СОВЕТЫ ПО УЛУЧШЕНИЮ ПРОИЗВОДИТЕЛЬНОСТИ:

  1. Входной поток highWaterMark лучше задать то же значение с параметром bufferSize, что позволит избежать операций Buffer.concat().
  2. concurrency должен устанавливать меньшее значение, чем maxBuffers, что полезно для снижения вероятности того, что исходящий обработчик ожидает потоковых данных. В этой ситуации исходящие обработчики блокируются. Исходящая очередь не должна быть пустой.
Credential

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

CredentialPolicy

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

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-запроса с общим ключом.

UserDelegationKeyCredential

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

UserDelegationKeyCredential используется только для генерации SAS для делегирования пользователей.

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

Интерфейсы

NodeJSReadableStream

Node.js доступный destroy для чтения поток, который также имеет метод.

StorageRetryOptions

Интерфейс параметров повторных попыток хранилища BLOB-объектов.

StorageSharedKeyCredentialPolicyOptions

Параметры, используемые для настройки политики StorageSharedKeyCredentialPolicy.

UserDelegationKey

Ключ для делегирования пользователей.

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

CredentialPolicyCreator

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

OutgoingHandler

OutgoingHandler — это асинхронная функция, активируется BufferScheduler.

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

StorageRetryPolicyType

Типы RetryPolicy.

Функции

NewRetryPolicyFactory(StorageRetryOptions)

Метод фабрики, используемый для создания фабрики RetryPolicy.

getCachedDefaultHttpClient()
storageBrowserPolicy()

storageBrowserPolicy — это политика, используемая для предотвращения кэширования запросов браузерами и удаления файлов cookie и заголовков с явной длиной содержимого.

storageCorrectContentLengthPolicy()

storageCorrectContentLengthPolicy для корректной установки заголовка Content-Length с длиной тела запроса.

storageRequestFailureDetailsParserPolicy()

StorageRequestFailureDetailsParserPolicy

storageRetryPolicy(StorageRetryOptions)

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

storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)

storageSharedKeyCredentialPolicy обрабатывает запросы на подпись с помощью ключей учетной записи хранения.

Переменные

storageBrowserPolicyName

Программный идентификатор StorageBrowserPolicy.

storageCorrectContentLengthPolicyName

Программный идентификатор хранилищаCorrectContentLengthPolicy.

storageRequestFailureDetailsParserPolicyName

Программный идентификатор StorageRequestFailureDetailsParserPolicy.

storageRetryPolicyName

Название хранилища RetryPolicy

storageSharedKeyCredentialPolicyName

Программный идентификатор хранилища SharedKeyCredentialPolicy.

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

NewRetryPolicyFactory(StorageRetryOptions)

Метод фабрики, используемый для создания фабрики RetryPolicy.

function NewRetryPolicyFactory(retryOptions?: StorageRetryOptions): RequestPolicyFactory

Параметры

retryOptions
StorageRetryOptions

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

getCachedDefaultHttpClient()

function getCachedDefaultHttpClient(): HttpClient

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

storageBrowserPolicy()

storageBrowserPolicy — это политика, используемая для предотвращения кэширования запросов браузерами и удаления файлов cookie и заголовков с явной длиной содержимого.

function storageBrowserPolicy(): PipelinePolicy

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

storageCorrectContentLengthPolicy()

storageCorrectContentLengthPolicy для корректной установки заголовка Content-Length с длиной тела запроса.

function storageCorrectContentLengthPolicy(): PipelinePolicy

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

storageRequestFailureDetailsParserPolicy()

StorageRequestFailureDetailsParserPolicy

function storageRequestFailureDetailsParserPolicy(): PipelinePolicy

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

storageRetryPolicy(StorageRetryOptions)

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

function storageRetryPolicy(options?: StorageRetryOptions): PipelinePolicy

Параметры

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

storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)

storageSharedKeyCredentialPolicy обрабатывает запросы на подпись с помощью ключей учетной записи хранения.

function storageSharedKeyCredentialPolicy(options: StorageSharedKeyCredentialPolicyOptions): PipelinePolicy

Параметры

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

Variable Details

storageBrowserPolicyName

Программный идентификатор StorageBrowserPolicy.

storageBrowserPolicyName: "storageBrowserPolicy"

Тип

"storageBrowserPolicy"

storageCorrectContentLengthPolicyName

Программный идентификатор хранилищаCorrectContentLengthPolicy.

storageCorrectContentLengthPolicyName: "StorageCorrectContentLengthPolicy"

Тип

"StorageCorrectContentLengthPolicy"

storageRequestFailureDetailsParserPolicyName

Программный идентификатор StorageRequestFailureDetailsParserPolicy.

storageRequestFailureDetailsParserPolicyName: "storageRequestFailureDetailsParserPolicy"

Тип

"storageRequestFailureDetailsParserPolicy"

storageRetryPolicyName

Название хранилища RetryPolicy

storageRetryPolicyName: "storageRetryPolicy"

Тип

"storageRetryPolicy"

storageSharedKeyCredentialPolicyName

Программный идентификатор хранилища SharedKeyCredentialPolicy.

storageSharedKeyCredentialPolicyName: "storageSharedKeyCredentialPolicy"

Тип

"storageSharedKeyCredentialPolicy"