@azure/storage-common package

Klasser

AnonymousCredential

AnonymousCredential tillhandahåller en credentialPolicyCreator-medlem som används för att skapa AnonymousCredentialPolicy-objekt. AnonymousCredentialPolicy används med HTTP-begäranden som läser offentliga resurser eller för användning med signaturer för delad åtkomst (SAS).
AnonymousCredentialPolicy

AnonymousCredentialPolicy används med HTTP-begäranden som läser offentliga resurser eller för användning med signaturer för delad åtkomst (SAS).
BaseRequestPolicy

Basklassen som alla begärandeprinciper härleds från.
BufferScheduler

Den här klassen accepterar en Node.js läsbar ström som indata och fortsätter att läsa data från strömmen till den interna buffertstrukturen tills den når maxBuffers. Varje tillgänglig buffert försöker utlösa outgoingHandler.

Den interna buffertstrukturen innehåller en inkommande buffertmatris och en utgående buffertmatris. Den inkommande buffertmatrisen innehåller "tomma" buffertar som kan fyllas med nya inkommande data. Den utgående matrisen innehåller de fyllda buffertar som ska hanteras av outgoingHandler. Varje buffertstorlek ovan definieras av parameterbuffertStorlek.

NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING

NUM_OF_ALL_BUFFERS mindre än eller lika med maxBuffers

TIPS FÖR PRESTANDAFÖRBÄTTRING:

  1. HighWaterMark för indataström är bättre att ange samma värde med bufferSize-parametern, vilket undviker buffer.concat()-åtgärder.
  2. samtidighet bör ange ett mindre värde än maxBuffers, vilket är användbart för att minska risken när en utgående hanterare väntar på dataströmmar. I det här fallet blockeras utgående hanterare. Utgående kö ska inte vara tom.
Credential

Autentiseringsuppgifter är en abstrakt klass för signering av HTTP-begäranden i Azure Storage. Den här klassen är värd för en credentialPolicyCreator-fabrik som genererar CredentialPolicy.
CredentialPolicy

Princip för autentiseringsuppgifter som används för att signera HTTP-begäranden (S) innan de skickas. Det här är en abstrakt klass.
StorageBrowserPolicy

StorageBrowserPolicy hanterar skillnader mellan Node.js och webbläsarkörning, inklusive:

  1. Webbläsare cachelagrar GET/HEAD-begäranden genom att lägga till villkorsstyrda rubriker som "IF_MODIFIED_SINCE". StorageBrowserPolicy är en princip som används för att lägga till en tidsstämpelfråga i GET/HEAD-begärande-URL:en och därmed undvika webbläsarens cacheminne.

  2. Ta bort cookierubrik för säkerhet

  3. Ta bort innehållslängdsrubrik för att undvika webbläsarvarningar
StorageBrowserPolicyFactory

StorageBrowserPolicyFactory är en fabriksklass som hjälper till att generera StorageBrowserPolicy-objekt.
StorageCRC64Calculator

Klass som används för att räkna CRC64-kontrollsumman
StorageRetryPolicy

Återförsöksprincip med exponentiellt återförsök och linjärt återförsök implementerat.
StorageRetryPolicyFactory

StorageRetryPolicyFactory är en fabriksklass som hjälper till att generera StorageRetryPolicy objekt.
StorageSharedKeyCredential

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

StorageSharedKeyCredential för kontonyckelauktorisering av Azure Storage-tjänsten.
StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy är en princip som används för att signera HTTP-begäran med en delad nyckel.
UserDelegationKeyCredential

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

UserDelegationKeyCredential används endast för generering av användardelegerings-SAS.

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

Gränssnitt

NodeJSReadableStream

En Node.js läsbar ström som också har en destroy metod.
StorageRetryOptions

Alternativ för återförsök av lagringsblob.
StorageSharedKeyCredentialPolicyOptions

Alternativ som används för att konfigurera StorageSharedKeyCredentialPolicy.
StructuredMessageDecodingStreamOptions

Alternativ som används vid skapandet av StructuredMessageDecodingStream
StructuredMessageEncodingStreamOptions

Alternativ som används vid skapande av StructuredMessageEncodingStream
UserDelegationKey

En användardelegeringsnyckel.

Typalias

CredentialPolicyCreator

En fabriksfunktion som skapar en ny CredentialPolicy som använder den angivna nextPolicy.
OutgoingHandler

OutgoingHandler är en asynkron funktion som utlöses av BufferScheduler.

Uppräkningar

StorageRetryPolicyType

RetryPolicy-typer.

Funktioner

NewRetryPolicyFactory(StorageRetryOptions)

En fabriksmetod som används för att generera en RetryPolicy-fabrik.
getCachedDefaultHttpClient()
storageBrowserPolicy()

storageBrowserPolicy är en princip som används för att förhindra webbläsare från att cachelagra begäranden och för att ta bort cookies och explicita innehållslängdsrubriker.
storageCorrectContentLengthPolicy()

storageCorrectContentLengthPolicy för att korrekt ange Content-Length-huvudet med längden på begärandetexten.
storageRequestFailureDetailsParserPolicy()

StorageRequestFailureDetailsParserPolicy
storageRetryPolicy(StorageRetryOptions)

Återförsöksprincip med exponentiellt återförsök och linjärt återförsök implementerat.
storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)

storageSharedKeyCredentialPolicy hanterar signeringsbegäranden med hjälp av lagringskontonycklar.
structuredMessageDecodingBrowser(ReadableStream<Uint8Array> | Blob)

För att avkoda strukturerad kropp för CRC64-innehållsvalidering vid nedladdning av lagring.
structuredMessageDecodingStream(ReadableStream, StructuredMessageDecodingStreamOptions)

För att avkoda strukturerad kropp för CRC64-innehållsvalidering vid nedladdning av lagring.
structuredMessageEncoding(RequestBodyType, number)

Att koda strukturerad kropp för CRC64-innehållsvalidering vid lagringsuppladdning.

Variabler

storageBrowserPolicyName

Den programmatiska identifieraren för StorageBrowserPolicy.
storageCorrectContentLengthPolicyName

Den programmatiska identifieraren för storageCorrectContentLengthPolicy.
storageRequestFailureDetailsParserPolicyName

Den programmatiska identifieraren för StorageRequestFailureDetailsParserPolicy.
storageRetryPolicyName

Namnet på storageRetryPolicy
storageSharedKeyCredentialPolicyName

Den programmatiska identifieraren för storageSharedKeyCredentialPolicy.

Funktionsinformation

NewRetryPolicyFactory(StorageRetryOptions)

En fabriksmetod som används för att generera en RetryPolicy-fabrik.

function NewRetryPolicyFactory(retryOptions?: StorageRetryOptions): RequestPolicyFactory

Parametrar

retryOptions
StorageRetryOptions

Returer

RequestPolicyFactory

getCachedDefaultHttpClient() 

function getCachedDefaultHttpClient(): HttpClient

Returer

HttpClient

storageBrowserPolicy()

storageBrowserPolicy är en princip som används för att förhindra webbläsare från att cachelagra begäranden och för att ta bort cookies och explicita innehållslängdsrubriker.

function storageBrowserPolicy(): PipelinePolicy

Returer

PipelinePolicy

storageCorrectContentLengthPolicy()

storageCorrectContentLengthPolicy för att korrekt ange Content-Length-huvudet med längden på begärandetexten.

function storageCorrectContentLengthPolicy(): PipelinePolicy

Returer

PipelinePolicy

storageRequestFailureDetailsParserPolicy()

StorageRequestFailureDetailsParserPolicy

function storageRequestFailureDetailsParserPolicy(): PipelinePolicy

Returer

PipelinePolicy

storageRetryPolicy(StorageRetryOptions)

Återförsöksprincip med exponentiellt återförsök och linjärt återförsök implementerat.

function storageRetryPolicy(options?: StorageRetryOptions): PipelinePolicy

Parametrar

options
StorageRetryOptions

Returer

PipelinePolicy

storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)

storageSharedKeyCredentialPolicy hanterar signeringsbegäranden med hjälp av lagringskontonycklar.

function storageSharedKeyCredentialPolicy(options: StorageSharedKeyCredentialPolicyOptions): PipelinePolicy

Parametrar

options
StorageSharedKeyCredentialPolicyOptions

Returer

PipelinePolicy

structuredMessageDecodingBrowser(ReadableStream<Uint8Array> | Blob)

För att avkoda strukturerad kropp för CRC64-innehållsvalidering vid nedladdning av lagring.

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

Parametrar

source

ReadableStream<Uint8Array> | Blob

Returer

Promise<Blob>

structuredMessageDecodingStream(ReadableStream, StructuredMessageDecodingStreamOptions)

För att avkoda strukturerad kropp för CRC64-innehållsvalidering vid nedladdning av lagring.

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

Parametrar

source

ReadableStream

options
StructuredMessageDecodingStreamOptions

Returer

NodeJS.ReadableStream

structuredMessageEncoding(RequestBodyType, number)

Att koda strukturerad kropp för CRC64-innehållsvalidering vid lagringsuppladdning.

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

Parametrar

source
RequestBodyType
contentLength

number

Returer

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

Variabelinformation

storageBrowserPolicyName

Den programmatiska identifieraren för StorageBrowserPolicy.

storageBrowserPolicyName: "storageBrowserPolicy"

Typ

"storageBrowserPolicy"

storageCorrectContentLengthPolicyName

Den programmatiska identifieraren för storageCorrectContentLengthPolicy.

storageCorrectContentLengthPolicyName: "StorageCorrectContentLengthPolicy"

Typ

"StorageCorrectContentLengthPolicy"

storageRequestFailureDetailsParserPolicyName

Den programmatiska identifieraren för StorageRequestFailureDetailsParserPolicy.

storageRequestFailureDetailsParserPolicyName: "storageRequestFailureDetailsParserPolicy"

Typ

"storageRequestFailureDetailsParserPolicy"

storageRetryPolicyName

Namnet på storageRetryPolicy

storageRetryPolicyName: "storageRetryPolicy"

Typ

"storageRetryPolicy"

storageSharedKeyCredentialPolicyName

Den programmatiska identifieraren för storageSharedKeyCredentialPolicy.

storageSharedKeyCredentialPolicyName: "storageSharedKeyCredentialPolicy"

Typ

"storageSharedKeyCredentialPolicy"