@azure/storage-common package

Classi

AnonymousCredential

AnonymousCredential fornisce un membro credentialPolicyCreator usato per creare oggetti AnonymousCredentialPolicy. AnonymousCredentialPolicy viene usato con richieste HTTP(S) che leggono risorse pubbliche o da usare con firme di accesso condiviso.

AnonymousCredentialPolicy

AnonymousCredentialPolicy viene usato con richieste HTTP(S) che leggono risorse pubbliche o da usare con firme di accesso condiviso.

BaseRequestPolicy

Classe di base da cui derivano tutti i criteri di richiesta.

BufferScheduler

Questa classe accetta un flusso leggibile Node.js come input e continua a leggere i dati dal flusso nella struttura del buffer interno fino a raggiungere maxBuffers. Ogni buffer disponibile tenterà di attivare il gestore in uscita.

La struttura del buffer interno include una matrice di buffer in ingresso e una matrice di buffer in uscita. La matrice di buffer in ingresso include i buffer "vuoti" che possono essere riempiti con nuovi dati in ingresso. La matrice in uscita include i buffer riempiti da gestire da outgoingHandler. Ogni dimensione del buffer precedente è definita dal parametro bufferSize.

NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING

NUM_OF_ALL_BUFFERS minore o uguale a maxBuffers

SUGGERIMENTI PER IL MIGLIORAMENTO DELLE PRESTAZIONI:

  1. L'highWaterMark del flusso di input è preferibile impostare lo stesso valore con il parametro bufferSize, che eviterà le operazioni Buffer.concat().
  2. La concorrenza deve impostare un valore inferiore rispetto a maxBuffers, il che è utile per ridurre la possibilità che un gestore in uscita attenda i dati del flusso. in questa situazione, i gestori in uscita vengono bloccati. La coda in uscita non deve essere vuota.
Credential

Credential è una classe astratta per la firma delle richieste HTTP di Archiviazione di Azure. Questa classe ospiterà una factory credentialPolicyCreator che genera CredentialPolicy.

CredentialPolicy

Criteri di credenziali usati per firmare le richieste HTTP(S) prima dell'invio. Si tratta di una classe astratta.

Readable
StorageBrowserPolicy

StorageBrowserPolicy gestirà le differenze tra Node.js e il runtime del browser, tra cui:

  1. I browser memorizzano nella cache le richieste GET/HEAD aggiungendo intestazioni condizionali come "IF_MODIFIED_SINCE". StorageBrowserPolicy è un criterio usato per aggiungere una query timestamp all'URL della richiesta GET/HEAD, evitando così la cache del browser.

  2. Rimuovere l'intestazione del cookie per la sicurezza

  3. Rimuovere l'intestazione content-length per evitare gli avvisi dei browser

In Node.js, questa polizza è un passaggio no-op.

StorageBrowserPolicyFactory

StorageBrowserPolicyFactory è una classe factory che consente di generare oggetti StorageBrowserPolicy.

StorageCRC64Calculator

Classe usata per calcolare il checksum CRC64

StorageRetryPolicy

Criteri di ripetizione dei tentativi con ripetizione esponenziale e ripetizione lineare implementati.

StorageRetryPolicyFactory

StorageRetryPolicyFactory è una classe factory che consente di generare oggetti StorageRetryPolicy.

StorageSharedKeyCredential

DISPONIBILE SOLO IN NODE.JS RUNTIME.

StorageSharedKeyCredential per l'autorizzazione della chiave dell'account del servizio archiviazione di Azure.

StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy è un criterio usato per firmare una richiesta HTTP con una chiave condivisa.

UserDelegationKeyCredential

DISPONIBILE SOLO IN NODE.JS RUNTIME.

UserDelegationKeyCredential è utilizzato solo per la generazione di SAS della delega utente.

Fare riferimento a https://learn.microsoft.com/rest/api/storageservices/create-user-delegation-sas

Interfacce

NodeJSReadableStream

Flusso leggibile Node.js che dispone anche di un destroy metodo.

StorageRetryOptions

Interfaccia delle opzioni di ripetizione dei tentativi dei BLOB di archiviazione.

StorageSharedKeyCredentialPolicyOptions

Opzioni usate per configurare StorageSharedKeyCredentialPolicy.

StructuredMessageDecodingStreamOptions

Opzioni utilizzate nella creazione di StructuredMessageDecodingStream

StructuredMessageEncodingStreamOptions

Opzioni utilizzate nella creazione di StructuredMessageEncodingStream

UserDelegationKey

Una chiave di delega utente.

Alias tipo

CredentialPolicyCreator

Funzione factory che crea un nuovo oggetto CredentialPolicy che usa nextPolicy fornito.

OutgoingHandler

OutgoingHandler è una funzione asincrona attivata da BufferScheduler.

Enumerazioni

StorageRetryPolicyType

Tipi RetryPolicy.

Funzioni

NewRetryPolicyFactory(StorageRetryOptions)

Metodo factory usato per generare una factory RetryPolicy.

allocBuffer(number)

Assegna un nuovo Buffer a zero riempito della dimensione data.

bufferFromArrayBuffer(ArrayBuffer, number, number)

Crea un buffer da un ArrayBuffer, con offset e lunghezza opzionali.

createBlobFromData(Blob | ArrayBuffer | ArrayBufferView)

Crea un Blob dai dati forniti. Utilizza un riferimento indiretto al costruttore per aggirare le definizioni restrittive di tipo Blob di React Native (che accettano solo stringhe | Blob, non ArrayBuffer).

getBufferLength(Buffer)

Restituisce la lunghezza del byte di un buffer.

getCachedDefaultHttpClient()
isBuffer(unknown)

Controlla se un valore è un buffer Node.js.

storageBrowserPolicy()

storageBrowserPolicy è un criterio utilizzato per impedire ai browser di memorizzare nella cache le richieste e per rimuovere i cookie e le intestazioni esplicite di lunghezza del contenuto.

In Node.js, questa polizza è un passaggio no-op.

storageCorrectContentLengthPolicy()

storageCorrectContentLengthPolicy per impostare correttamente l'intestazione Content-Length con la lunghezza del corpo della richiesta.

storageRequestFailureDetailsParserPolicy()

StorageRequestFailureDetailsParserPolicy

storageRetryPolicy(StorageRetryOptions)

Criteri di ripetizione dei tentativi con ripetizione esponenziale e ripetizione lineare implementati.

storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)

storageSharedKeyCredentialPolicy gestisce le richieste di firma usando le chiavi dell'account di archiviazione.

structuredMessageDecodingBrowser(Blob | ReadableStream<Uint8Array>)

Decodificare il corpo strutturato per la validazione del contenuto CRC64 in archiviazione.

structuredMessageDecodingStream(ReadableStream, StructuredMessageDecodingStreamOptions)

Decodificare il corpo strutturato per la validazione del contenuto CRC64 in archiviazione.

structuredMessageEncoding(RequestBodyType, number)

Codificare un corpo strutturato per la validazione dei contenuti CRC64 in archiviazione.

Variabili

storageBrowserPolicyName

L'identificatore programmatico del StorageBrowserPolicy.

storageCorrectContentLengthPolicyName

L'identificatore programmatico della politicaStorageCorrectContentLengthPolicy.

storageRequestFailureDetailsParserPolicyName

L'identificatore programmatico della StorageRequestFailureDetailsParserPolicy.

storageRetryPolicyName

Nome della storageRetryPolicy

storageSharedKeyCredentialPolicyName

L'identificatore programmatico dello storageSharedKeySharedKeyCredentialPolicy.

Dettagli funzione

NewRetryPolicyFactory(StorageRetryOptions)

Metodo factory usato per generare una factory RetryPolicy.

function NewRetryPolicyFactory(retryOptions?: StorageRetryOptions): RequestPolicyFactory

Parametri

retryOptions
StorageRetryOptions

Valori restituiti

allocBuffer(number)

Assegna un nuovo Buffer a zero riempito della dimensione data.

function allocBuffer(size: number): NodeBuffer

Parametri

size

number

Valori restituiti

NodeBuffer

bufferFromArrayBuffer(ArrayBuffer, number, number)

Crea un buffer da un ArrayBuffer, con offset e lunghezza opzionali.

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

Parametri

ab

ArrayBuffer

byteOffset

number

length

number

Valori restituiti

NodeBuffer

createBlobFromData(Blob | ArrayBuffer | ArrayBufferView)

Crea un Blob dai dati forniti. Utilizza un riferimento indiretto al costruttore per aggirare le definizioni restrittive di tipo Blob di React Native (che accettano solo stringhe | Blob, non ArrayBuffer).

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

Parametri

data

Blob | ArrayBuffer | ArrayBufferView

Valori restituiti

Blob

getBufferLength(Buffer)

Restituisce la lunghezza del byte di un buffer.

function getBufferLength(buffer: Buffer): number

Parametri

buffer

Buffer

Valori restituiti

number

getCachedDefaultHttpClient()

function getCachedDefaultHttpClient(): HttpClient

Valori restituiti

isBuffer(unknown)

Controlla se un valore è un buffer Node.js.

function isBuffer(value: unknown): value

Parametri

value

unknown

Valori restituiti

value

storageBrowserPolicy()

storageBrowserPolicy è un criterio utilizzato per impedire ai browser di memorizzare nella cache le richieste e per rimuovere i cookie e le intestazioni esplicite di lunghezza del contenuto.

In Node.js, questa polizza è un passaggio no-op.

function storageBrowserPolicy(): PipelinePolicy

Valori restituiti

storageCorrectContentLengthPolicy()

storageCorrectContentLengthPolicy per impostare correttamente l'intestazione Content-Length con la lunghezza del corpo della richiesta.

function storageCorrectContentLengthPolicy(): PipelinePolicy

Valori restituiti

storageRequestFailureDetailsParserPolicy()

StorageRequestFailureDetailsParserPolicy

function storageRequestFailureDetailsParserPolicy(): PipelinePolicy

Valori restituiti

storageRetryPolicy(StorageRetryOptions)

Criteri di ripetizione dei tentativi con ripetizione esponenziale e ripetizione lineare implementati.

function storageRetryPolicy(options?: StorageRetryOptions): PipelinePolicy

Parametri

Valori restituiti

storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)

storageSharedKeyCredentialPolicy gestisce le richieste di firma usando le chiavi dell'account di archiviazione.

function storageSharedKeyCredentialPolicy(options: StorageSharedKeyCredentialPolicyOptions): PipelinePolicy

Parametri

Valori restituiti

structuredMessageDecodingBrowser(Blob | ReadableStream<Uint8Array>)

Decodificare il corpo strutturato per la validazione del contenuto CRC64 in archiviazione.

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

Parametri

source

Blob | ReadableStream<Uint8Array>

Valori restituiti

Promise<Blob>

structuredMessageDecodingStream(ReadableStream, StructuredMessageDecodingStreamOptions)

Decodificare il corpo strutturato per la validazione del contenuto CRC64 in archiviazione.

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

Parametri

source

ReadableStream

Valori restituiti

NodeJS.ReadableStream

structuredMessageEncoding(RequestBodyType, number)

Codificare un corpo strutturato per la validazione dei contenuti CRC64 in archiviazione.

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

Parametri

contentLength

number

Valori restituiti

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

Dettagli delle variabili

storageBrowserPolicyName

L'identificatore programmatico del StorageBrowserPolicy.

storageBrowserPolicyName: "storageBrowserPolicy"

Tipo

"storageBrowserPolicy"

storageCorrectContentLengthPolicyName

L'identificatore programmatico della politicaStorageCorrectContentLengthPolicy.

storageCorrectContentLengthPolicyName: "StorageCorrectContentLengthPolicy"

Tipo

"StorageCorrectContentLengthPolicy"

storageRequestFailureDetailsParserPolicyName

L'identificatore programmatico della StorageRequestFailureDetailsParserPolicy.

storageRequestFailureDetailsParserPolicyName: "storageRequestFailureDetailsParserPolicy"

Tipo

"storageRequestFailureDetailsParserPolicy"

storageRetryPolicyName

Nome della storageRetryPolicy

storageRetryPolicyName: "storageRetryPolicy"

Tipo

"storageRetryPolicy"

storageSharedKeyCredentialPolicyName

L'identificatore programmatico dello storageSharedKeySharedKeyCredentialPolicy.

storageSharedKeyCredentialPolicyName: "storageSharedKeyCredentialPolicy"

Tipo

"storageSharedKeyCredentialPolicy"