@azure/storage-common package

Classes

AnonymousCredential

AnonymousCredential fornece um membro credentialPolicyCreator usado para criar objetos AnonymousCredentialPolicy. AnonymousCredentialPolicy é usado com solicitações HTTP(S) que leem recursos públicos ou para uso com Assinaturas de Acesso Compartilhado (SAS).

AnonymousCredentialPolicy

AnonymousCredentialPolicy é usado com solicitações HTTP(S) que leem recursos públicos ou para uso com Assinaturas de Acesso Compartilhado (SAS).

BaseRequestPolicy

A classe base da qual derivam todas as políticas de solicitação.

BufferScheduler

Essa classe aceita um fluxo Node.js legível como entrada e mantém a leitura de dados do fluxo para a estrutura de buffer interno, até que atinja maxBuffers. Cada buffer disponível tentará acionar outgoingHandler.

A estrutura de buffer interno inclui uma matriz de buffer de entrada e uma matriz de buffer de saída. A matriz de buffer de entrada inclui os buffers "vazios" podem ser preenchidos com novos dados de entrada. A matriz de saída inclui os buffers preenchidos a serem manipulados por outgoingHandler. Cada tamanho de buffer acima é definido pelo parâmetro bufferSize.

NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING

NUM_OF_ALL_BUFFERS menor ou igual a maxBuffers

DICAS DE MELHORIA DE DESEMPENHO:

  1. O fluxo de entrada highWaterMark é melhor definir um mesmo valor com o parâmetro bufferSize, o que evitará operações Buffer.concat().
  2. concurrency deve definir um valor menor do que maxBuffers, o que é útil para reduzir a possibilidade quando um manipulador de saída aguarda os dados de fluxo. Nessa situação, os manipuladores de saída são bloqueados. A fila de saída não deve estar vazia.
Credential

Credential é uma classe abstrata para assinatura de solicitações HTTP do Armazenamento do Azure. Essa classe hospedará uma fábrica credentialPolicyCreator que gera CredentialPolicy.

CredentialPolicy

Política de credenciais usada para assinar solicitações HTTP(S) antes do envio. Esta é uma classe abstrata.

Readable
StorageBrowserPolicy

StorageBrowserPolicy lidará com as diferenças entre Node.js e o tempo de execução do navegador, incluindo:

  1. Os navegadores armazenam em cache solicitações GET/HEAD adicionando cabeçalhos condicionais como 'IF_MODIFIED_SINCE'. StorageBrowserPolicy é uma política usada para adicionar uma consulta de carimbo de data/hora ao URL de solicitação GET/HEAD, evitando assim o cache do navegador.

  2. Remover cabeçalho de cookie para segurança

  3. Remova o cabeçalho de comprimento de conteúdo para evitar avisos de navegadores

Em Node.js, esta apólice é uma no-op de passagem.

StorageBrowserPolicyFactory

StorageBrowserPolicyFactory é uma classe de fábrica que ajuda a gerar objetos StorageBrowserPolicy.

StorageCRC64Calculator

Classe usada para calcular o checksum CRC64

StorageRetryPolicy

Política de repetição com repetição exponencial e repetição linear implementada.

StorageRetryPolicyFactory

StorageRetryPolicyFactory é uma classe de fábrica que ajuda a gerar StorageRetryPolicy objetos.

StorageSharedKeyCredential

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS.

StorageSharedKeyCredential para autorização de chave de conta do serviço de Armazenamento do Azure.

StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy é uma política usada para assinar solicitações HTTP com uma chave compartilhada.

UserDelegationKeyCredential

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS.

O UserDelegationKeyCredential é usado apenas para a geração de SAS de delegação de utilizadores.

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

Interfaces

NodeJSReadableStream

Um fluxo Node.js legível que também tem um destroy método.

StorageRetryOptions

Interface de opções de repetição de Blob de armazenamento.

StorageSharedKeyCredentialPolicyOptions

Opções usadas para configurar StorageSharedKeyCredentialPolicy.

StructuredMessageDecodingStreamOptions

Opções usadas ao criar o StructuredMessageDecodingStream

StructuredMessageEncodingStreamOptions

Opções usadas na criação do StructuredMessageEncodingStream

UserDelegationKey

Uma chave de delegação de utilizadores.

Aliases de Tipo

CredentialPolicyCreator

Uma função de fábrica que cria uma nova CredentialPolicy que usa a nextPolicy fornecida.

OutgoingHandler

OutgoingHandler é uma função assíncrona acionada por BufferScheduler.

Enumerações

StorageRetryPolicyType

Tipos RetryPolicy.

Funções

NewRetryPolicyFactory(StorageRetryOptions)

Um método de fábrica usado para gerar uma fábrica RetryPolicy.

allocBuffer(number)

Aloca um novo Buffer zero-preenchido do tamanho indicado.

bufferFromArrayBuffer(ArrayBuffer, number, number)

Cria um Buffer a partir de um ArrayBuffer, com offset e comprimento opcionais.

createBlobFromData(Blob | ArrayBuffer | ArrayBufferView)

Cria um Blob a partir dos dados dados. Utiliza uma referência indireta de construtor para contornar as definições restritivas de tipos de Blob do React Native (que só aceitam string | Blob, não ArrayBuffer).

getBufferLength(Buffer)

Devolve o comprimento do byte de um buffer.

getCachedDefaultHttpClient()
isBuffer(unknown)

Verifica se um valor é um Node.js Buffer.

storageBrowserPolicy()

storageBrowserPolicy é uma política usada para impedir que os navegadores armazenem solicitações em cache e para remover cookies e cabeçalhos de comprimento de conteúdo explícito.

Em Node.js, esta apólice é uma no-op de passagem.

storageCorrectContentLengthPolicy()

storageCorrectContentLengthPolicy para definir corretamente o cabeçalho Content-Length com o comprimento do corpo da solicitação.

storageRequestFailureDetailsParserPolicy()

StorageRequestFailureDetailsParserPolicy

storageRetryPolicy(StorageRetryOptions)

Política de repetição com repetição exponencial e repetição linear implementada.

storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)

storageSharedKeyCredentialPolicy lida com solicitações de assinatura usando chaves de conta de armazenamento.

structuredMessageDecodingBrowser(Blob | ReadableStream<Uint8Array>)

Decodificar o corpo estruturado para validação de conteúdo CRC64 em armazenamento para download.

structuredMessageDecodingStream(ReadableStream, StructuredMessageDecodingStreamOptions)

Decodificar o corpo estruturado para validação de conteúdo CRC64 em armazenamento para download.

structuredMessageEncoding(RequestBodyType, number)

Codificar o corpo estruturado para validação de conteúdo CRC64 em armazenamento e carregamento.

Variáveis

storageBrowserPolicyName

O identificador programático do StorageBrowserPolicy.

storageCorrectContentLengthPolicyName

O identificador programático da política storageCorrectContentLengthLength.

storageRequestFailureDetailsParserPolicyName

O identificador programático do StorageRequestFailureDetailsParserPolicy.

storageRetryPolicyName

Nome do storageRetryPolicy

storageSharedKeyCredentialPolicyName

O identificador programático do storageSharedKeyCredentialPolicy.

Detalhes de Função

NewRetryPolicyFactory(StorageRetryOptions)

Um método de fábrica usado para gerar uma fábrica RetryPolicy.

function NewRetryPolicyFactory(retryOptions?: StorageRetryOptions): RequestPolicyFactory

Parâmetros

retryOptions
StorageRetryOptions

Devoluções

allocBuffer(number)

Aloca um novo Buffer zero-preenchido do tamanho indicado.

function allocBuffer(size: number): NodeBuffer

Parâmetros

size

number

Devoluções

NodeBuffer

bufferFromArrayBuffer(ArrayBuffer, number, number)

Cria um Buffer a partir de um ArrayBuffer, com offset e comprimento opcionais.

function bufferFromArrayBuffer(ab: ArrayBuffer, byteOffset?: number, length?: number): NodeBuffer

Parâmetros

ab

ArrayBuffer

byteOffset

number

length

number

Devoluções

NodeBuffer

createBlobFromData(Blob | ArrayBuffer | ArrayBufferView)

Cria um Blob a partir dos dados dados. Utiliza uma referência indireta de construtor para contornar as definições restritivas de tipos de Blob do React Native (que só aceitam string | Blob, não ArrayBuffer).

function createBlobFromData(data: Blob | ArrayBuffer | ArrayBufferView): Blob

Parâmetros

data

Blob | ArrayBuffer | ArrayBufferView

Devoluções

Blob

getBufferLength(Buffer)

Devolve o comprimento do byte de um buffer.

function getBufferLength(buffer: Buffer): number

Parâmetros

buffer

Buffer

Devoluções

number

getCachedDefaultHttpClient()

function getCachedDefaultHttpClient(): HttpClient

Devoluções

isBuffer(unknown)

Verifica se um valor é um Node.js Buffer.

function isBuffer(value: unknown): value

Parâmetros

value

unknown

Devoluções

value

storageBrowserPolicy()

storageBrowserPolicy é uma política usada para impedir que os navegadores armazenem solicitações em cache e para remover cookies e cabeçalhos de comprimento de conteúdo explícito.

Em Node.js, esta apólice é uma no-op de passagem.

function storageBrowserPolicy(): PipelinePolicy

Devoluções

storageCorrectContentLengthPolicy()

storageCorrectContentLengthPolicy para definir corretamente o cabeçalho Content-Length com o comprimento do corpo da solicitação.

function storageCorrectContentLengthPolicy(): PipelinePolicy

Devoluções

storageRequestFailureDetailsParserPolicy()

StorageRequestFailureDetailsParserPolicy

function storageRequestFailureDetailsParserPolicy(): PipelinePolicy

Devoluções

storageRetryPolicy(StorageRetryOptions)

Política de repetição com repetição exponencial e repetição linear implementada.

function storageRetryPolicy(options?: StorageRetryOptions): PipelinePolicy

Parâmetros

Devoluções

storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)

storageSharedKeyCredentialPolicy lida com solicitações de assinatura usando chaves de conta de armazenamento.

function storageSharedKeyCredentialPolicy(options: StorageSharedKeyCredentialPolicyOptions): PipelinePolicy

Parâmetros

Devoluções

structuredMessageDecodingBrowser(Blob | ReadableStream<Uint8Array>)

Decodificar o corpo estruturado para validação de conteúdo CRC64 em armazenamento para download.

function structuredMessageDecodingBrowser(source: Blob | ReadableStream<Uint8Array>): Promise<Blob>

Parâmetros

source

Blob | ReadableStream<Uint8Array>

Devoluções

Promise<Blob>

structuredMessageDecodingStream(ReadableStream, StructuredMessageDecodingStreamOptions)

Decodificar o corpo estruturado para validação de conteúdo CRC64 em armazenamento para download.

function structuredMessageDecodingStream(source: ReadableStream, options: StructuredMessageDecodingStreamOptions): NodeJS.ReadableStream

Parâmetros

source

ReadableStream

Devoluções

NodeJS.ReadableStream

structuredMessageEncoding(RequestBodyType, number)

Codificar o corpo estruturado para validação de conteúdo CRC64 em armazenamento e carregamento.

function structuredMessageEncoding(source: RequestBodyType, contentLength: number): Promise<{ body: HttpRequestBody, encodedContentLength: number }>

Parâmetros

contentLength

number

Devoluções

Promise<{ body: HttpRequestBody, encodedContentLength: number }>

Detalhes das variáveis

storageBrowserPolicyName

O identificador programático do StorageBrowserPolicy.

storageBrowserPolicyName: "storageBrowserPolicy"

Tipo

"storageBrowserPolicy"

storageCorrectContentLengthPolicyName

O identificador programático da política storageCorrectContentLengthLength.

storageCorrectContentLengthPolicyName: "StorageCorrectContentLengthPolicy"

Tipo

"StorageCorrectContentLengthPolicy"

storageRequestFailureDetailsParserPolicyName

O identificador programático do StorageRequestFailureDetailsParserPolicy.

storageRequestFailureDetailsParserPolicyName: "storageRequestFailureDetailsParserPolicy"

Tipo

"storageRequestFailureDetailsParserPolicy"

storageRetryPolicyName

Nome do storageRetryPolicy

storageRetryPolicyName: "storageRetryPolicy"

Tipo

"storageRetryPolicy"

storageSharedKeyCredentialPolicyName

O identificador programático do storageSharedKeyCredentialPolicy.

storageSharedKeyCredentialPolicyName: "storageSharedKeyCredentialPolicy"

Tipo

"storageSharedKeyCredentialPolicy"