@azure/storage-common package

Osztályok

AnonymousCredential

Az AnonymousCredential egy hitelesítőadatPolicyCreator-tagot biztosít, amellyel AnonymousCredentialPolicy objektumokat hozhat létre. Az AnonymousCredentialPolicy olyan HTTP-kérésekkel használható, amelyek nyilvános erőforrásokat olvasnak, vagy közös hozzáférésű jogosultságkódokkal (SAS) használják.
AnonymousCredentialPolicy

Az AnonymousCredentialPolicy olyan HTTP-kérésekkel használható, amelyek nyilvános erőforrásokat olvasnak, vagy közös hozzáférésű jogosultságkódokkal (SAS) használják.
BaseRequestPolicy

Az az alaposztály, amelyből az összes kérelemszabályzat származik.
BufferScheduler

Ez az osztály bemenetként elfogad egy Node.js olvasható adatfolyamot, és a streamből származó adatokat a belső pufferstruktúrába olvassa, amíg el nem éri a maxBuffers értéket. Minden elérhető puffer megpróbálja aktiválni a outgoingHandlert.

A belső pufferstruktúra tartalmaz egy bejövő puffertömböt és egy kimenő puffertömböt. A bejövő puffertömb tartalmazza az "üres" puffereket, amelyek új bejövő adatokkal tölthetők fel. A kimenő tömb tartalmazza azokat a kitöltött puffereket, amelyeket a outgoingHandler kezel. Minden fenti pufferméretet a bufferSize paraméter határoz meg.

NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING

NUM_OF_ALL_BUFFERS kisebb vagy egyenlő maxBuffers

TELJESÍTMÉNYJAVÍTÁSI TIPPEK:

  1. A bemeneti stream highWaterMark tulajdonsága jobb, ha ugyanazt az értéket a bufferSize paraméterrel állítja be, így elkerülhetők a Puffer.concat() műveletek.
  2. Az egyidejűségnek kisebb értéket kell beállítania, mint a maxBuffers, ami segít csökkenteni annak lehetőségét, hogy egy kimenő kezelő várjon a streamadatokra. ebben az esetben a kimenő kezelők le vannak tiltva. A kimenő üzenetsor nem lehet üres.
Credential

A hitelesítő adatok az Azure Storage HTTP-kérések aláírásának absztrakt osztályai. Ez az osztály egy credentialPolicyCreator gyárat fog üzemeltetni, amely credentialPolicy-t hoz létre.
CredentialPolicy

A HTTP(S) kérések elküldése előtt történő aláírásához használt hitelesítőadat-szabályzat. Ez egy absztrakt osztály.
Readable
StorageBrowserPolicy

A StorageBrowserPolicy kezeli a Node.js és a böngésző futtatókörnyezete közötti különbségeket, beleértve a következőket:

  1. A böngészők a GET/HEAD kéréseket feltételes fejlécek, például a "IF_MODIFIED_SINCE" hozzáadásával gyorsítótárazják. A StorageBrowserPolicy egy szabályzat, amellyel időbélyeg-lekérdezést adhat hozzá a GET/HEAD kérelem URL-címéhez, így elkerülheti a böngésző gyorsítótárát.

  2. Cookie-fejléc eltávolítása a biztonság érdekében

  3. Tartalomhosszúságú fejléc eltávolítása a böngészők figyelmeztetésének elkerülése érdekében

Node.js-ben ez a politika no-op átjárás.
StorageBrowserPolicyFactory

A StorageBrowserPolicyFactory egy olyan gyári osztály, amely segít a StorageBrowserPolicy objektumok létrehozásában.
StorageCRC64Calculator

Az osztály, amelyet CRC64 ellenőrző összeg számológépére használnak
StorageRetryPolicy

Újrapróbálkozási szabályzat exponenciális újrapróbálkozással és lineáris újrapróbálkozással.
StorageRetryPolicyFactory

A StorageRetryPolicyFactory egy olyan gyári osztály, amely segít StorageRetryPolicy objektumok létrehozásában.
StorageSharedKeyCredential

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

StorageSharedKeyCredential az Azure Storage szolgáltatás fiókkulcs-engedélyezéséhez.
StorageSharedKeyCredentialPolicy

A StorageSharedKeyCredentialPolicy egy olyan szabályzat, amellyel HTTP-kéréseket írhat alá megosztott kulccsal.
UserDelegationKeyCredential

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

A UserDelegationKeyCredential kizárólag felhasználói delegációs SAS generálására szolgál.

Lásd: https://learn.microsoft.com/rest/api/storageservices/create-user-delegation-sas

Interfészek

NodeJSReadableStream

Egy Node.js olvasható stream, amely szintén rendelkezik metódussal destroy .
StorageRetryOptions

A Storage Blob újrapróbálkozési beállításainak felülete.
StorageSharedKeyCredentialPolicyOptions

A StorageSharedKeyCredentialPolicy konfigurálásához használt beállítások.
StructuredMessageDecodingStreamOptions

A StructuredMessageDecodingStream létrehozásához használt opciók
StructuredMessageEncodingStreamOptions

A StructuredMessageEncodingStream létrehozásához használt opciók
UserDelegationKey

Egy felhasználói delegációs kulcs.

Típusaliasok

CredentialPolicyCreator

Egy gyári függvény, amely létrehoz egy új CredentialPolicy-t, amely a megadott nextPolicy-t használja.
OutgoingHandler

A OutgoingHandler a BufferScheduler által aktivált aszinkron függvény.

Enumerációk

StorageRetryPolicyType

RetryPolicy típusok.

Függvények

NewRetryPolicyFactory(StorageRetryOptions)

A RetryPolicy-gyár létrehozásához használt gyári metódus.
allocBuffer(number)

Új nulla kitöltött puffert oszt ki adott méretben.
bufferFromArrayBuffer(ArrayBuffer, number, number)

Létrehoz egy puffert egy ArrayBufferből, opcionális eltolással és hosszal.
createBlobFromData(Blob | ArrayBuffer | ArrayBufferView)

A megadott adatokból Blobot hoz létre. Közvetett konstruktor hivatkozást használ, hogy kikerülje a React Native korlátozó Blob típusú definícióit (amelyek csak a string | Blob, nem ArrayBuffer).
getBufferLength(Buffer)

Visszaadja egy puffer bájthosszát.
getCachedDefaultHttpClient()
isBuffer(unknown)

Ellenőrzi, hogy egy érték Node.js puffer-e.
storageBrowserPolicy()

storageBrowserPolicy egy olyan szabályzat, amely megakadályozza, hogy a böngészők gyorsítótárazzák a kéréseket, és eltávolítsák a cookie-kat és az explicit tartalomhosszúságú fejléceket.

Node.js-ben ez a politika no-op átjárás.
storageCorrectContentLengthPolicy()

storageCorrectContentLengthPolicy a Content-Length fejléc helyes beállításához a kérelem törzsének hosszával.
storageRequestFailureDetailsParserPolicy()

StorageRequestFailureDetailsParserPolicy
storageRetryPolicy(StorageRetryOptions)

Újrapróbálkozási szabályzat exponenciális újrapróbálkozással és lineáris újrapróbálkozással.
storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)

storageSharedKeyCredentialPolicy tárfiókkulcsokkal kezeli az aláírási kérelmeket.
structuredMessageDecodingBrowser(Blob | ReadableStream<Uint8Array>)

Strukturált test dekódolására CRC64 tartalomvalidációhoz a tároló letöltés során.
structuredMessageDecodingStream(ReadableStream, StructuredMessageDecodingStreamOptions)

Strukturált test dekódolására CRC64 tartalomvalidációhoz a tároló letöltés során.
structuredMessageEncoding(RequestBodyType, number)

Strukturált test kódolásához CRC64 tartalom validálásához tároló feltöltésben.

Változók

storageBrowserPolicyName

A StorageBrowserPolicy programozott azonosítója.
storageCorrectContentLengthPolicyName

A storageCorrectContentLengthPolicy programozott azonosítója.
storageRequestFailureDetailsParserPolicyName

A StorageRequestFailureDetailsParserPolicy programozott azonosítója.
storageRetryPolicyName

A tároló neveRetryPolicy
storageSharedKeyCredentialPolicyName

A storageSharedKeyCredentialPolicy programozott azonosítója.

Függvény adatai

NewRetryPolicyFactory(StorageRetryOptions)

A RetryPolicy-gyár létrehozásához használt gyári metódus.

function NewRetryPolicyFactory(retryOptions?: StorageRetryOptions): RequestPolicyFactory

Paraméterek

retryOptions
StorageRetryOptions

Válaszok

RequestPolicyFactory

allocBuffer(number)

Új nulla kitöltött puffert oszt ki adott méretben.

function allocBuffer(size: number): NodeBuffer

Paraméterek

size

number

Válaszok

NodeBuffer

bufferFromArrayBuffer(ArrayBuffer, number, number)

Létrehoz egy puffert egy ArrayBufferből, opcionális eltolással és hosszal.

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

Paraméterek

ab

ArrayBuffer

byteOffset

number

length

number

Válaszok

NodeBuffer

createBlobFromData(Blob | ArrayBuffer | ArrayBufferView)

A megadott adatokból Blobot hoz létre. Közvetett konstruktor hivatkozást használ, hogy kikerülje a React Native korlátozó Blob típusú definícióit (amelyek csak a string | Blob, nem ArrayBuffer).

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

Paraméterek

data

Blob | ArrayBuffer | ArrayBufferView

Válaszok

Blob

getBufferLength(Buffer)

Visszaadja egy puffer bájthosszát.

function getBufferLength(buffer: Buffer): number

Paraméterek

buffer

Buffer

Válaszok

number

getCachedDefaultHttpClient() 

function getCachedDefaultHttpClient(): HttpClient

Válaszok

HttpClient

isBuffer(unknown)

Ellenőrzi, hogy egy érték Node.js puffer-e.

function isBuffer(value: unknown): value

Paraméterek

value

unknown

Válaszok

value

storageBrowserPolicy()

storageBrowserPolicy egy olyan szabályzat, amely megakadályozza, hogy a böngészők gyorsítótárazzák a kéréseket, és eltávolítsák a cookie-kat és az explicit tartalomhosszúságú fejléceket.

Node.js-ben ez a politika no-op átjárás.

function storageBrowserPolicy(): PipelinePolicy

Válaszok

PipelinePolicy

storageCorrectContentLengthPolicy()

storageCorrectContentLengthPolicy a Content-Length fejléc helyes beállításához a kérelem törzsének hosszával.

function storageCorrectContentLengthPolicy(): PipelinePolicy

Válaszok

PipelinePolicy

storageRequestFailureDetailsParserPolicy()

StorageRequestFailureDetailsParserPolicy

function storageRequestFailureDetailsParserPolicy(): PipelinePolicy

Válaszok

PipelinePolicy

storageRetryPolicy(StorageRetryOptions)

Újrapróbálkozási szabályzat exponenciális újrapróbálkozással és lineáris újrapróbálkozással.

function storageRetryPolicy(options?: StorageRetryOptions): PipelinePolicy

Paraméterek

options
StorageRetryOptions

Válaszok

PipelinePolicy

storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)

storageSharedKeyCredentialPolicy tárfiókkulcsokkal kezeli az aláírási kérelmeket.

function storageSharedKeyCredentialPolicy(options: StorageSharedKeyCredentialPolicyOptions): PipelinePolicy

Paraméterek

options
StorageSharedKeyCredentialPolicyOptions

Válaszok

PipelinePolicy

structuredMessageDecodingBrowser(Blob | ReadableStream<Uint8Array>)

Strukturált test dekódolására CRC64 tartalomvalidációhoz a tároló letöltés során.

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

Paraméterek

source

Blob | ReadableStream<Uint8Array>

Válaszok

Promise<Blob>

structuredMessageDecodingStream(ReadableStream, StructuredMessageDecodingStreamOptions)

Strukturált test dekódolására CRC64 tartalomvalidációhoz a tároló letöltés során.

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

Paraméterek

source

ReadableStream

options
StructuredMessageDecodingStreamOptions

Válaszok

NodeJS.ReadableStream

structuredMessageEncoding(RequestBodyType, number)

Strukturált test kódolásához CRC64 tartalom validálásához tároló feltöltésben.

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

Paraméterek

source
RequestBodyType
contentLength

number

Válaszok

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

Változó részletei

storageBrowserPolicyName

A StorageBrowserPolicy programozott azonosítója.

storageBrowserPolicyName: "storageBrowserPolicy"

Típus

"storageBrowserPolicy"

storageCorrectContentLengthPolicyName

A storageCorrectContentLengthPolicy programozott azonosítója.

storageCorrectContentLengthPolicyName: "StorageCorrectContentLengthPolicy"

Típus

"StorageCorrectContentLengthPolicy"

storageRequestFailureDetailsParserPolicyName

A StorageRequestFailureDetailsParserPolicy programozott azonosítója.

storageRequestFailureDetailsParserPolicyName: "storageRequestFailureDetailsParserPolicy"

Típus

"storageRequestFailureDetailsParserPolicy"

storageRetryPolicyName

A tároló neveRetryPolicy

storageRetryPolicyName: "storageRetryPolicy"

Típus

"storageRetryPolicy"

storageSharedKeyCredentialPolicyName

A storageSharedKeyCredentialPolicy programozott azonosítója.

storageSharedKeyCredentialPolicyName: "storageSharedKeyCredentialPolicy"

Típus

"storageSharedKeyCredentialPolicy"