@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 SAS (Assinaturas de Acesso Compartilhado).

AnonymousCredentialPolicy

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

BaseRequestPolicy

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

BufferScheduler

Essa classe aceita uma Node.js fluxo legível como entrada e continua lendo dados do fluxo para a estrutura interna do buffer até atingir maxBuffers. Cada buffer disponível tentará disparar 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 pelo outgoingHandler. Cada tamanho de buffer acima é definido por bufferSize de parâmetro.

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. a simultaneidade deve definir um valor menor do que maxBuffers, o que é útil para reduzir a possibilidade quando um manipulador de saída aguarda os dados do fluxo. nessa situação, os manipuladores de saída são bloqueados. A fila de saída não deve estar vazia.
Credential

A credencial é 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 credencial usada para assinar solicitações HTTP(S) antes de enviar. Esta é uma classe abstrata.

Readable
StorageBrowserPolicy

StorageBrowserPolicy lidará com diferenças entre Node.js e o runtime 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 à URL de solicitação GET/HEAD, evitando assim o cache do navegador.

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

  3. Remover o cabeçalho de comprimento do conteúdo para evitar o aviso de navegadores

Em Node.js, essa 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 a soma de verificação do 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 objetos StorageRetryPolicy.

StorageSharedKeyCredential

DISPONÍVEL APENAS EM NODE.JS RUNTIME.

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

StorageSharedKeyCredentialPolicy

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

UserDelegationKeyCredential

DISPONÍVEL APENAS EM NODE.JS RUNTIME.

UserDelegationKeyCredential é usado apenas para geração de SAS de delegação de usuários.

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

Interfaces

NodeJSReadableStream

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

StorageRetryOptions

Interface de opções de repetição do Blob de Armazenamento.

StorageSharedKeyCredentialPolicyOptions

Opções usadas para configurar StorageSharedKeyCredentialPolicy.

StructuredMessageDecodingStreamOptions

Opções usadas ao criar o StructuredMessageDecodingStream

StructuredMessageEncodingStreamOptions

Opções usadas ao criar o StructuredMessageEncodingStream

UserDelegationKey

Uma chave de delegação de usuário.

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 disparada 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 dado.

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 fornecidos. Usa uma referência indireta de construtor para contornar as definições restritivas de tipos de Blob do React Native (que aceitam apenas string | Blob, não ArrayBuffer).

getBufferLength(Buffer)

Retorna o comprimento de bytes 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 explícitos de comprimento de conteúdo.

Em Node.js, essa 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 e download.

structuredMessageDecodingStream(ReadableStream, StructuredMessageDecodingStreamOptions)

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

structuredMessageEncoding(RequestBodyType, number)

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

Variáveis

storageBrowserPolicyName

O identificador programático do StorageBrowserPolicy.

storageCorrectContentLengthPolicyName

O identificador programático da política storageCorrectContentLengthPolicy.

storageRequestFailureDetailsParserPolicyName

O identificador programático da Política StorageRequestFailureParserDetails.

storageRetryPolicyName

Nome do storageRetryPolicy

storageSharedKeyCredentialPolicyName

O identificador programático do storageSharedKeySharedKeyCredentialPolicy.

Detalhes da 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

Retornos

allocBuffer(number)

Aloca um novo Buffer zero-preenchido do tamanho dado.

function allocBuffer(size: number): NodeBuffer

Parâmetros

size

number

Retornos

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

Retornos

NodeBuffer

createBlobFromData(Blob | ArrayBuffer | ArrayBufferView)

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

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

Parâmetros

data

Blob | ArrayBuffer | ArrayBufferView

Retornos

Blob

getBufferLength(Buffer)

Retorna o comprimento de bytes de um buffer.

function getBufferLength(buffer: Buffer): number

Parâmetros

buffer

Buffer

Retornos

number

getCachedDefaultHttpClient()

function getCachedDefaultHttpClient(): HttpClient

Retornos

isBuffer(unknown)

Verifica se um valor é um Node.js Buffer.

function isBuffer(value: unknown): value

Parâmetros

value

unknown

Retornos

value

storageBrowserPolicy()

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

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

function storageBrowserPolicy(): PipelinePolicy

Retornos

storageCorrectContentLengthPolicy()

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

function storageCorrectContentLengthPolicy(): PipelinePolicy

Retornos

storageRequestFailureDetailsParserPolicy()

StorageRequestFailureDetailsParserPolicy

function storageRequestFailureDetailsParserPolicy(): PipelinePolicy

Retornos

storageRetryPolicy(StorageRetryOptions)

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

function storageRetryPolicy(options?: StorageRetryOptions): PipelinePolicy

Parâmetros

Retornos

storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)

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

function storageSharedKeyCredentialPolicy(options: StorageSharedKeyCredentialPolicyOptions): PipelinePolicy

Parâmetros

Retornos

structuredMessageDecodingBrowser(Blob | ReadableStream<Uint8Array>)

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

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

Parâmetros

source

Blob | ReadableStream<Uint8Array>

Retornos

Promise<Blob>

structuredMessageDecodingStream(ReadableStream, StructuredMessageDecodingStreamOptions)

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

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

Parâmetros

source

ReadableStream

Retornos

NodeJS.ReadableStream

structuredMessageEncoding(RequestBodyType, number)

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

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

Parâmetros

contentLength

number

Retornos

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

Detalhes da variável

storageBrowserPolicyName

O identificador programático do StorageBrowserPolicy.

storageBrowserPolicyName: "storageBrowserPolicy"

Tipo

"storageBrowserPolicy"

storageCorrectContentLengthPolicyName

O identificador programático da política storageCorrectContentLengthPolicy.

storageCorrectContentLengthPolicyName: "StorageCorrectContentLengthPolicy"

Tipo

"StorageCorrectContentLengthPolicy"

storageRequestFailureDetailsParserPolicyName

O identificador programático da Política StorageRequestFailureParserDetails.

storageRequestFailureDetailsParserPolicyName: "storageRequestFailureDetailsParserPolicy"

Tipo

"storageRequestFailureDetailsParserPolicy"

storageRetryPolicyName

Nome do storageRetryPolicy

storageRetryPolicyName: "storageRetryPolicy"

Tipo

"storageRetryPolicy"

storageSharedKeyCredentialPolicyName

O identificador programático do storageSharedKeySharedKeyCredentialPolicy.

storageSharedKeyCredentialPolicyName: "storageSharedKeyCredentialPolicy"

Tipo

"storageSharedKeyCredentialPolicy"